rulesets

package
v6.10.0 Latest Latest
Warning

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

 Go to latest Published: Apr 23, 2026 License: Apache-2.0 Imports: 17 Imported by: 1

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 CertificateCASSLCom = shared.CertificateCASSLCom

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 CloudflareTunnelConfigSrcCloudflare = shared.CloudflareTunnelConfigSrcCloudflare

This is an alias to an internal value.

View Source 
const CloudflareTunnelConfigSrcLocal = shared.CloudflareTunnelConfigSrcLocal

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 CloudflareTunnelTunTypeMagic = shared.CloudflareTunnelTunTypeMagic

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeWARP = shared.CloudflareTunnelTunTypeWARP

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 MemberPoliciesAccessAllow = shared.MemberPoliciesAccessAllow

This is an alias to an internal value.

View Source 
const MemberPoliciesAccessDeny = shared.MemberPoliciesAccessDeny

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 RatePlanIDBusiness = shared.RatePlanIDBusiness

This is an alias to an internal value.

View Source 
const RatePlanIDEnterprise = shared.RatePlanIDEnterprise

This is an alias to an internal value.

View Source 
const RatePlanIDFree = shared.RatePlanIDFree

This is an alias to an internal value.

View Source 
const RatePlanIDLite = shared.RatePlanIDLite

This is an alias to an internal value.

View Source 
const RatePlanIDPartnersBusiness = shared.RatePlanIDPartnersBusiness

This is an alias to an internal value.

View Source 
const RatePlanIDPartnersEnterprise = shared.RatePlanIDPartnersEnterprise

This is an alias to an internal value.

View Source 
const RatePlanIDPartnersFree = shared.RatePlanIDPartnersFree

This is an alias to an internal value.

View Source 
const RatePlanIDPartnersPro = shared.RatePlanIDPartnersPro

This is an alias to an internal value.

View Source 
const RatePlanIDPro = shared.RatePlanIDPro

This is an alias to an internal value.

View Source 
const RatePlanIDProPlus = shared.RatePlanIDProPlus

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.

View Source 
const SubscriptionFrequencyMonthly = shared.SubscriptionFrequencyMonthly

This is an alias to an internal value.

View Source 
const SubscriptionFrequencyQuarterly = shared.SubscriptionFrequencyQuarterly

This is an alias to an internal value.

View Source 
const SubscriptionFrequencyWeekly = shared.SubscriptionFrequencyWeekly

This is an alias to an internal value.

View Source 
const SubscriptionFrequencyYearly = shared.SubscriptionFrequencyYearly

This is an alias to an internal value.

View Source 
const SubscriptionStateAwaitingPayment = shared.SubscriptionStateAwaitingPayment

This is an alias to an internal value.

View Source 
const SubscriptionStateCancelled = shared.SubscriptionStateCancelled

This is an alias to an internal value.

View Source 
const SubscriptionStateExpired = shared.SubscriptionStateExpired

This is an alias to an internal value.

View Source 
const SubscriptionStateFailed = shared.SubscriptionStateFailed

This is an alias to an internal value.

View Source 
const SubscriptionStatePaid = shared.SubscriptionStatePaid

This is an alias to an internal value.

View Source 
const SubscriptionStateProvisioned = shared.SubscriptionStateProvisioned

This is an alias to an internal value.

View Source 
const SubscriptionStateTrial = shared.SubscriptionStateTrial

This is an alias to an internal value.

View Source 
const TokenPolicyEffectAllow = shared.TokenPolicyEffectAllow

This is an alias to an internal value.

View Source 
const TokenPolicyEffectDeny = shared.TokenPolicyEffectDeny

This is an alias to an internal value.

View Source 
const TokenStatusActive = shared.TokenStatusActive

This is an alias to an internal value.

View Source 
const TokenStatusDisabled = shared.TokenStatusDisabled

This is an alias to an internal value.

View Source 
const TokenStatusExpired = shared.TokenStatusExpired

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 BlockRule 

type BlockRule struct {
	// The timestamp of when the rule was last modified.
	LastUpdated time.Time `json:"last_updated" api:"required" format:"date-time"`
	// The version of the rule.
	Version string `json:"version" api:"required"`
	// The unique ID of the rule.
	ID string `json:"id"`
	// The action to perform when the rule matches.
	Action BlockRuleAction `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters BlockRuleActionParameters `json:"action_parameters"`
	// The categories of the rule.
	Categories []string `json:"categories"`
	// An informative description of the rule.
	Description string `json:"description"`
	// Whether the rule should be executed.
	Enabled bool `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck BlockRuleExposedCredentialCheck `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression string `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging Logging `json:"logging"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit BlockRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string        `json:"ref"`
	JSON blockRuleJSON `json:"-"`
}

func (*BlockRule) UnmarshalJSON 

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

type BlockRuleAction 

type BlockRuleAction string

The action to perform when the rule matches. 

const (
	BlockRuleActionBlock BlockRuleAction = "block"
)

func (BlockRuleAction) IsKnown 

func (r BlockRuleAction) IsKnown() bool

type BlockRuleActionParameters 

type BlockRuleActionParameters struct {
	// The response to show when the block is applied.
	Response BlockRuleActionParametersResponse `json:"response"`
	JSON     blockRuleActionParametersJSON     `json:"-"`
}

The parameters configuring the rule's action.

func (*BlockRuleActionParameters) UnmarshalJSON 

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

type BlockRuleActionParametersParam 

type BlockRuleActionParametersParam struct {
	// The response to show when the block is applied.
	Response param.Field[BlockRuleActionParametersResponseParam] `json:"response"`
}

The parameters configuring the rule's action.

func (BlockRuleActionParametersParam) MarshalJSON 

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

type BlockRuleActionParametersResponse 

type BlockRuleActionParametersResponse struct {
	// The content to return.
	Content string `json:"content" api:"required"`
	// The type of the content to return.
	ContentType string `json:"content_type" api:"required"`
	// The status code to return.
	StatusCode int64                                 `json:"status_code" api:"required"`
	JSON       blockRuleActionParametersResponseJSON `json:"-"`
}

The response to show when the block is applied.

func (*BlockRuleActionParametersResponse) UnmarshalJSON 

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

type BlockRuleActionParametersResponseParam 

type BlockRuleActionParametersResponseParam struct {
	// The content to return.
	Content param.Field[string] `json:"content" api:"required"`
	// The type of the content to return.
	ContentType param.Field[string] `json:"content_type" api:"required"`
	// The status code to return.
	StatusCode param.Field[int64] `json:"status_code" api:"required"`
}

The response to show when the block is applied.

func (BlockRuleActionParametersResponseParam) MarshalJSON 

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

type BlockRuleExposedCredentialCheck 

type BlockRuleExposedCredentialCheck struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression string `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression string                              `json:"username_expression" api:"required"`
	JSON               blockRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*BlockRuleExposedCredentialCheck) UnmarshalJSON 

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

type BlockRuleExposedCredentialCheckParam 

type BlockRuleExposedCredentialCheckParam struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression param.Field[string] `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression param.Field[string] `json:"username_expression" api:"required"`
}

Configuration for exposed credential checking.

func (BlockRuleExposedCredentialCheckParam) MarshalJSON 

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

type BlockRuleParam 

type BlockRuleParam struct {
	// The unique ID of the rule.
	ID param.Field[string] `json:"id"`
	// The action to perform when the rule matches.
	Action param.Field[BlockRuleAction] `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters param.Field[BlockRuleActionParametersParam] `json:"action_parameters"`
	// An informative description of the rule.
	Description param.Field[string] `json:"description"`
	// Whether the rule should be executed.
	Enabled param.Field[bool] `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck param.Field[BlockRuleExposedCredentialCheckParam] `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression param.Field[string] `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging param.Field[LoggingParam] `json:"logging"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit param.Field[BlockRuleRatelimitParam] `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref param.Field[string] `json:"ref"`
}

func (BlockRuleParam) MarshalJSON 

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

type BlockRuleRatelimit 

type BlockRuleRatelimit struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics []string `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period int64 `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression string `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout int64 `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod int64 `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin bool `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod int64 `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName string                 `json:"score_response_header_name"`
	JSON                    blockRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*BlockRuleRatelimit) UnmarshalJSON 

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

type BlockRuleRatelimitParam 

type BlockRuleRatelimitParam struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics param.Field[[]string] `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period param.Field[int64] `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression param.Field[string] `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout param.Field[int64] `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod param.Field[int64] `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin param.Field[bool] `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod param.Field[int64] `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName param.Field[string] `json:"score_response_header_name"`
}

An object configuring the rule's rate limit behavior.

func (BlockRuleRatelimitParam) MarshalJSON 

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

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 CompressResponseRule 

type CompressResponseRule struct {
	// The timestamp of when the rule was last modified.
	LastUpdated time.Time `json:"last_updated" api:"required" format:"date-time"`
	// The version of the rule.
	Version string `json:"version" api:"required"`
	// The unique ID of the rule.
	ID string `json:"id"`
	// The action to perform when the rule matches.
	Action CompressResponseRuleAction `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters CompressResponseRuleActionParameters `json:"action_parameters"`
	// The categories of the rule.
	Categories []string `json:"categories"`
	// An informative description of the rule.
	Description string `json:"description"`
	// Whether the rule should be executed.
	Enabled bool `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck CompressResponseRuleExposedCredentialCheck `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression string `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging Logging `json:"logging"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit CompressResponseRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                   `json:"ref"`
	JSON compressResponseRuleJSON `json:"-"`
}

func (*CompressResponseRule) UnmarshalJSON 

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

type CompressResponseRuleAction 

type CompressResponseRuleAction string

The action to perform when the rule matches. 

const (
	CompressResponseRuleActionCompressResponse CompressResponseRuleAction = "compress_response"
)

func (CompressResponseRuleAction) IsKnown 

func (r CompressResponseRuleAction) IsKnown() bool

type CompressResponseRuleActionParameters 

type CompressResponseRuleActionParameters struct {
	// Custom order for compression algorithms.
	Algorithms []CompressResponseRuleActionParametersAlgorithm `json:"algorithms" api:"required"`
	JSON       compressResponseRuleActionParametersJSON        `json:"-"`
}

The parameters configuring the rule's action.

func (*CompressResponseRuleActionParameters) UnmarshalJSON 

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

type CompressResponseRuleActionParametersAlgorithm 

type CompressResponseRuleActionParametersAlgorithm struct {
	// Name of the compression algorithm to enable.
	Name CompressResponseRuleActionParametersAlgorithmsName `json:"name"`
	JSON compressResponseRuleActionParametersAlgorithmJSON  `json:"-"`
}

Compression algorithm to enable.

func (*CompressResponseRuleActionParametersAlgorithm) UnmarshalJSON 

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

type CompressResponseRuleActionParametersAlgorithmParam 

type CompressResponseRuleActionParametersAlgorithmParam struct {
	// Name of the compression algorithm to enable.
	Name param.Field[CompressResponseRuleActionParametersAlgorithmsName] `json:"name"`
}

Compression algorithm to enable.

func (CompressResponseRuleActionParametersAlgorithmParam) MarshalJSON 

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

type CompressResponseRuleActionParametersAlgorithmsName 

type CompressResponseRuleActionParametersAlgorithmsName string

Name of the compression algorithm to enable. 

const (
	CompressResponseRuleActionParametersAlgorithmsNameNone    CompressResponseRuleActionParametersAlgorithmsName = "none"
	CompressResponseRuleActionParametersAlgorithmsNameAuto    CompressResponseRuleActionParametersAlgorithmsName = "auto"
	CompressResponseRuleActionParametersAlgorithmsNameDefault CompressResponseRuleActionParametersAlgorithmsName = "default"
	CompressResponseRuleActionParametersAlgorithmsNameGzip    CompressResponseRuleActionParametersAlgorithmsName = "gzip"
	CompressResponseRuleActionParametersAlgorithmsNameBrotli  CompressResponseRuleActionParametersAlgorithmsName = "brotli"
	CompressResponseRuleActionParametersAlgorithmsNameZstd    CompressResponseRuleActionParametersAlgorithmsName = "zstd"
)

func (CompressResponseRuleActionParametersAlgorithmsName) IsKnown 

func (r CompressResponseRuleActionParametersAlgorithmsName) IsKnown() bool

type CompressResponseRuleActionParametersParam 

type CompressResponseRuleActionParametersParam struct {
	// Custom order for compression algorithms.
	Algorithms param.Field[[]CompressResponseRuleActionParametersAlgorithmParam] `json:"algorithms" api:"required"`
}

The parameters configuring the rule's action.

func (CompressResponseRuleActionParametersParam) MarshalJSON 

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

type CompressResponseRuleExposedCredentialCheck 

type CompressResponseRuleExposedCredentialCheck struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression string `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression string                                         `json:"username_expression" api:"required"`
	JSON               compressResponseRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*CompressResponseRuleExposedCredentialCheck) UnmarshalJSON 

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

type CompressResponseRuleExposedCredentialCheckParam 

type CompressResponseRuleExposedCredentialCheckParam struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression param.Field[string] `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression param.Field[string] `json:"username_expression" api:"required"`
}

Configuration for exposed credential checking.

func (CompressResponseRuleExposedCredentialCheckParam) MarshalJSON 

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

type CompressResponseRuleParam 

type CompressResponseRuleParam struct {
	// The unique ID of the rule.
	ID param.Field[string] `json:"id"`
	// The action to perform when the rule matches.
	Action param.Field[CompressResponseRuleAction] `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters param.Field[CompressResponseRuleActionParametersParam] `json:"action_parameters"`
	// An informative description of the rule.
	Description param.Field[string] `json:"description"`
	// Whether the rule should be executed.
	Enabled param.Field[bool] `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck param.Field[CompressResponseRuleExposedCredentialCheckParam] `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression param.Field[string] `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging param.Field[LoggingParam] `json:"logging"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit param.Field[CompressResponseRuleRatelimitParam] `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref param.Field[string] `json:"ref"`
}

func (CompressResponseRuleParam) MarshalJSON 

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

type CompressResponseRuleRatelimit 

type CompressResponseRuleRatelimit struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics []string `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period int64 `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression string `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout int64 `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod int64 `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin bool `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod int64 `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName string                            `json:"score_response_header_name"`
	JSON                    compressResponseRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*CompressResponseRuleRatelimit) UnmarshalJSON 

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

type CompressResponseRuleRatelimitParam 

type CompressResponseRuleRatelimitParam struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics param.Field[[]string] `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period param.Field[int64] `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression param.Field[string] `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout param.Field[int64] `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod param.Field[int64] `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin param.Field[bool] `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod param.Field[int64] `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName param.Field[string] `json:"score_response_header_name"`
}

An object configuring the rule's rate limit behavior.

func (CompressResponseRuleRatelimitParam) MarshalJSON 

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

type DDoSDynamicRule 

type DDoSDynamicRule struct {
	// The timestamp of when the rule was last modified.
	LastUpdated time.Time `json:"last_updated" api:"required" format:"date-time"`
	// The version of the rule.
	Version string `json:"version" api:"required"`
	// The unique ID of the rule.
	ID string `json:"id"`
	// The action to perform when the rule matches.
	Action DDoSDynamicRuleAction `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters interface{} `json:"action_parameters"`
	// The categories of the rule.
	Categories []string `json:"categories"`
	// An informative description of the rule.
	Description string `json:"description"`
	// Whether the rule should be executed.
	Enabled bool `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck DDoSDynamicRuleExposedCredentialCheck `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression string `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging Logging `json:"logging"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit DDoSDynamicRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string              `json:"ref"`
	JSON DDoSDynamicRuleJSON `json:"-"`
}

func (*DDoSDynamicRule) UnmarshalJSON 

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

type DDoSDynamicRuleAction 

type DDoSDynamicRuleAction string

The action to perform when the rule matches. 

const (
	DDoSDynamicRuleActionDDoSDynamic DDoSDynamicRuleAction = "ddos_dynamic"
)

func (DDoSDynamicRuleAction) IsKnown 

func (r DDoSDynamicRuleAction) IsKnown() bool

type DDoSDynamicRuleExposedCredentialCheck 

type DDoSDynamicRuleExposedCredentialCheck struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression string `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression string                                    `json:"username_expression" api:"required"`
	JSON               DDoSDynamicRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*DDoSDynamicRuleExposedCredentialCheck) UnmarshalJSON 

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

type DDoSDynamicRuleExposedCredentialCheckJSON 

type DDoSDynamicRuleExposedCredentialCheckJSON struct {
	PasswordExpression apijson.Field
	UsernameExpression apijson.Field

	ExtraFields map[string]apijson.Field
	// contains filtered or unexported fields
}

DDoSDynamicRuleExposedCredentialCheckJSON contains the JSON metadata for the struct DDoSDynamicRuleExposedCredentialCheck

func (DDoSDynamicRuleExposedCredentialCheckJSON) RawJSON 

func (r DDoSDynamicRuleExposedCredentialCheckJSON) RawJSON() string

type DDoSDynamicRuleExposedCredentialCheckParam 

type DDoSDynamicRuleExposedCredentialCheckParam struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression param.Field[string] `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression param.Field[string] `json:"username_expression" api:"required"`
}

Configuration for exposed credential checking.

func (DDoSDynamicRuleExposedCredentialCheckParam) MarshalJSON 

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

type DDoSDynamicRuleJSON 

type DDoSDynamicRuleJSON struct {
	LastUpdated            apijson.Field
	Version                apijson.Field
	ID                     apijson.Field
	Action                 apijson.Field
	ActionParameters       apijson.Field
	Categories             apijson.Field
	Description            apijson.Field
	Enabled                apijson.Field
	ExposedCredentialCheck apijson.Field
	Expression             apijson.Field
	Logging                apijson.Field
	Ratelimit              apijson.Field
	Ref                    apijson.Field

	ExtraFields map[string]apijson.Field
	// contains filtered or unexported fields
}

DDoSDynamicRuleJSON contains the JSON metadata for the struct DDoSDynamicRule

func (DDoSDynamicRuleJSON) RawJSON 

func (r DDoSDynamicRuleJSON) RawJSON() string

type DDoSDynamicRuleParam 

type DDoSDynamicRuleParam struct {
	// The unique ID of the rule.
	ID param.Field[string] `json:"id"`
	// The action to perform when the rule matches.
	Action param.Field[DDoSDynamicRuleAction] `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters param.Field[interface{}] `json:"action_parameters"`
	// An informative description of the rule.
	Description param.Field[string] `json:"description"`
	// Whether the rule should be executed.
	Enabled param.Field[bool] `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck param.Field[DDoSDynamicRuleExposedCredentialCheckParam] `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression param.Field[string] `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging param.Field[LoggingParam] `json:"logging"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit param.Field[DDoSDynamicRuleRatelimitParam] `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref param.Field[string] `json:"ref"`
}

func (DDoSDynamicRuleParam) MarshalJSON 

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

type DDoSDynamicRuleRatelimit 

type DDoSDynamicRuleRatelimit struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics []string `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period int64 `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression string `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout int64 `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod int64 `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin bool `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod int64 `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName string                       `json:"score_response_header_name"`
	JSON                    DDoSDynamicRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*DDoSDynamicRuleRatelimit) UnmarshalJSON 

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

type DDoSDynamicRuleRatelimitJSON 

type DDoSDynamicRuleRatelimitJSON struct {
	Characteristics         apijson.Field
	Period                  apijson.Field
	CountingExpression      apijson.Field
	MitigationTimeout       apijson.Field
	RequestsPerPeriod       apijson.Field
	RequestsToOrigin        apijson.Field
	ScorePerPeriod          apijson.Field
	ScoreResponseHeaderName apijson.Field

	ExtraFields map[string]apijson.Field
	// contains filtered or unexported fields
}

DDoSDynamicRuleRatelimitJSON contains the JSON metadata for the struct DDoSDynamicRuleRatelimit

func (DDoSDynamicRuleRatelimitJSON) RawJSON 

func (r DDoSDynamicRuleRatelimitJSON) RawJSON() string

type DDoSDynamicRuleRatelimitParam 

type DDoSDynamicRuleRatelimitParam struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics param.Field[[]string] `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period param.Field[int64] `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression param.Field[string] `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout param.Field[int64] `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod param.Field[int64] `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin param.Field[bool] `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod param.Field[int64] `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName param.Field[string] `json:"score_response_header_name"`
}

An object configuring the rule's rate limit behavior.

func (DDoSDynamicRuleRatelimitParam) MarshalJSON 

func (r DDoSDynamicRuleRatelimitParam) 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 ExecuteRule 

type ExecuteRule struct {
	// The timestamp of when the rule was last modified.
	LastUpdated time.Time `json:"last_updated" api:"required" format:"date-time"`
	// The version of the rule.
	Version string `json:"version" api:"required"`
	// The unique ID of the rule.
	ID string `json:"id"`
	// The action to perform when the rule matches.
	Action ExecuteRuleAction `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters ExecuteRuleActionParameters `json:"action_parameters"`
	// The categories of the rule.
	Categories []string `json:"categories"`
	// An informative description of the rule.
	Description string `json:"description"`
	// Whether the rule should be executed.
	Enabled bool `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck ExecuteRuleExposedCredentialCheck `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression string `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging Logging `json:"logging"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit ExecuteRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string          `json:"ref"`
	JSON executeRuleJSON `json:"-"`
}

func (*ExecuteRule) UnmarshalJSON 

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

type ExecuteRuleAction 

type ExecuteRuleAction string

The action to perform when the rule matches. 

const (
	ExecuteRuleActionExecute ExecuteRuleAction = "execute"
)

func (ExecuteRuleAction) IsKnown 

func (r ExecuteRuleAction) IsKnown() bool

type ExecuteRuleActionParameters 

type ExecuteRuleActionParameters struct {
	// The ID of the ruleset to execute.
	ID string `json:"id" api:"required"`
	// The configuration to use for matched data logging.
	MatchedData ExecuteRuleActionParametersMatchedData `json:"matched_data"`
	// A set of overrides to apply to the target ruleset.
	Overrides ExecuteRuleActionParametersOverrides `json:"overrides"`
	JSON      executeRuleActionParametersJSON      `json:"-"`
}

The parameters configuring the rule's action.

func (*ExecuteRuleActionParameters) UnmarshalJSON 

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

type ExecuteRuleActionParametersMatchedData 

type ExecuteRuleActionParametersMatchedData struct {
	// The public key to encrypt matched data logs with.
	PublicKey string                                     `json:"public_key" api:"required"`
	JSON      executeRuleActionParametersMatchedDataJSON `json:"-"`
}

The configuration to use for matched data logging.

func (*ExecuteRuleActionParametersMatchedData) UnmarshalJSON 

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

type ExecuteRuleActionParametersMatchedDataParam 

type ExecuteRuleActionParametersMatchedDataParam struct {
	// The public key to encrypt matched data logs with.
	PublicKey param.Field[string] `json:"public_key" api:"required"`
}

The configuration to use for matched data logging.

func (ExecuteRuleActionParametersMatchedDataParam) MarshalJSON 

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

type ExecuteRuleActionParametersOverrides 

type ExecuteRuleActionParametersOverrides struct {
	// An action to override all rules with. This option has lower precedence than rule
	// and category overrides.
	Action string `json:"action"`
	// A list of category-level overrides. This option has the second-highest
	// precedence after rule-level overrides.
	Categories []ExecuteRuleActionParametersOverridesCategory `json:"categories"`
	// Whether to enable execution of all rules. This option has lower precedence than
	// rule and category overrides.
	Enabled bool `json:"enabled"`
	// A list of rule-level overrides. This option has the highest precedence.
	Rules []ExecuteRuleActionParametersOverridesRule `json:"rules"`
	// A sensitivity level to set for all rules. This option has lower precedence than
	// rule and category overrides and is only applicable for DDoS phases.
	SensitivityLevel ExecuteRuleActionParametersOverridesSensitivityLevel `json:"sensitivity_level"`
	JSON             executeRuleActionParametersOverridesJSON             `json:"-"`
}

A set of overrides to apply to the target ruleset.

func (*ExecuteRuleActionParametersOverrides) UnmarshalJSON 

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

type ExecuteRuleActionParametersOverridesCategoriesSensitivityLevel 

type ExecuteRuleActionParametersOverridesCategoriesSensitivityLevel string

The sensitivity level to use for rules in the category. This option is only applicable for DDoS phases. 

const (
	ExecuteRuleActionParametersOverridesCategoriesSensitivityLevelDefault ExecuteRuleActionParametersOverridesCategoriesSensitivityLevel = "default"
	ExecuteRuleActionParametersOverridesCategoriesSensitivityLevelMedium  ExecuteRuleActionParametersOverridesCategoriesSensitivityLevel = "medium"
	ExecuteRuleActionParametersOverridesCategoriesSensitivityLevelLow     ExecuteRuleActionParametersOverridesCategoriesSensitivityLevel = "low"
	ExecuteRuleActionParametersOverridesCategoriesSensitivityLevelEoff    ExecuteRuleActionParametersOverridesCategoriesSensitivityLevel = "eoff"
)

func (ExecuteRuleActionParametersOverridesCategoriesSensitivityLevel) IsKnown 

func (r ExecuteRuleActionParametersOverridesCategoriesSensitivityLevel) IsKnown() bool

type ExecuteRuleActionParametersOverridesCategory 

type ExecuteRuleActionParametersOverridesCategory struct {
	// The name of the category to override.
	Category string `json:"category" api:"required"`
	// The action to override rules in the category with.
	Action string `json:"action"`
	// Whether to enable execution of rules in the category.
	Enabled bool `json:"enabled"`
	// The sensitivity level to use for rules in the category. This option is only
	// applicable for DDoS phases.
	SensitivityLevel ExecuteRuleActionParametersOverridesCategoriesSensitivityLevel `json:"sensitivity_level"`
	JSON             executeRuleActionParametersOverridesCategoryJSON               `json:"-"`
}

A category-level override.

func (*ExecuteRuleActionParametersOverridesCategory) UnmarshalJSON 

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

type ExecuteRuleActionParametersOverridesCategoryParam 

type ExecuteRuleActionParametersOverridesCategoryParam struct {
	// The name of the category to override.
	Category param.Field[string] `json:"category" api:"required"`
	// The action to override rules in the category with.
	Action param.Field[string] `json:"action"`
	// Whether to enable execution of rules in the category.
	Enabled param.Field[bool] `json:"enabled"`
	// The sensitivity level to use for rules in the category. This option is only
	// applicable for DDoS phases.
	SensitivityLevel param.Field[ExecuteRuleActionParametersOverridesCategoriesSensitivityLevel] `json:"sensitivity_level"`
}

A category-level override.

func (ExecuteRuleActionParametersOverridesCategoryParam) MarshalJSON 

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

type ExecuteRuleActionParametersOverridesParam 

type ExecuteRuleActionParametersOverridesParam struct {
	// An action to override all rules with. This option has lower precedence than rule
	// and category overrides.
	Action param.Field[string] `json:"action"`
	// A list of category-level overrides. This option has the second-highest
	// precedence after rule-level overrides.
	Categories param.Field[[]ExecuteRuleActionParametersOverridesCategoryParam] `json:"categories"`
	// Whether to enable execution of all rules. This option has lower precedence than
	// rule and category overrides.
	Enabled param.Field[bool] `json:"enabled"`
	// A list of rule-level overrides. This option has the highest precedence.
	Rules param.Field[[]ExecuteRuleActionParametersOverridesRuleParam] `json:"rules"`
	// A sensitivity level to set for all rules. This option has lower precedence than
	// rule and category overrides and is only applicable for DDoS phases.
	SensitivityLevel param.Field[ExecuteRuleActionParametersOverridesSensitivityLevel] `json:"sensitivity_level"`
}

A set of overrides to apply to the target ruleset.

func (ExecuteRuleActionParametersOverridesParam) MarshalJSON 

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

type ExecuteRuleActionParametersOverridesRule 

type ExecuteRuleActionParametersOverridesRule struct {
	// The ID of the rule to override.
	ID string `json:"id" api:"required"`
	// The action to override the rule with.
	Action string `json:"action"`
	// Whether to enable execution of the rule.
	Enabled bool `json:"enabled"`
	// The score threshold to use for the rule.
	ScoreThreshold int64 `json:"score_threshold"`
	// The sensitivity level to use for the rule. This option is only applicable for
	// DDoS phases.
	SensitivityLevel ExecuteRuleActionParametersOverridesRulesSensitivityLevel `json:"sensitivity_level"`
	JSON             executeRuleActionParametersOverridesRuleJSON              `json:"-"`
}

A rule-level override.

func (*ExecuteRuleActionParametersOverridesRule) UnmarshalJSON 

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

type ExecuteRuleActionParametersOverridesRuleParam 

type ExecuteRuleActionParametersOverridesRuleParam struct {
	// The ID of the rule to override.
	ID param.Field[string] `json:"id" api:"required"`
	// The action to override the rule with.
	Action param.Field[string] `json:"action"`
	// Whether to enable execution of the rule.
	Enabled param.Field[bool] `json:"enabled"`
	// The score threshold to use for the rule.
	ScoreThreshold param.Field[int64] `json:"score_threshold"`
	// The sensitivity level to use for the rule. This option is only applicable for
	// DDoS phases.
	SensitivityLevel param.Field[ExecuteRuleActionParametersOverridesRulesSensitivityLevel] `json:"sensitivity_level"`
}

A rule-level override.

func (ExecuteRuleActionParametersOverridesRuleParam) MarshalJSON 

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

type ExecuteRuleActionParametersOverridesRulesSensitivityLevel 

type ExecuteRuleActionParametersOverridesRulesSensitivityLevel string

The sensitivity level to use for the rule. This option is only applicable for DDoS phases. 

const (
	ExecuteRuleActionParametersOverridesRulesSensitivityLevelDefault ExecuteRuleActionParametersOverridesRulesSensitivityLevel = "default"
	ExecuteRuleActionParametersOverridesRulesSensitivityLevelMedium  ExecuteRuleActionParametersOverridesRulesSensitivityLevel = "medium"
	ExecuteRuleActionParametersOverridesRulesSensitivityLevelLow     ExecuteRuleActionParametersOverridesRulesSensitivityLevel = "low"
	ExecuteRuleActionParametersOverridesRulesSensitivityLevelEoff    ExecuteRuleActionParametersOverridesRulesSensitivityLevel = "eoff"
)

func (ExecuteRuleActionParametersOverridesRulesSensitivityLevel) IsKnown 

func (r ExecuteRuleActionParametersOverridesRulesSensitivityLevel) IsKnown() bool

type ExecuteRuleActionParametersOverridesSensitivityLevel 

type ExecuteRuleActionParametersOverridesSensitivityLevel string

A sensitivity level to set for all rules. This option has lower precedence than rule and category overrides and is only applicable for DDoS phases. 

const (
	ExecuteRuleActionParametersOverridesSensitivityLevelDefault ExecuteRuleActionParametersOverridesSensitivityLevel = "default"
	ExecuteRuleActionParametersOverridesSensitivityLevelMedium  ExecuteRuleActionParametersOverridesSensitivityLevel = "medium"
	ExecuteRuleActionParametersOverridesSensitivityLevelLow     ExecuteRuleActionParametersOverridesSensitivityLevel = "low"
	ExecuteRuleActionParametersOverridesSensitivityLevelEoff    ExecuteRuleActionParametersOverridesSensitivityLevel = "eoff"
)

func (ExecuteRuleActionParametersOverridesSensitivityLevel) IsKnown 

func (r ExecuteRuleActionParametersOverridesSensitivityLevel) IsKnown() bool

type ExecuteRuleActionParametersParam 

type ExecuteRuleActionParametersParam struct {
	// The ID of the ruleset to execute.
	ID param.Field[string] `json:"id" api:"required"`
	// The configuration to use for matched data logging.
	MatchedData param.Field[ExecuteRuleActionParametersMatchedDataParam] `json:"matched_data"`
	// A set of overrides to apply to the target ruleset.
	Overrides param.Field[ExecuteRuleActionParametersOverridesParam] `json:"overrides"`
}

The parameters configuring the rule's action.

func (ExecuteRuleActionParametersParam) MarshalJSON 

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

type ExecuteRuleExposedCredentialCheck 

type ExecuteRuleExposedCredentialCheck struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression string `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression string                                `json:"username_expression" api:"required"`
	JSON               executeRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*ExecuteRuleExposedCredentialCheck) UnmarshalJSON 

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

type ExecuteRuleExposedCredentialCheckParam 

type ExecuteRuleExposedCredentialCheckParam struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression param.Field[string] `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression param.Field[string] `json:"username_expression" api:"required"`
}

Configuration for exposed credential checking.

func (ExecuteRuleExposedCredentialCheckParam) MarshalJSON 

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

type ExecuteRuleParam 

type ExecuteRuleParam struct {
	// The unique ID of the rule.
	ID param.Field[string] `json:"id"`
	// The action to perform when the rule matches.
	Action param.Field[ExecuteRuleAction] `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters param.Field[ExecuteRuleActionParametersParam] `json:"action_parameters"`
	// An informative description of the rule.
	Description param.Field[string] `json:"description"`
	// Whether the rule should be executed.
	Enabled param.Field[bool] `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck param.Field[ExecuteRuleExposedCredentialCheckParam] `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression param.Field[string] `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging param.Field[LoggingParam] `json:"logging"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit param.Field[ExecuteRuleRatelimitParam] `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref param.Field[string] `json:"ref"`
}

func (ExecuteRuleParam) MarshalJSON 

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

type ExecuteRuleRatelimit 

type ExecuteRuleRatelimit struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics []string `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period int64 `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression string `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout int64 `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod int64 `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin bool `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod int64 `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName string                   `json:"score_response_header_name"`
	JSON                    executeRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*ExecuteRuleRatelimit) UnmarshalJSON 

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

type ExecuteRuleRatelimitParam 

type ExecuteRuleRatelimitParam struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics param.Field[[]string] `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period param.Field[int64] `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression param.Field[string] `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout param.Field[int64] `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod param.Field[int64] `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin param.Field[bool] `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod param.Field[int64] `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName param.Field[string] `json:"score_response_header_name"`
}

An object configuring the rule's rate limit behavior.

func (ExecuteRuleRatelimitParam) MarshalJSON 

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

type ForceConnectionCloseRule 

type ForceConnectionCloseRule struct {
	// The timestamp of when the rule was last modified.
	LastUpdated time.Time `json:"last_updated" api:"required" format:"date-time"`
	// The version of the rule.
	Version string `json:"version" api:"required"`
	// The unique ID of the rule.
	ID string `json:"id"`
	// The action to perform when the rule matches.
	Action ForceConnectionCloseRuleAction `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters interface{} `json:"action_parameters"`
	// The categories of the rule.
	Categories []string `json:"categories"`
	// An informative description of the rule.
	Description string `json:"description"`
	// Whether the rule should be executed.
	Enabled bool `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck ForceConnectionCloseRuleExposedCredentialCheck `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression string `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging Logging `json:"logging"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit ForceConnectionCloseRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                       `json:"ref"`
	JSON forceConnectionCloseRuleJSON `json:"-"`
}

func (*ForceConnectionCloseRule) UnmarshalJSON 

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

type ForceConnectionCloseRuleAction 

type ForceConnectionCloseRuleAction string

The action to perform when the rule matches. 

const (
	ForceConnectionCloseRuleActionForceConnectionClose ForceConnectionCloseRuleAction = "force_connection_close"
)

func (ForceConnectionCloseRuleAction) IsKnown 

func (r ForceConnectionCloseRuleAction) IsKnown() bool

type ForceConnectionCloseRuleExposedCredentialCheck 

type ForceConnectionCloseRuleExposedCredentialCheck struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression string `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression string                                             `json:"username_expression" api:"required"`
	JSON               forceConnectionCloseRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*ForceConnectionCloseRuleExposedCredentialCheck) UnmarshalJSON 

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

type ForceConnectionCloseRuleExposedCredentialCheckParam 

type ForceConnectionCloseRuleExposedCredentialCheckParam struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression param.Field[string] `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression param.Field[string] `json:"username_expression" api:"required"`
}

Configuration for exposed credential checking.

func (ForceConnectionCloseRuleExposedCredentialCheckParam) MarshalJSON 

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

type ForceConnectionCloseRuleParam 

type ForceConnectionCloseRuleParam struct {
	// The unique ID of the rule.
	ID param.Field[string] `json:"id"`
	// The action to perform when the rule matches.
	Action param.Field[ForceConnectionCloseRuleAction] `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters param.Field[interface{}] `json:"action_parameters"`
	// An informative description of the rule.
	Description param.Field[string] `json:"description"`
	// Whether the rule should be executed.
	Enabled param.Field[bool] `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck param.Field[ForceConnectionCloseRuleExposedCredentialCheckParam] `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression param.Field[string] `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging param.Field[LoggingParam] `json:"logging"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit param.Field[ForceConnectionCloseRuleRatelimitParam] `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref param.Field[string] `json:"ref"`
}

func (ForceConnectionCloseRuleParam) MarshalJSON 

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

type ForceConnectionCloseRuleRatelimit 

type ForceConnectionCloseRuleRatelimit struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics []string `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period int64 `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression string `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout int64 `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod int64 `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin bool `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod int64 `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName string                                `json:"score_response_header_name"`
	JSON                    forceConnectionCloseRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*ForceConnectionCloseRuleRatelimit) UnmarshalJSON 

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

type ForceConnectionCloseRuleRatelimitParam 

type ForceConnectionCloseRuleRatelimitParam struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics param.Field[[]string] `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period param.Field[int64] `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression param.Field[string] `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout param.Field[int64] `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod param.Field[int64] `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin param.Field[bool] `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod param.Field[int64] `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName param.Field[string] `json:"score_response_header_name"`
}

An object configuring the rule's rate limit behavior.

func (ForceConnectionCloseRuleRatelimitParam) MarshalJSON 

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

type Kind 

type Kind string

The kind of the ruleset. 

const (
	KindManaged Kind = "managed"
	KindCustom  Kind = "custom"
	KindRoot    Kind = "root"
	KindZone    Kind = "zone"
)

func (Kind) IsKnown 

func (r Kind) IsKnown() bool

type LogCustomFieldRule 

type LogCustomFieldRule struct {
	// The timestamp of when the rule was last modified.
	LastUpdated time.Time `json:"last_updated" api:"required" format:"date-time"`
	// The version of the rule.
	Version string `json:"version" api:"required"`
	// The unique ID of the rule.
	ID string `json:"id"`
	// The action to perform when the rule matches.
	Action LogCustomFieldRuleAction `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters LogCustomFieldRuleActionParameters `json:"action_parameters"`
	// The categories of the rule.
	Categories []string `json:"categories"`
	// An informative description of the rule.
	Description string `json:"description"`
	// Whether the rule should be executed.
	Enabled bool `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck LogCustomFieldRuleExposedCredentialCheck `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression string `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging Logging `json:"logging"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit LogCustomFieldRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                 `json:"ref"`
	JSON logCustomFieldRuleJSON `json:"-"`
}

func (*LogCustomFieldRule) UnmarshalJSON 

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

type LogCustomFieldRuleAction 

type LogCustomFieldRuleAction string

The action to perform when the rule matches. 

const (
	LogCustomFieldRuleActionLogCustomField LogCustomFieldRuleAction = "log_custom_field"
)

func (LogCustomFieldRuleAction) IsKnown 

func (r LogCustomFieldRuleAction) IsKnown() bool

type LogCustomFieldRuleActionParameters 

type LogCustomFieldRuleActionParameters struct {
	// The cookie fields to log.
	CookieFields []LogCustomFieldRuleActionParametersCookieField `json:"cookie_fields"`
	// The raw response fields to log.
	RawResponseFields []LogCustomFieldRuleActionParametersRawResponseField `json:"raw_response_fields"`
	// The raw request fields to log.
	RequestFields []LogCustomFieldRuleActionParametersRequestField `json:"request_fields"`
	// The transformed response fields to log.
	ResponseFields []LogCustomFieldRuleActionParametersResponseField `json:"response_fields"`
	// The transformed request fields to log.
	TransformedRequestFields []LogCustomFieldRuleActionParametersTransformedRequestField `json:"transformed_request_fields"`
	JSON                     logCustomFieldRuleActionParametersJSON                      `json:"-"`
}

The parameters configuring the rule's action.

func (*LogCustomFieldRuleActionParameters) UnmarshalJSON 

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

type LogCustomFieldRuleActionParametersCookieField 

type LogCustomFieldRuleActionParametersCookieField struct {
	// The name of the cookie.
	Name string                                            `json:"name" api:"required"`
	JSON logCustomFieldRuleActionParametersCookieFieldJSON `json:"-"`
}

The cookie field to log.

func (*LogCustomFieldRuleActionParametersCookieField) UnmarshalJSON 

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

type LogCustomFieldRuleActionParametersCookieFieldParam 

type LogCustomFieldRuleActionParametersCookieFieldParam struct {
	// The name of the cookie.
	Name param.Field[string] `json:"name" api:"required"`
}

The cookie field to log.

func (LogCustomFieldRuleActionParametersCookieFieldParam) MarshalJSON 

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

type LogCustomFieldRuleActionParametersParam 

type LogCustomFieldRuleActionParametersParam struct {
	// The cookie fields to log.
	CookieFields param.Field[[]LogCustomFieldRuleActionParametersCookieFieldParam] `json:"cookie_fields"`
	// The raw response fields to log.
	RawResponseFields param.Field[[]LogCustomFieldRuleActionParametersRawResponseFieldParam] `json:"raw_response_fields"`
	// The raw request fields to log.
	RequestFields param.Field[[]LogCustomFieldRuleActionParametersRequestFieldParam] `json:"request_fields"`
	// The transformed response fields to log.
	ResponseFields param.Field[[]LogCustomFieldRuleActionParametersResponseFieldParam] `json:"response_fields"`
	// The transformed request fields to log.
	TransformedRequestFields param.Field[[]LogCustomFieldRuleActionParametersTransformedRequestFieldParam] `json:"transformed_request_fields"`
}

The parameters configuring the rule's action.

func (LogCustomFieldRuleActionParametersParam) MarshalJSON 

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

type LogCustomFieldRuleActionParametersRawResponseField 

type LogCustomFieldRuleActionParametersRawResponseField struct {
	// The name of the response header.
	Name string `json:"name" api:"required"`
	// Whether to log duplicate values of the same header.
	PreserveDuplicates bool                                                   `json:"preserve_duplicates"`
	JSON               logCustomFieldRuleActionParametersRawResponseFieldJSON `json:"-"`
}

The raw response field to log.

func (*LogCustomFieldRuleActionParametersRawResponseField) UnmarshalJSON 

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

type LogCustomFieldRuleActionParametersRawResponseFieldParam 

type LogCustomFieldRuleActionParametersRawResponseFieldParam struct {
	// The name of the response header.
	Name param.Field[string] `json:"name" api:"required"`
	// Whether to log duplicate values of the same header.
	PreserveDuplicates param.Field[bool] `json:"preserve_duplicates"`
}

The raw response field to log.

func (LogCustomFieldRuleActionParametersRawResponseFieldParam) MarshalJSON 

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

type LogCustomFieldRuleActionParametersRequestField 

type LogCustomFieldRuleActionParametersRequestField struct {
	// The name of the header.
	Name string                                             `json:"name" api:"required"`
	JSON logCustomFieldRuleActionParametersRequestFieldJSON `json:"-"`
}

The raw request field to log.

func (*LogCustomFieldRuleActionParametersRequestField) UnmarshalJSON 

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

type LogCustomFieldRuleActionParametersRequestFieldParam 

type LogCustomFieldRuleActionParametersRequestFieldParam struct {
	// The name of the header.
	Name param.Field[string] `json:"name" api:"required"`
}

The raw request field to log.

func (LogCustomFieldRuleActionParametersRequestFieldParam) MarshalJSON 

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

type LogCustomFieldRuleActionParametersResponseField 

type LogCustomFieldRuleActionParametersResponseField struct {
	// The name of the response header.
	Name string `json:"name" api:"required"`
	// Whether to log duplicate values of the same header.
	PreserveDuplicates bool                                                `json:"preserve_duplicates"`
	JSON               logCustomFieldRuleActionParametersResponseFieldJSON `json:"-"`
}

The transformed response field to log.

func (*LogCustomFieldRuleActionParametersResponseField) UnmarshalJSON 

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

type LogCustomFieldRuleActionParametersResponseFieldParam 

type LogCustomFieldRuleActionParametersResponseFieldParam struct {
	// The name of the response header.
	Name param.Field[string] `json:"name" api:"required"`
	// Whether to log duplicate values of the same header.
	PreserveDuplicates param.Field[bool] `json:"preserve_duplicates"`
}

The transformed response field to log.

func (LogCustomFieldRuleActionParametersResponseFieldParam) MarshalJSON 

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

type LogCustomFieldRuleActionParametersTransformedRequestField 

type LogCustomFieldRuleActionParametersTransformedRequestField struct {
	// The name of the header.
	Name string                                                        `json:"name" api:"required"`
	JSON logCustomFieldRuleActionParametersTransformedRequestFieldJSON `json:"-"`
}

The transformed request field to log.

func (*LogCustomFieldRuleActionParametersTransformedRequestField) UnmarshalJSON 

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

type LogCustomFieldRuleActionParametersTransformedRequestFieldParam 

type LogCustomFieldRuleActionParametersTransformedRequestFieldParam struct {
	// The name of the header.
	Name param.Field[string] `json:"name" api:"required"`
}

The transformed request field to log.

func (LogCustomFieldRuleActionParametersTransformedRequestFieldParam) MarshalJSON 

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

type LogCustomFieldRuleExposedCredentialCheck 

type LogCustomFieldRuleExposedCredentialCheck struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression string `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression string                                       `json:"username_expression" api:"required"`
	JSON               logCustomFieldRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*LogCustomFieldRuleExposedCredentialCheck) UnmarshalJSON 

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

type LogCustomFieldRuleExposedCredentialCheckParam 

type LogCustomFieldRuleExposedCredentialCheckParam struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression param.Field[string] `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression param.Field[string] `json:"username_expression" api:"required"`
}

Configuration for exposed credential checking.

func (LogCustomFieldRuleExposedCredentialCheckParam) MarshalJSON 

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

type LogCustomFieldRuleParam 

type LogCustomFieldRuleParam struct {
	// The unique ID of the rule.
	ID param.Field[string] `json:"id"`
	// The action to perform when the rule matches.
	Action param.Field[LogCustomFieldRuleAction] `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters param.Field[LogCustomFieldRuleActionParametersParam] `json:"action_parameters"`
	// An informative description of the rule.
	Description param.Field[string] `json:"description"`
	// Whether the rule should be executed.
	Enabled param.Field[bool] `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck param.Field[LogCustomFieldRuleExposedCredentialCheckParam] `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression param.Field[string] `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging param.Field[LoggingParam] `json:"logging"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit param.Field[LogCustomFieldRuleRatelimitParam] `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref param.Field[string] `json:"ref"`
}

func (LogCustomFieldRuleParam) MarshalJSON 

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

type LogCustomFieldRuleRatelimit 

type LogCustomFieldRuleRatelimit struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics []string `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period int64 `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression string `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout int64 `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod int64 `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin bool `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod int64 `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName string                          `json:"score_response_header_name"`
	JSON                    logCustomFieldRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*LogCustomFieldRuleRatelimit) UnmarshalJSON 

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

type LogCustomFieldRuleRatelimitParam 

type LogCustomFieldRuleRatelimitParam struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics param.Field[[]string] `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period param.Field[int64] `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression param.Field[string] `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout param.Field[int64] `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod param.Field[int64] `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin param.Field[bool] `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod param.Field[int64] `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName param.Field[string] `json:"score_response_header_name"`
}

An object configuring the rule's rate limit behavior.

func (LogCustomFieldRuleRatelimitParam) MarshalJSON 

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

type LogRule 

type LogRule struct {
	// The timestamp of when the rule was last modified.
	LastUpdated time.Time `json:"last_updated" api:"required" format:"date-time"`
	// The version of the rule.
	Version string `json:"version" api:"required"`
	// The unique ID of the rule.
	ID string `json:"id"`
	// The action to perform when the rule matches.
	Action LogRuleAction `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters interface{} `json:"action_parameters"`
	// The categories of the rule.
	Categories []string `json:"categories"`
	// An informative description of the rule.
	Description string `json:"description"`
	// Whether the rule should be executed.
	Enabled bool `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck LogRuleExposedCredentialCheck `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression string `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging Logging `json:"logging"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit LogRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string      `json:"ref"`
	JSON logRuleJSON `json:"-"`
}

func (*LogRule) UnmarshalJSON 

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

type LogRuleAction 

type LogRuleAction string

The action to perform when the rule matches. 

const (
	LogRuleActionLog LogRuleAction = "log"
)

func (LogRuleAction) IsKnown 

func (r LogRuleAction) IsKnown() bool

type LogRuleExposedCredentialCheck 

type LogRuleExposedCredentialCheck struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression string `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression string                            `json:"username_expression" api:"required"`
	JSON               logRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*LogRuleExposedCredentialCheck) UnmarshalJSON 

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

type LogRuleExposedCredentialCheckParam 

type LogRuleExposedCredentialCheckParam struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression param.Field[string] `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression param.Field[string] `json:"username_expression" api:"required"`
}

Configuration for exposed credential checking.

func (LogRuleExposedCredentialCheckParam) MarshalJSON 

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

type LogRuleParam 

type LogRuleParam struct {
	// The unique ID of the rule.
	ID param.Field[string] `json:"id"`
	// The action to perform when the rule matches.
	Action param.Field[LogRuleAction] `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters param.Field[interface{}] `json:"action_parameters"`
	// An informative description of the rule.
	Description param.Field[string] `json:"description"`
	// Whether the rule should be executed.
	Enabled param.Field[bool] `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck param.Field[LogRuleExposedCredentialCheckParam] `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression param.Field[string] `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging param.Field[LoggingParam] `json:"logging"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit param.Field[LogRuleRatelimitParam] `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref param.Field[string] `json:"ref"`
}

func (LogRuleParam) MarshalJSON 

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

type LogRuleRatelimit 

type LogRuleRatelimit struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics []string `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period int64 `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression string `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout int64 `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod int64 `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin bool `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod int64 `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName string               `json:"score_response_header_name"`
	JSON                    logRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*LogRuleRatelimit) UnmarshalJSON 

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

type LogRuleRatelimitParam 

type LogRuleRatelimitParam struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics param.Field[[]string] `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period param.Field[int64] `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression param.Field[string] `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout param.Field[int64] `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod param.Field[int64] `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin param.Field[bool] `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod param.Field[int64] `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName param.Field[string] `json:"score_response_header_name"`
}

An object configuring the rule's rate limit behavior.

func (LogRuleRatelimitParam) MarshalJSON 

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

type Logging 

type Logging struct {
	// Whether to generate a log when the rule matches.
	Enabled bool        `json:"enabled" api:"required"`
	JSON    loggingJSON `json:"-"`
}

An object configuring the rule's logging behavior.

func (*Logging) UnmarshalJSON 

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

type LoggingParam 

type LoggingParam struct {
	// Whether to generate a log when the rule matches.
	Enabled param.Field[bool] `json:"enabled" api:"required"`
}

An object configuring the rule's logging behavior.

func (LoggingParam) MarshalJSON 

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

type ManagedChallengeRule 

type ManagedChallengeRule struct {
	// The timestamp of when the rule was last modified.
	LastUpdated time.Time `json:"last_updated" api:"required" format:"date-time"`
	// The version of the rule.
	Version string `json:"version" api:"required"`
	// The unique ID of the rule.
	ID string `json:"id"`
	// The action to perform when the rule matches.
	Action ManagedChallengeRuleAction `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters interface{} `json:"action_parameters"`
	// The categories of the rule.
	Categories []string `json:"categories"`
	// An informative description of the rule.
	Description string `json:"description"`
	// Whether the rule should be executed.
	Enabled bool `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck ManagedChallengeRuleExposedCredentialCheck `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression string `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging Logging `json:"logging"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit ManagedChallengeRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                   `json:"ref"`
	JSON managedChallengeRuleJSON `json:"-"`
}

func (*ManagedChallengeRule) UnmarshalJSON 

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

type ManagedChallengeRuleAction 

type ManagedChallengeRuleAction string

The action to perform when the rule matches. 

const (
	ManagedChallengeRuleActionManagedChallenge ManagedChallengeRuleAction = "managed_challenge"
)

func (ManagedChallengeRuleAction) IsKnown 

func (r ManagedChallengeRuleAction) IsKnown() bool

type ManagedChallengeRuleExposedCredentialCheck 

type ManagedChallengeRuleExposedCredentialCheck struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression string `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression string                                         `json:"username_expression" api:"required"`
	JSON               managedChallengeRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*ManagedChallengeRuleExposedCredentialCheck) UnmarshalJSON 

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

type ManagedChallengeRuleExposedCredentialCheckParam 

type ManagedChallengeRuleExposedCredentialCheckParam struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression param.Field[string] `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression param.Field[string] `json:"username_expression" api:"required"`
}

Configuration for exposed credential checking.

func (ManagedChallengeRuleExposedCredentialCheckParam) MarshalJSON 

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

type ManagedChallengeRuleParam 

type ManagedChallengeRuleParam struct {
	// The unique ID of the rule.
	ID param.Field[string] `json:"id"`
	// The action to perform when the rule matches.
	Action param.Field[ManagedChallengeRuleAction] `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters param.Field[interface{}] `json:"action_parameters"`
	// An informative description of the rule.
	Description param.Field[string] `json:"description"`
	// Whether the rule should be executed.
	Enabled param.Field[bool] `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck param.Field[ManagedChallengeRuleExposedCredentialCheckParam] `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression param.Field[string] `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging param.Field[LoggingParam] `json:"logging"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit param.Field[ManagedChallengeRuleRatelimitParam] `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref param.Field[string] `json:"ref"`
}

func (ManagedChallengeRuleParam) MarshalJSON 

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

type ManagedChallengeRuleRatelimit 

type ManagedChallengeRuleRatelimit struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics []string `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period int64 `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression string `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout int64 `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod int64 `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin bool `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod int64 `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName string                            `json:"score_response_header_name"`
	JSON                    managedChallengeRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*ManagedChallengeRuleRatelimit) UnmarshalJSON 

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

type ManagedChallengeRuleRatelimitParam 

type ManagedChallengeRuleRatelimitParam struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics param.Field[[]string] `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period param.Field[int64] `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression param.Field[string] `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout param.Field[int64] `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod param.Field[int64] `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin param.Field[bool] `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod param.Field[int64] `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName param.Field[string] `json:"score_response_header_name"`
}

An object configuring the rule's rate limit behavior.

func (ManagedChallengeRuleRatelimitParam) MarshalJSON 

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

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 Phase 

type Phase string

The phase of the ruleset. 

const (
	PhaseDDoSL4                       Phase = "ddos_l4"
	PhaseDDoSL7                       Phase = "ddos_l7"
	PhaseHTTPConfigSettings           Phase = "http_config_settings"
	PhaseHTTPCustomErrors             Phase = "http_custom_errors"
	PhaseHTTPLogCustomFields          Phase = "http_log_custom_fields"
	PhaseHTTPRatelimit                Phase = "http_ratelimit"
	PhaseHTTPRequestCacheSettings     Phase = "http_request_cache_settings"
	PhaseHTTPRequestDynamicRedirect   Phase = "http_request_dynamic_redirect"
	PhaseHTTPRequestFirewallCustom    Phase = "http_request_firewall_custom"
	PhaseHTTPRequestFirewallManaged   Phase = "http_request_firewall_managed"
	PhaseHTTPRequestLateTransform     Phase = "http_request_late_transform"
	PhaseHTTPRequestOrigin            Phase = "http_request_origin"
	PhaseHTTPRequestRedirect          Phase = "http_request_redirect"
	PhaseHTTPRequestSanitize          Phase = "http_request_sanitize"
	PhaseHTTPRequestSBFM              Phase = "http_request_sbfm"
	PhaseHTTPRequestTransform         Phase = "http_request_transform"
	PhaseHTTPResponseCacheSettings    Phase = "http_response_cache_settings"
	PhaseHTTPResponseCompression      Phase = "http_response_compression"
	PhaseHTTPResponseFirewallManaged  Phase = "http_response_firewall_managed"
	PhaseHTTPResponseHeadersTransform Phase = "http_response_headers_transform"
	PhaseMagicTransit                 Phase = "magic_transit"
	PhaseMagicTransitIDsManaged       Phase = "magic_transit_ids_managed"
	PhaseMagicTransitManaged          Phase = "magic_transit_managed"
	PhaseMagicTransitRatelimit        Phase = "magic_transit_ratelimit"
)

func (Phase) IsKnown 

func (r Phase) IsKnown() bool

type PhaseGetParams 

type PhaseGetParams struct {
	// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
	AccountID param.Field[string] `path:"account_id"`
	// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
	ZoneID param.Field[string] `path:"zone_id"`
}

type PhaseGetResponse 

type PhaseGetResponse struct {
	// The unique ID of the ruleset.
	ID string `json:"id" api:"required"`
	// The kind of the ruleset.
	Kind Kind `json:"kind" api:"required"`
	// The timestamp of when the ruleset was last modified.
	LastUpdated time.Time `json:"last_updated" api:"required" format:"date-time"`
	// The human-readable name of the ruleset.
	Name string `json:"name" api:"required"`
	// The phase of the ruleset.
	Phase Phase `json:"phase" api:"required"`
	// The list of rules in the ruleset.
	Rules []PhaseGetResponseRule `json:"rules" api:"required"`
	// The version of the ruleset.
	Version string `json:"version" api:"required"`
	// An informative description of the ruleset.
	Description string               `json:"description"`
	JSON        phaseGetResponseJSON `json:"-"`
}

A ruleset object.

func (*PhaseGetResponse) UnmarshalJSON 

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

type PhaseGetResponseEnvelope 

type PhaseGetResponseEnvelope struct {
	// A list of error messages.
	Errors []PhaseGetResponseEnvelopeErrors `json:"errors" api:"required"`
	// A list of warning messages.
	Messages []PhaseGetResponseEnvelopeMessages `json:"messages" api:"required"`
	// A ruleset object.
	Result PhaseGetResponse `json:"result" api:"required"`
	// Whether the API call was successful.
	Success PhaseGetResponseEnvelopeSuccess `json:"success" api:"required"`
	JSON    phaseGetResponseEnvelopeJSON    `json:"-"`
}

A response object.

func (*PhaseGetResponseEnvelope) UnmarshalJSON 

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

type PhaseGetResponseEnvelopeErrors 

type PhaseGetResponseEnvelopeErrors struct {
	// A text description of this message.
	Message string `json:"message" api:"required"`
	// A unique code for this message.
	Code int64 `json:"code"`
	// The source of this message.
	Source PhaseGetResponseEnvelopeErrorsSource `json:"source"`
	JSON   phaseGetResponseEnvelopeErrorsJSON   `json:"-"`
}

A message.

func (*PhaseGetResponseEnvelopeErrors) UnmarshalJSON 

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

type PhaseGetResponseEnvelopeErrorsSource 

type PhaseGetResponseEnvelopeErrorsSource struct {
	// A JSON pointer to the field that is the source of the message.
	Pointer string                                   `json:"pointer" api:"required"`
	JSON    phaseGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}

The source of this message.

func (*PhaseGetResponseEnvelopeErrorsSource) UnmarshalJSON 

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

type PhaseGetResponseEnvelopeMessages 

type PhaseGetResponseEnvelopeMessages struct {
	// A text description of this message.
	Message string `json:"message" api:"required"`
	// A unique code for this message.
	Code int64 `json:"code"`
	// The source of this message.
	Source PhaseGetResponseEnvelopeMessagesSource `json:"source"`
	JSON   phaseGetResponseEnvelopeMessagesJSON   `json:"-"`
}

A message.

func (*PhaseGetResponseEnvelopeMessages) UnmarshalJSON 

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

type PhaseGetResponseEnvelopeMessagesSource 

type PhaseGetResponseEnvelopeMessagesSource struct {
	// A JSON pointer to the field that is the source of the message.
	Pointer string                                     `json:"pointer" api:"required"`
	JSON    phaseGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}

The source of this message.

func (*PhaseGetResponseEnvelopeMessagesSource) UnmarshalJSON 

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

type PhaseGetResponseEnvelopeSuccess 

type PhaseGetResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	PhaseGetResponseEnvelopeSuccessTrue PhaseGetResponseEnvelopeSuccess = true
)

func (PhaseGetResponseEnvelopeSuccess) IsKnown 

func (r PhaseGetResponseEnvelopeSuccess) IsKnown() bool

type PhaseGetResponseRule 

type PhaseGetResponseRule struct {
	// The timestamp of when the rule was last modified.
	LastUpdated time.Time `json:"last_updated" api:"required" format:"date-time"`
	// The version of the rule.
	Version string `json:"version" api:"required"`
	// The unique ID of the rule.
	ID string `json:"id"`
	// The action to perform when the rule matches.
	Action PhaseGetResponseRulesAction `json:"action"`
	// This field can have the runtime type of [BlockRuleActionParameters],
	// [interface{}], [CompressResponseRuleActionParameters],
	// [ExecuteRuleActionParameters], [LogCustomFieldRuleActionParameters],
	// [RedirectRuleActionParameters], [RewriteRuleActionParameters],
	// [RouteRuleActionParameters], [ScoreRuleActionParameters],
	// [ServeErrorRuleActionParameters],
	// [PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParameters],
	// [SetCacheSettingsRuleActionParameters],
	// [PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParameters],
	// [SetConfigRuleActionParameters], [SkipRuleActionParameters].
	ActionParameters interface{} `json:"action_parameters"`
	// This field can have the runtime type of [[]string].
	Categories interface{} `json:"categories"`
	// An informative description of the rule.
	Description string `json:"description"`
	// Whether the rule should be executed.
	Enabled bool `json:"enabled"`
	// This field can have the runtime type of [BlockRuleExposedCredentialCheck],
	// [PhaseGetResponseRulesRulesetsChallengeRuleExposedCredentialCheck],
	// [CompressResponseRuleExposedCredentialCheck],
	// [DDoSDynamicRuleExposedCredentialCheck], [ExecuteRuleExposedCredentialCheck],
	// [ForceConnectionCloseRuleExposedCredentialCheck],
	// [PhaseGetResponseRulesRulesetsJSChallengeRuleExposedCredentialCheck],
	// [LogRuleExposedCredentialCheck], [LogCustomFieldRuleExposedCredentialCheck],
	// [ManagedChallengeRuleExposedCredentialCheck],
	// [RedirectRuleExposedCredentialCheck], [RewriteRuleExposedCredentialCheck],
	// [RouteRuleExposedCredentialCheck], [ScoreRuleExposedCredentialCheck],
	// [ServeErrorRuleExposedCredentialCheck],
	// [PhaseGetResponseRulesRulesetsSetCacheControlRuleExposedCredentialCheck],
	// [SetCacheSettingsRuleExposedCredentialCheck],
	// [PhaseGetResponseRulesRulesetsSetCacheTagsRuleExposedCredentialCheck],
	// [SetConfigRuleExposedCredentialCheck], [SkipRuleExposedCredentialCheck].
	ExposedCredentialCheck interface{} `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression string `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging Logging `json:"logging"`
	// This field can have the runtime type of [BlockRuleRatelimit],
	// [PhaseGetResponseRulesRulesetsChallengeRuleRatelimit],
	// [CompressResponseRuleRatelimit], [DDoSDynamicRuleRatelimit],
	// [ExecuteRuleRatelimit], [ForceConnectionCloseRuleRatelimit],
	// [PhaseGetResponseRulesRulesetsJSChallengeRuleRatelimit], [LogRuleRatelimit],
	// [LogCustomFieldRuleRatelimit], [ManagedChallengeRuleRatelimit],
	// [RedirectRuleRatelimit], [RewriteRuleRatelimit], [RouteRuleRatelimit],
	// [ScoreRuleRatelimit], [ServeErrorRuleRatelimit],
	// [PhaseGetResponseRulesRulesetsSetCacheControlRuleRatelimit],
	// [SetCacheSettingsRuleRatelimit],
	// [PhaseGetResponseRulesRulesetsSetCacheTagsRuleRatelimit],
	// [SetConfigRuleRatelimit], [SkipRuleRatelimit].
	Ratelimit interface{} `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                   `json:"ref"`
	JSON phaseGetResponseRuleJSON `json:"-"`
	// contains filtered or unexported fields
}

func (PhaseGetResponseRule) AsUnion 

func (r PhaseGetResponseRule) AsUnion() PhaseGetResponseRulesUnion

AsUnion returns a PhaseGetResponseRulesUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are BlockRule, PhaseGetResponseRulesRulesetsChallengeRule, CompressResponseRule, DDoSDynamicRule, ExecuteRule, ForceConnectionCloseRule, PhaseGetResponseRulesRulesetsJSChallengeRule, LogRule, LogCustomFieldRule, ManagedChallengeRule, RedirectRule, RewriteRule, RouteRule, ScoreRule, ServeErrorRule, PhaseGetResponseRulesRulesetsSetCacheControlRule, SetCacheSettingsRule, PhaseGetResponseRulesRulesetsSetCacheTagsRule, SetConfigRule, SkipRule.

func (*PhaseGetResponseRule) UnmarshalJSON 

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

type PhaseGetResponseRulesAction 

type PhaseGetResponseRulesAction string

The action to perform when the rule matches. 

const (
	PhaseGetResponseRulesActionBlock                PhaseGetResponseRulesAction = "block"
	PhaseGetResponseRulesActionChallenge            PhaseGetResponseRulesAction = "challenge"
	PhaseGetResponseRulesActionCompressResponse     PhaseGetResponseRulesAction = "compress_response"
	PhaseGetResponseRulesActionDDoSDynamic          PhaseGetResponseRulesAction = "ddos_dynamic"
	PhaseGetResponseRulesActionExecute              PhaseGetResponseRulesAction = "execute"
	PhaseGetResponseRulesActionForceConnectionClose PhaseGetResponseRulesAction = "force_connection_close"
	PhaseGetResponseRulesActionJSChallenge          PhaseGetResponseRulesAction = "js_challenge"
	PhaseGetResponseRulesActionLog                  PhaseGetResponseRulesAction = "log"
	PhaseGetResponseRulesActionLogCustomField       PhaseGetResponseRulesAction = "log_custom_field"
	PhaseGetResponseRulesActionManagedChallenge     PhaseGetResponseRulesAction = "managed_challenge"
	PhaseGetResponseRulesActionRedirect             PhaseGetResponseRulesAction = "redirect"
	PhaseGetResponseRulesActionRewrite              PhaseGetResponseRulesAction = "rewrite"
	PhaseGetResponseRulesActionRoute                PhaseGetResponseRulesAction = "route"
	PhaseGetResponseRulesActionScore                PhaseGetResponseRulesAction = "score"
	PhaseGetResponseRulesActionServeError           PhaseGetResponseRulesAction = "serve_error"
	PhaseGetResponseRulesActionSetCacheControl      PhaseGetResponseRulesAction = "set_cache_control"
	PhaseGetResponseRulesActionSetCacheSettings     PhaseGetResponseRulesAction = "set_cache_settings"
	PhaseGetResponseRulesActionSetCacheTags         PhaseGetResponseRulesAction = "set_cache_tags"
	PhaseGetResponseRulesActionSetConfig            PhaseGetResponseRulesAction = "set_config"
	PhaseGetResponseRulesActionSkip                 PhaseGetResponseRulesAction = "skip"
)

func (PhaseGetResponseRulesAction) IsKnown 

func (r PhaseGetResponseRulesAction) IsKnown() bool

type PhaseGetResponseRulesRulesetsChallengeRule 

type PhaseGetResponseRulesRulesetsChallengeRule struct {
	// The timestamp of when the rule was last modified.
	LastUpdated time.Time `json:"last_updated" api:"required" format:"date-time"`
	// The version of the rule.
	Version string `json:"version" api:"required"`
	// The unique ID of the rule.
	ID string `json:"id"`
	// The action to perform when the rule matches.
	Action PhaseGetResponseRulesRulesetsChallengeRuleAction `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters interface{} `json:"action_parameters"`
	// The categories of the rule.
	Categories []string `json:"categories"`
	// An informative description of the rule.
	Description string `json:"description"`
	// Whether the rule should be executed.
	Enabled bool `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck PhaseGetResponseRulesRulesetsChallengeRuleExposedCredentialCheck `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression string `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging Logging `json:"logging"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit PhaseGetResponseRulesRulesetsChallengeRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                                         `json:"ref"`
	JSON phaseGetResponseRulesRulesetsChallengeRuleJSON `json:"-"`
}

func (*PhaseGetResponseRulesRulesetsChallengeRule) UnmarshalJSON 

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

type PhaseGetResponseRulesRulesetsChallengeRuleAction 

type PhaseGetResponseRulesRulesetsChallengeRuleAction string

The action to perform when the rule matches. 

const (
	PhaseGetResponseRulesRulesetsChallengeRuleActionChallenge PhaseGetResponseRulesRulesetsChallengeRuleAction = "challenge"
)

func (PhaseGetResponseRulesRulesetsChallengeRuleAction) IsKnown 

func (r PhaseGetResponseRulesRulesetsChallengeRuleAction) IsKnown() bool

type PhaseGetResponseRulesRulesetsChallengeRuleExposedCredentialCheck 

type PhaseGetResponseRulesRulesetsChallengeRuleExposedCredentialCheck struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression string `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression string                                                               `json:"username_expression" api:"required"`
	JSON               phaseGetResponseRulesRulesetsChallengeRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*PhaseGetResponseRulesRulesetsChallengeRuleExposedCredentialCheck) UnmarshalJSON 

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

type PhaseGetResponseRulesRulesetsChallengeRuleRatelimit 

type PhaseGetResponseRulesRulesetsChallengeRuleRatelimit struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics []string `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period int64 `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression string `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout int64 `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod int64 `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin bool `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod int64 `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName string                                                  `json:"score_response_header_name"`
	JSON                    phaseGetResponseRulesRulesetsChallengeRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*PhaseGetResponseRulesRulesetsChallengeRuleRatelimit) UnmarshalJSON 

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

type PhaseGetResponseRulesRulesetsJSChallengeRule 

type PhaseGetResponseRulesRulesetsJSChallengeRule struct {
	// The timestamp of when the rule was last modified.
	LastUpdated time.Time `json:"last_updated" api:"required" format:"date-time"`
	// The version of the rule.
	Version string `json:"version" api:"required"`
	// The unique ID of the rule.
	ID string `json:"id"`
	// The action to perform when the rule matches.
	Action PhaseGetResponseRulesRulesetsJSChallengeRuleAction `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters interface{} `json:"action_parameters"`
	// The categories of the rule.
	Categories []string `json:"categories"`
	// An informative description of the rule.
	Description string `json:"description"`
	// Whether the rule should be executed.
	Enabled bool `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck PhaseGetResponseRulesRulesetsJSChallengeRuleExposedCredentialCheck `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression string `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging Logging `json:"logging"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit PhaseGetResponseRulesRulesetsJSChallengeRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                                           `json:"ref"`
	JSON phaseGetResponseRulesRulesetsJSChallengeRuleJSON `json:"-"`
}

func (*PhaseGetResponseRulesRulesetsJSChallengeRule) UnmarshalJSON 

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

type PhaseGetResponseRulesRulesetsJSChallengeRuleAction 

type PhaseGetResponseRulesRulesetsJSChallengeRuleAction string

The action to perform when the rule matches. 

const (
	PhaseGetResponseRulesRulesetsJSChallengeRuleActionJSChallenge PhaseGetResponseRulesRulesetsJSChallengeRuleAction = "js_challenge"
)

func (PhaseGetResponseRulesRulesetsJSChallengeRuleAction) IsKnown 

func (r PhaseGetResponseRulesRulesetsJSChallengeRuleAction) IsKnown() bool

type PhaseGetResponseRulesRulesetsJSChallengeRuleExposedCredentialCheck 

type PhaseGetResponseRulesRulesetsJSChallengeRuleExposedCredentialCheck struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression string `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression string                                                                 `json:"username_expression" api:"required"`
	JSON               phaseGetResponseRulesRulesetsJSChallengeRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*PhaseGetResponseRulesRulesetsJSChallengeRuleExposedCredentialCheck) UnmarshalJSON 

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

type PhaseGetResponseRulesRulesetsJSChallengeRuleRatelimit 

type PhaseGetResponseRulesRulesetsJSChallengeRuleRatelimit struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics []string `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period int64 `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression string `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout int64 `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod int64 `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin bool `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod int64 `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName string                                                    `json:"score_response_header_name"`
	JSON                    phaseGetResponseRulesRulesetsJSChallengeRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*PhaseGetResponseRulesRulesetsJSChallengeRuleRatelimit) UnmarshalJSON 

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

type PhaseGetResponseRulesRulesetsSetCacheControlRule added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRule struct {
	// The timestamp of when the rule was last modified.
	LastUpdated time.Time `json:"last_updated" api:"required" format:"date-time"`
	// The version of the rule.
	Version string `json:"version" api:"required"`
	// The unique ID of the rule.
	ID string `json:"id"`
	// The action to perform when the rule matches.
	Action PhaseGetResponseRulesRulesetsSetCacheControlRuleAction `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParameters `json:"action_parameters"`
	// The categories of the rule.
	Categories []string `json:"categories"`
	// An informative description of the rule.
	Description string `json:"description"`
	// Whether the rule should be executed.
	Enabled bool `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck PhaseGetResponseRulesRulesetsSetCacheControlRuleExposedCredentialCheck `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression string `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging Logging `json:"logging"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit PhaseGetResponseRulesRulesetsSetCacheControlRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                                               `json:"ref"`
	JSON phaseGetResponseRulesRulesetsSetCacheControlRuleJSON `json:"-"`
}

func (*PhaseGetResponseRulesRulesetsSetCacheControlRule) UnmarshalJSON added in v6.9.0 

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

type PhaseGetResponseRulesRulesetsSetCacheControlRuleAction added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleAction string

The action to perform when the rule matches. 

const (
	PhaseGetResponseRulesRulesetsSetCacheControlRuleActionSetCacheControl PhaseGetResponseRulesRulesetsSetCacheControlRuleAction = "set_cache_control"
)

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleAction) IsKnown added in v6.9.0 

func (r PhaseGetResponseRulesRulesetsSetCacheControlRuleAction) IsKnown() bool

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParameters added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParameters struct {
	// A cache-control directive configuration.
	Immutable PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutable `json:"immutable"`
	// A cache-control directive configuration that accepts a duration value in
	// seconds.
	MaxAge PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAge `json:"max-age"`
	// A cache-control directive configuration.
	MustRevalidate PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate `json:"must-revalidate"`
	// A cache-control directive configuration.
	MustUnderstand PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand `json:"must-understand"`
	// A cache-control directive configuration that accepts optional qualifiers (header
	// names).
	NoCache PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCache `json:"no-cache"`
	// A cache-control directive configuration.
	NoStore PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStore `json:"no-store"`
	// A cache-control directive configuration.
	NoTransform PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransform `json:"no-transform"`
	// A cache-control directive configuration that accepts optional qualifiers (header
	// names).
	Private PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivate `json:"private"`
	// A cache-control directive configuration.
	ProxyRevalidate PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate `json:"proxy-revalidate"`
	// A cache-control directive configuration.
	Public PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublic `json:"public"`
	// A cache-control directive configuration that accepts a duration value in
	// seconds.
	SMaxage PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxage `json:"s-maxage"`
	// A cache-control directive configuration that accepts a duration value in
	// seconds.
	StaleIfError PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfError `json:"stale-if-error"`
	// A cache-control directive configuration that accepts a duration value in
	// seconds.
	StaleWhileRevalidate PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate `json:"stale-while-revalidate"`
	JSON                 phaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersJSON                 `json:"-"`
}

The parameters configuring the rule's action.

func (*PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParameters) UnmarshalJSON added in v6.9.0 

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

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutable added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutable struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                          `json:"cloudflare_only"`
	JSON           phaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration.

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutable) AsUnion added in v6.9.0 

func (r PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutable) AsUnion() PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableUnion

AsUnion returns a PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective, PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective.

func (*PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutable) UnmarshalJSON added in v6.9.0 

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

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperationSet    PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation = "set"
	PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperationRemove PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation = "remove"
)

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation) IsKnown added in v6.9.0 

func (r PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation) IsKnown() bool

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                         `json:"cloudflare_only"`
	JSON           phaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective) UnmarshalJSON added in v6.9.0 

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

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperationSet    PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation = "set"
	PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperationRemove PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation = "remove"
)

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation) IsKnown() bool

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                      `json:"cloudflare_only"`
	JSON           phaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveJSON `json:"-"`
}

Set the directive.

func (*PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective) UnmarshalJSON added in v6.9.0 

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

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperationSet    PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation = "set"
	PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperationRemove PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation = "remove"
)

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation) IsKnown() bool

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableUnion added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Union satisfied by PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective or PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective.

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAge added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAge struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool `json:"cloudflare_only"`
	// The duration value in seconds for the directive.
	Value int64                                                                      `json:"value"`
	JSON  phaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration that accepts a duration value in seconds.

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAge) AsUnion added in v6.9.0 

func (r PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAge) AsUnion() PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeUnion

AsUnion returns a PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective, PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective.

func (*PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAge) UnmarshalJSON added in v6.9.0 

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

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperationSet    PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation = "set"
	PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperationRemove PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation = "remove"
)

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation) IsKnown added in v6.9.0 

func (r PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation) IsKnown() bool

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                      `json:"cloudflare_only"`
	JSON           phaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective) UnmarshalJSON added in v6.9.0 

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

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperationSet    PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation = "set"
	PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperationRemove PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation = "remove"
)

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation) IsKnown() bool

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation `json:"operation" api:"required"`
	// The duration value in seconds for the directive.
	Value int64 `json:"value" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                   `json:"cloudflare_only"`
	JSON           phaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveJSON `json:"-"`
}

Set the directive with a duration value in seconds.

func (*PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective) UnmarshalJSON added in v6.9.0 

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

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperationSet    PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation = "set"
	PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperationRemove PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation = "remove"
)

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation) IsKnown() bool

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeUnion added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts a duration value in seconds.

Union satisfied by PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective or PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective.

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                               `json:"cloudflare_only"`
	JSON           phaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration.

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate) AsUnion added in v6.9.0 

func (r PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate) AsUnion() PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateUnion

AsUnion returns a PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective, PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective.

func (*PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate) UnmarshalJSON added in v6.9.0 

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

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperationSet    PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation = "set"
	PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperationRemove PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation = "remove"
)

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation) IsKnown added in v6.9.0 

func (r PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation) IsKnown() bool

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                              `json:"cloudflare_only"`
	JSON           phaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective) UnmarshalJSON added in v6.9.0 

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

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperationSet    PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation = "set"
	PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperationRemove PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation = "remove"
)

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation) IsKnown() bool

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                           `json:"cloudflare_only"`
	JSON           phaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveJSON `json:"-"`
}

Set the directive.

func (*PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective) UnmarshalJSON added in v6.9.0 

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

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperationSet    PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation = "set"
	PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperationRemove PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation = "remove"
)

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation) IsKnown() bool

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateUnion added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Union satisfied by PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective or PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective.

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                               `json:"cloudflare_only"`
	JSON           phaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration.

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand) AsUnion added in v6.9.0 

func (r PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand) AsUnion() PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandUnion

AsUnion returns a PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective, PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective.

func (*PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand) UnmarshalJSON added in v6.9.0 

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

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperationSet    PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation = "set"
	PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperationRemove PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation = "remove"
)

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation) IsKnown added in v6.9.0 

func (r PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation) IsKnown() bool

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                              `json:"cloudflare_only"`
	JSON           phaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective) UnmarshalJSON added in v6.9.0 

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

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperationSet    PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation = "set"
	PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperationRemove PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation = "remove"
)

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation) IsKnown() bool

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                           `json:"cloudflare_only"`
	JSON           phaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveJSON `json:"-"`
}

Set the directive.

func (*PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective) UnmarshalJSON added in v6.9.0 

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

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperationSet    PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation = "set"
	PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperationRemove PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation = "remove"
)

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation) IsKnown() bool

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandUnion added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Union satisfied by PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective or PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective.

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCache added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCache struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool `json:"cloudflare_only"`
	// This field can have the runtime type of [[]string].
	Qualifiers interface{}                                                                 `json:"qualifiers"`
	JSON       phaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration that accepts optional qualifiers (header names).

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCache) AsUnion added in v6.9.0 

func (r PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCache) AsUnion() PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheUnion

AsUnion returns a PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective, PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective.

func (*PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCache) UnmarshalJSON added in v6.9.0 

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

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperationSet    PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation = "set"
	PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperationRemove PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation = "remove"
)

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation) IsKnown added in v6.9.0 

func (r PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation) IsKnown() bool

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                       `json:"cloudflare_only"`
	JSON           phaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective) UnmarshalJSON added in v6.9.0 

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

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperationSet    PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation = "set"
	PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperationRemove PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation = "remove"
)

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation) IsKnown() bool

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool `json:"cloudflare_only"`
	// Optional list of header names to qualify the directive (e.g., for "private" or
	// "no-cache" directives).
	Qualifiers []string                                                                                `json:"qualifiers"`
	JSON       phaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveJSON `json:"-"`
}

Set the directive with optional qualifiers.

func (*PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective) UnmarshalJSON added in v6.9.0 

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

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperationSet    PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation = "set"
	PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperationRemove PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation = "remove"
)

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation) IsKnown() bool

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheUnion added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts optional qualifiers (header names).

Union satisfied by PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective or PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective.

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStore added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStore struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                        `json:"cloudflare_only"`
	JSON           phaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration.

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStore) AsUnion added in v6.9.0 

func (r PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStore) AsUnion() PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreUnion

AsUnion returns a PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective, PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective.

func (*PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStore) UnmarshalJSON added in v6.9.0 

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

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperationSet    PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation = "set"
	PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperationRemove PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation = "remove"
)

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation) IsKnown added in v6.9.0 

func (r PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation) IsKnown() bool

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                       `json:"cloudflare_only"`
	JSON           phaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective) UnmarshalJSON added in v6.9.0 

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

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperationSet    PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation = "set"
	PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperationRemove PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation = "remove"
)

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation) IsKnown() bool

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                    `json:"cloudflare_only"`
	JSON           phaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveJSON `json:"-"`
}

Set the directive.

func (*PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective) UnmarshalJSON added in v6.9.0 

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

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperationSet    PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation = "set"
	PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperationRemove PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation = "remove"
)

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation) IsKnown() bool

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreUnion added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Union satisfied by PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective or PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective.

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransform added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransform struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                            `json:"cloudflare_only"`
	JSON           phaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration.

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransform) AsUnion added in v6.9.0 

func (r PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransform) AsUnion() PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformUnion

AsUnion returns a PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective, PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective.

func (*PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransform) UnmarshalJSON added in v6.9.0 

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

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperationSet    PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation = "set"
	PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperationRemove PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation = "remove"
)

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation) IsKnown added in v6.9.0 

func (r PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation) IsKnown() bool

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                           `json:"cloudflare_only"`
	JSON           phaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective) UnmarshalJSON added in v6.9.0 

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

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperationSet    PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation = "set"
	PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperationRemove PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation = "remove"
)

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation) IsKnown() bool

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                        `json:"cloudflare_only"`
	JSON           phaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveJSON `json:"-"`
}

Set the directive.

func (*PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective) UnmarshalJSON added in v6.9.0 

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

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperationSet    PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation = "set"
	PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperationRemove PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation = "remove"
)

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation) IsKnown() bool

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformUnion added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Union satisfied by PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective or PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective.

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivate added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivate struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool `json:"cloudflare_only"`
	// This field can have the runtime type of [[]string].
	Qualifiers interface{}                                                                 `json:"qualifiers"`
	JSON       phaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration that accepts optional qualifiers (header names).

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivate) AsUnion added in v6.9.0 

func (r PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivate) AsUnion() PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateUnion

AsUnion returns a PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective, PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective.

func (*PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivate) UnmarshalJSON added in v6.9.0 

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

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperationSet    PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation = "set"
	PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperationRemove PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation = "remove"
)

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation) IsKnown added in v6.9.0 

func (r PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation) IsKnown() bool

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                       `json:"cloudflare_only"`
	JSON           phaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective) UnmarshalJSON added in v6.9.0 

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

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperationSet    PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation = "set"
	PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperationRemove PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation = "remove"
)

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation) IsKnown() bool

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool `json:"cloudflare_only"`
	// Optional list of header names to qualify the directive (e.g., for "private" or
	// "no-cache" directives).
	Qualifiers []string                                                                                `json:"qualifiers"`
	JSON       phaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveJSON `json:"-"`
}

Set the directive with optional qualifiers.

func (*PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective) UnmarshalJSON added in v6.9.0 

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

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperationSet    PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation = "set"
	PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperationRemove PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation = "remove"
)

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation) IsKnown() bool

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateUnion added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts optional qualifiers (header names).

Union satisfied by PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective or PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective.

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                `json:"cloudflare_only"`
	JSON           phaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration.

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate) AsUnion added in v6.9.0 

func (r PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate) AsUnion() PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateUnion

AsUnion returns a PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective, PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective.

func (*PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate) UnmarshalJSON added in v6.9.0 

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

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperationSet    PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation = "set"
	PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperationRemove PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation = "remove"
)

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation) IsKnown added in v6.9.0 

func (r PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation) IsKnown() bool

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                               `json:"cloudflare_only"`
	JSON           phaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective) UnmarshalJSON added in v6.9.0 

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

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperationSet    PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation = "set"
	PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperationRemove PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation = "remove"
)

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation) IsKnown() bool

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                            `json:"cloudflare_only"`
	JSON           phaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveJSON `json:"-"`
}

Set the directive.

func (*PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective) UnmarshalJSON added in v6.9.0 

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

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperationSet    PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation = "set"
	PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperationRemove PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation = "remove"
)

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation) IsKnown() bool

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateUnion added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Union satisfied by PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective or PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective.

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublic added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublic struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                       `json:"cloudflare_only"`
	JSON           phaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration.

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublic) AsUnion added in v6.9.0 

func (r PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublic) AsUnion() PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicUnion

AsUnion returns a PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective, PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective.

func (*PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublic) UnmarshalJSON added in v6.9.0 

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

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperationSet    PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation = "set"
	PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperationRemove PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation = "remove"
)

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation) IsKnown added in v6.9.0 

func (r PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation) IsKnown() bool

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                      `json:"cloudflare_only"`
	JSON           phaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective) UnmarshalJSON added in v6.9.0 

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

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperationSet    PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation = "set"
	PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperationRemove PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation = "remove"
)

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation) IsKnown() bool

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                   `json:"cloudflare_only"`
	JSON           phaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveJSON `json:"-"`
}

Set the directive.

func (*PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective) UnmarshalJSON added in v6.9.0 

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

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperationSet    PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation = "set"
	PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperationRemove PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation = "remove"
)

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation) IsKnown() bool

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicUnion added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Union satisfied by PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective or PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective.

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxage added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxage struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool `json:"cloudflare_only"`
	// The duration value in seconds for the directive.
	Value int64                                                                       `json:"value"`
	JSON  phaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration that accepts a duration value in seconds.

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxage) AsUnion added in v6.9.0 

func (r PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxage) AsUnion() PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageUnion

AsUnion returns a PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective, PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective.

func (*PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxage) UnmarshalJSON added in v6.9.0 

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

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperationSet    PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation = "set"
	PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperationRemove PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation = "remove"
)

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation) IsKnown added in v6.9.0 

func (r PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation) IsKnown() bool

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                       `json:"cloudflare_only"`
	JSON           phaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective) UnmarshalJSON added in v6.9.0 

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

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperationSet    PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation = "set"
	PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperationRemove PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation = "remove"
)

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation) IsKnown() bool

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation `json:"operation" api:"required"`
	// The duration value in seconds for the directive.
	Value int64 `json:"value" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                    `json:"cloudflare_only"`
	JSON           phaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveJSON `json:"-"`
}

Set the directive with a duration value in seconds.

func (*PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective) UnmarshalJSON added in v6.9.0 

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

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperationSet    PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation = "set"
	PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperationRemove PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation = "remove"
)

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation) IsKnown() bool

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageUnion added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts a duration value in seconds.

Union satisfied by PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective or PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective.

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfError added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfError struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool `json:"cloudflare_only"`
	// The duration value in seconds for the directive.
	Value int64                                                                            `json:"value"`
	JSON  phaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration that accepts a duration value in seconds.

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfError) AsUnion added in v6.9.0 

func (r PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfError) AsUnion() PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorUnion

AsUnion returns a PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective, PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective.

func (*PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfError) UnmarshalJSON added in v6.9.0 

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

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperationSet    PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation = "set"
	PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperationRemove PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation = "remove"
)

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation) IsKnown added in v6.9.0 

func (r PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation) IsKnown() bool

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                            `json:"cloudflare_only"`
	JSON           phaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective) UnmarshalJSON added in v6.9.0 

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

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperationSet    PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation = "set"
	PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperationRemove PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation = "remove"
)

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation) IsKnown() bool

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation `json:"operation" api:"required"`
	// The duration value in seconds for the directive.
	Value int64 `json:"value" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                         `json:"cloudflare_only"`
	JSON           phaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveJSON `json:"-"`
}

Set the directive with a duration value in seconds.

func (*PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective) UnmarshalJSON added in v6.9.0 

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

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperationSet    PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation = "set"
	PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperationRemove PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation = "remove"
)

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation) IsKnown() bool

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorUnion added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts a duration value in seconds.

Union satisfied by PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective or PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective.

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool `json:"cloudflare_only"`
	// The duration value in seconds for the directive.
	Value int64                                                                                    `json:"value"`
	JSON  phaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration that accepts a duration value in seconds.

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate) AsUnion added in v6.9.0 

func (r PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate) AsUnion() PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateUnion

AsUnion returns a PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective, PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective.

func (*PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate) UnmarshalJSON added in v6.9.0 

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

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperationSet    PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation = "set"
	PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperationRemove PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation = "remove"
)

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation) IsKnown added in v6.9.0 

func (r PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation) IsKnown() bool

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                                    `json:"cloudflare_only"`
	JSON           phaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective) UnmarshalJSON added in v6.9.0 

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

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperationSet    PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation = "set"
	PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperationRemove PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation = "remove"
)

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation) IsKnown() bool

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation `json:"operation" api:"required"`
	// The duration value in seconds for the directive.
	Value int64 `json:"value" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                                 `json:"cloudflare_only"`
	JSON           phaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveJSON `json:"-"`
}

Set the directive with a duration value in seconds.

func (*PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective) UnmarshalJSON added in v6.9.0 

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

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperationSet    PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation = "set"
	PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperationRemove PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation = "remove"
)

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation) IsKnown() bool

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateUnion added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts a duration value in seconds.

Union satisfied by PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective or PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective.

type PhaseGetResponseRulesRulesetsSetCacheControlRuleExposedCredentialCheck added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleExposedCredentialCheck struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression string `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression string                                                                     `json:"username_expression" api:"required"`
	JSON               phaseGetResponseRulesRulesetsSetCacheControlRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*PhaseGetResponseRulesRulesetsSetCacheControlRuleExposedCredentialCheck) UnmarshalJSON added in v6.9.0 

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

type PhaseGetResponseRulesRulesetsSetCacheControlRuleRatelimit added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheControlRuleRatelimit struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics []string `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period int64 `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression string `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout int64 `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod int64 `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin bool `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod int64 `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName string                                                        `json:"score_response_header_name"`
	JSON                    phaseGetResponseRulesRulesetsSetCacheControlRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*PhaseGetResponseRulesRulesetsSetCacheControlRuleRatelimit) UnmarshalJSON added in v6.9.0 

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

type PhaseGetResponseRulesRulesetsSetCacheTagsRule added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheTagsRule struct {
	// The timestamp of when the rule was last modified.
	LastUpdated time.Time `json:"last_updated" api:"required" format:"date-time"`
	// The version of the rule.
	Version string `json:"version" api:"required"`
	// The unique ID of the rule.
	ID string `json:"id"`
	// The action to perform when the rule matches.
	Action PhaseGetResponseRulesRulesetsSetCacheTagsRuleAction `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParameters `json:"action_parameters"`
	// The categories of the rule.
	Categories []string `json:"categories"`
	// An informative description of the rule.
	Description string `json:"description"`
	// Whether the rule should be executed.
	Enabled bool `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck PhaseGetResponseRulesRulesetsSetCacheTagsRuleExposedCredentialCheck `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression string `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging Logging `json:"logging"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit PhaseGetResponseRulesRulesetsSetCacheTagsRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                                            `json:"ref"`
	JSON phaseGetResponseRulesRulesetsSetCacheTagsRuleJSON `json:"-"`
}

func (*PhaseGetResponseRulesRulesetsSetCacheTagsRule) UnmarshalJSON added in v6.9.0 

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

type PhaseGetResponseRulesRulesetsSetCacheTagsRuleAction added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheTagsRuleAction string

The action to perform when the rule matches. 

const (
	PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionSetCacheTags PhaseGetResponseRulesRulesetsSetCacheTagsRuleAction = "set_cache_tags"
)

func (PhaseGetResponseRulesRulesetsSetCacheTagsRuleAction) IsKnown added in v6.9.0 

func (r PhaseGetResponseRulesRulesetsSetCacheTagsRuleAction) IsKnown() bool

type PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParameters added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParameters struct {
	// The operation to perform on the cache tags.
	Operation PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation `json:"operation" api:"required"`
	// An expression that evaluates to an array of cache tag values.
	Expression string `json:"expression"`
	// This field can have the runtime type of [[]string].
	Values interface{}                                                       `json:"values"`
	JSON   phaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersJSON `json:"-"`
	// contains filtered or unexported fields
}

The parameters configuring the rule's action.

func (PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParameters) AsUnion added in v6.9.0 

func (r PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParameters) AsUnion() PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersUnion

AsUnion returns a PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues, PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression, PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues, PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression, PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues, PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression.

func (*PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParameters) UnmarshalJSON added in v6.9.0 

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

type PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression struct {
	// An expression that evaluates to an array of cache tag values.
	Expression string `json:"expression" api:"required"`
	// The operation to perform on the cache tags.
	Operation PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation `json:"operation" api:"required"`
	JSON      phaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionJSON      `json:"-"`
}

Add cache tags using an expression.

func (*PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression) UnmarshalJSON added in v6.9.0 

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

type PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation string

The operation to perform on the cache tags. 

const (
	PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationAdd    PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "add"
	PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationRemove PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "remove"
	PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationSet    PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "set"
)

func (PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation) IsKnown added in v6.9.0 

func (r PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation) IsKnown() bool

type PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues struct {
	// The operation to perform on the cache tags.
	Operation PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation `json:"operation" api:"required"`
	// A list of cache tag values.
	Values []string                                                                            `json:"values" api:"required"`
	JSON   phaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesJSON `json:"-"`
}

Add cache tags using a list of values.

func (*PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues) UnmarshalJSON added in v6.9.0 

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

type PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation string

The operation to perform on the cache tags. 

const (
	PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationAdd    PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "add"
	PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationRemove PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "remove"
	PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationSet    PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "set"
)

func (PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation) IsKnown added in v6.9.0 

func (r PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation) IsKnown() bool

type PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation string

The operation to perform on the cache tags. 

const (
	PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersOperationAdd    PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation = "add"
	PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersOperationRemove PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation = "remove"
	PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersOperationSet    PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation = "set"
)

func (PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation) IsKnown added in v6.9.0 

func (r PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation) IsKnown() bool

type PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression struct {
	// An expression that evaluates to an array of cache tag values.
	Expression string `json:"expression" api:"required"`
	// The operation to perform on the cache tags.
	Operation PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation `json:"operation" api:"required"`
	JSON      phaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionJSON      `json:"-"`
}

Remove cache tags using an expression.

func (*PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression) UnmarshalJSON added in v6.9.0 

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

type PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation string

The operation to perform on the cache tags. 

const (
	PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationAdd    PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "add"
	PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationRemove PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "remove"
	PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationSet    PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "set"
)

func (PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation) IsKnown added in v6.9.0 

func (r PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation) IsKnown() bool

type PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues struct {
	// The operation to perform on the cache tags.
	Operation PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation `json:"operation" api:"required"`
	// A list of cache tag values.
	Values []string                                                                               `json:"values" api:"required"`
	JSON   phaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesJSON `json:"-"`
}

Remove cache tags using a list of values.

func (*PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues) UnmarshalJSON added in v6.9.0 

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

type PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation string

The operation to perform on the cache tags. 

const (
	PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationAdd    PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "add"
	PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationRemove PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "remove"
	PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationSet    PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "set"
)

func (PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation) IsKnown added in v6.9.0 

func (r PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation) IsKnown() bool

type PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression struct {
	// An expression that evaluates to an array of cache tag values.
	Expression string `json:"expression" api:"required"`
	// The operation to perform on the cache tags.
	Operation PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation `json:"operation" api:"required"`
	JSON      phaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionJSON      `json:"-"`
}

Set cache tags using an expression.

func (*PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression) UnmarshalJSON added in v6.9.0 

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

type PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation string

The operation to perform on the cache tags. 

const (
	PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationAdd    PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "add"
	PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationRemove PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "remove"
	PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationSet    PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "set"
)

func (PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation) IsKnown added in v6.9.0 

func (r PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation) IsKnown() bool

type PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues struct {
	// The operation to perform on the cache tags.
	Operation PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation `json:"operation" api:"required"`
	// A list of cache tag values.
	Values []string                                                                            `json:"values" api:"required"`
	JSON   phaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesJSON `json:"-"`
}

Set cache tags using a list of values.

func (*PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues) UnmarshalJSON added in v6.9.0 

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

type PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation string

The operation to perform on the cache tags. 

const (
	PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationAdd    PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "add"
	PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationRemove PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "remove"
	PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationSet    PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "set"
)

func (PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation) IsKnown added in v6.9.0 

func (r PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation) IsKnown() bool

type PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersUnion added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersUnion interface {
	// contains filtered or unexported methods
}

The parameters configuring the rule's action.

Union satisfied by PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues, PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression, PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues, PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression, PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues or PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression.

type PhaseGetResponseRulesRulesetsSetCacheTagsRuleExposedCredentialCheck added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheTagsRuleExposedCredentialCheck struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression string `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression string                                                                  `json:"username_expression" api:"required"`
	JSON               phaseGetResponseRulesRulesetsSetCacheTagsRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*PhaseGetResponseRulesRulesetsSetCacheTagsRuleExposedCredentialCheck) UnmarshalJSON added in v6.9.0 

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

type PhaseGetResponseRulesRulesetsSetCacheTagsRuleRatelimit added in v6.9.0 

type PhaseGetResponseRulesRulesetsSetCacheTagsRuleRatelimit struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics []string `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period int64 `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression string `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout int64 `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod int64 `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin bool `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod int64 `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName string                                                     `json:"score_response_header_name"`
	JSON                    phaseGetResponseRulesRulesetsSetCacheTagsRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*PhaseGetResponseRulesRulesetsSetCacheTagsRuleRatelimit) UnmarshalJSON added in v6.9.0 

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

type PhaseGetResponseRulesUnion 

type PhaseGetResponseRulesUnion interface {
	// contains filtered or unexported methods
}

Union satisfied by BlockRule, PhaseGetResponseRulesRulesetsChallengeRule, CompressResponseRule, DDoSDynamicRule, ExecuteRule, ForceConnectionCloseRule, PhaseGetResponseRulesRulesetsJSChallengeRule, LogRule, LogCustomFieldRule, ManagedChallengeRule, RedirectRule, RewriteRule, RouteRule, ScoreRule, ServeErrorRule, PhaseGetResponseRulesRulesetsSetCacheControlRule, SetCacheSettingsRule, PhaseGetResponseRulesRulesetsSetCacheTagsRule, SetConfigRule or SkipRule.

type PhaseService 

type PhaseService struct {
	Options  []option.RequestOption
	Versions *PhaseVersionService
}

PhaseService 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 NewPhaseService method instead.

func NewPhaseService 

func NewPhaseService(opts ...option.RequestOption) (r *PhaseService)

NewPhaseService 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 (*PhaseService) Get 

func (r *PhaseService) Get(ctx context.Context, rulesetPhase Phase, query PhaseGetParams, opts ...option.RequestOption) (res *PhaseGetResponse, err error)

Fetches the latest version of the account or zone entry point ruleset for a given phase.

func (*PhaseService) Update 

func (r *PhaseService) Update(ctx context.Context, rulesetPhase Phase, params PhaseUpdateParams, opts ...option.RequestOption) (res *PhaseUpdateResponse, err error)

Updates an account or zone entry point ruleset, creating a new version.

type PhaseUpdateParams 

type PhaseUpdateParams struct {
	// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
	AccountID param.Field[string] `path:"account_id"`
	// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
	ZoneID param.Field[string] `path:"zone_id"`
	// An informative description of the ruleset.
	Description param.Field[string] `json:"description"`
	// The human-readable name of the ruleset.
	Name param.Field[string] `json:"name"`
	// The list of rules in the ruleset.
	Rules param.Field[[]PhaseUpdateParamsRuleUnion] `json:"rules"`
}

func (PhaseUpdateParams) MarshalJSON 

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

type PhaseUpdateParamsRule 

type PhaseUpdateParamsRule struct {
	// The unique ID of the rule.
	ID param.Field[string] `json:"id"`
	// The action to perform when the rule matches.
	Action           param.Field[PhaseUpdateParamsRulesAction] `json:"action"`
	ActionParameters param.Field[interface{}]                  `json:"action_parameters"`
	Categories       param.Field[interface{}]                  `json:"categories"`
	// An informative description of the rule.
	Description param.Field[string] `json:"description"`
	// Whether the rule should be executed.
	Enabled                param.Field[bool]        `json:"enabled"`
	ExposedCredentialCheck param.Field[interface{}] `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression param.Field[string] `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging   param.Field[LoggingParam] `json:"logging"`
	Ratelimit param.Field[interface{}]  `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref param.Field[string] `json:"ref"`
}

func (PhaseUpdateParamsRule) MarshalJSON 

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

type PhaseUpdateParamsRuleUnion 

type PhaseUpdateParamsRuleUnion interface {
	// contains filtered or unexported methods
}

Satisfied by rulesets.BlockRuleParam, rulesets.PhaseUpdateParamsRulesRulesetsChallengeRule, rulesets.CompressResponseRuleParam, rulesets.DDoSDynamicRuleParam, rulesets.ExecuteRuleParam, rulesets.ForceConnectionCloseRuleParam, rulesets.PhaseUpdateParamsRulesRulesetsJSChallengeRule, rulesets.LogRuleParam, rulesets.LogCustomFieldRuleParam, rulesets.ManagedChallengeRuleParam, rulesets.RedirectRuleParam, rulesets.RewriteRuleParam, rulesets.RouteRuleParam, rulesets.ScoreRuleParam, rulesets.ServeErrorRuleParam, rulesets.PhaseUpdateParamsRulesRulesetsSetCacheControlRule, rulesets.SetCacheSettingsRuleParam, rulesets.PhaseUpdateParamsRulesRulesetsSetCacheTagsRule, rulesets.SetConfigRuleParam, rulesets.SkipRuleParam, PhaseUpdateParamsRule.

type PhaseUpdateParamsRulesAction 

type PhaseUpdateParamsRulesAction string

The action to perform when the rule matches. 

const (
	PhaseUpdateParamsRulesActionBlock                PhaseUpdateParamsRulesAction = "block"
	PhaseUpdateParamsRulesActionChallenge            PhaseUpdateParamsRulesAction = "challenge"
	PhaseUpdateParamsRulesActionCompressResponse     PhaseUpdateParamsRulesAction = "compress_response"
	PhaseUpdateParamsRulesActionDDoSDynamic          PhaseUpdateParamsRulesAction = "ddos_dynamic"
	PhaseUpdateParamsRulesActionExecute              PhaseUpdateParamsRulesAction = "execute"
	PhaseUpdateParamsRulesActionForceConnectionClose PhaseUpdateParamsRulesAction = "force_connection_close"
	PhaseUpdateParamsRulesActionJSChallenge          PhaseUpdateParamsRulesAction = "js_challenge"
	PhaseUpdateParamsRulesActionLog                  PhaseUpdateParamsRulesAction = "log"
	PhaseUpdateParamsRulesActionLogCustomField       PhaseUpdateParamsRulesAction = "log_custom_field"
	PhaseUpdateParamsRulesActionManagedChallenge     PhaseUpdateParamsRulesAction = "managed_challenge"
	PhaseUpdateParamsRulesActionRedirect             PhaseUpdateParamsRulesAction = "redirect"
	PhaseUpdateParamsRulesActionRewrite              PhaseUpdateParamsRulesAction = "rewrite"
	PhaseUpdateParamsRulesActionRoute                PhaseUpdateParamsRulesAction = "route"
	PhaseUpdateParamsRulesActionScore                PhaseUpdateParamsRulesAction = "score"
	PhaseUpdateParamsRulesActionServeError           PhaseUpdateParamsRulesAction = "serve_error"
	PhaseUpdateParamsRulesActionSetCacheControl      PhaseUpdateParamsRulesAction = "set_cache_control"
	PhaseUpdateParamsRulesActionSetCacheSettings     PhaseUpdateParamsRulesAction = "set_cache_settings"
	PhaseUpdateParamsRulesActionSetCacheTags         PhaseUpdateParamsRulesAction = "set_cache_tags"
	PhaseUpdateParamsRulesActionSetConfig            PhaseUpdateParamsRulesAction = "set_config"
	PhaseUpdateParamsRulesActionSkip                 PhaseUpdateParamsRulesAction = "skip"
)

func (PhaseUpdateParamsRulesAction) IsKnown 

func (r PhaseUpdateParamsRulesAction) IsKnown() bool

type PhaseUpdateParamsRulesRulesetsChallengeRule 

type PhaseUpdateParamsRulesRulesetsChallengeRule struct {
	// The unique ID of the rule.
	ID param.Field[string] `json:"id"`
	// The action to perform when the rule matches.
	Action param.Field[PhaseUpdateParamsRulesRulesetsChallengeRuleAction] `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters param.Field[interface{}] `json:"action_parameters"`
	// An informative description of the rule.
	Description param.Field[string] `json:"description"`
	// Whether the rule should be executed.
	Enabled param.Field[bool] `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck param.Field[PhaseUpdateParamsRulesRulesetsChallengeRuleExposedCredentialCheck] `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression param.Field[string] `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging param.Field[LoggingParam] `json:"logging"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit param.Field[PhaseUpdateParamsRulesRulesetsChallengeRuleRatelimit] `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref param.Field[string] `json:"ref"`
}

func (PhaseUpdateParamsRulesRulesetsChallengeRule) MarshalJSON 

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

type PhaseUpdateParamsRulesRulesetsChallengeRuleAction 

type PhaseUpdateParamsRulesRulesetsChallengeRuleAction string

The action to perform when the rule matches. 

const (
	PhaseUpdateParamsRulesRulesetsChallengeRuleActionChallenge PhaseUpdateParamsRulesRulesetsChallengeRuleAction = "challenge"
)

func (PhaseUpdateParamsRulesRulesetsChallengeRuleAction) IsKnown 

func (r PhaseUpdateParamsRulesRulesetsChallengeRuleAction) IsKnown() bool

type PhaseUpdateParamsRulesRulesetsChallengeRuleExposedCredentialCheck 

type PhaseUpdateParamsRulesRulesetsChallengeRuleExposedCredentialCheck struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression param.Field[string] `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression param.Field[string] `json:"username_expression" api:"required"`
}

Configuration for exposed credential checking.

func (PhaseUpdateParamsRulesRulesetsChallengeRuleExposedCredentialCheck) MarshalJSON 

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

type PhaseUpdateParamsRulesRulesetsChallengeRuleRatelimit 

type PhaseUpdateParamsRulesRulesetsChallengeRuleRatelimit struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics param.Field[[]string] `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period param.Field[int64] `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression param.Field[string] `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout param.Field[int64] `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod param.Field[int64] `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin param.Field[bool] `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod param.Field[int64] `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName param.Field[string] `json:"score_response_header_name"`
}

An object configuring the rule's rate limit behavior.

func (PhaseUpdateParamsRulesRulesetsChallengeRuleRatelimit) MarshalJSON 

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

type PhaseUpdateParamsRulesRulesetsJSChallengeRule 

type PhaseUpdateParamsRulesRulesetsJSChallengeRule struct {
	// The unique ID of the rule.
	ID param.Field[string] `json:"id"`
	// The action to perform when the rule matches.
	Action param.Field[PhaseUpdateParamsRulesRulesetsJSChallengeRuleAction] `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters param.Field[interface{}] `json:"action_parameters"`
	// An informative description of the rule.
	Description param.Field[string] `json:"description"`
	// Whether the rule should be executed.
	Enabled param.Field[bool] `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck param.Field[PhaseUpdateParamsRulesRulesetsJSChallengeRuleExposedCredentialCheck] `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression param.Field[string] `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging param.Field[LoggingParam] `json:"logging"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit param.Field[PhaseUpdateParamsRulesRulesetsJSChallengeRuleRatelimit] `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref param.Field[string] `json:"ref"`
}

func (PhaseUpdateParamsRulesRulesetsJSChallengeRule) MarshalJSON 

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

type PhaseUpdateParamsRulesRulesetsJSChallengeRuleAction 

type PhaseUpdateParamsRulesRulesetsJSChallengeRuleAction string

The action to perform when the rule matches. 

const (
	PhaseUpdateParamsRulesRulesetsJSChallengeRuleActionJSChallenge PhaseUpdateParamsRulesRulesetsJSChallengeRuleAction = "js_challenge"
)

func (PhaseUpdateParamsRulesRulesetsJSChallengeRuleAction) IsKnown 

func (r PhaseUpdateParamsRulesRulesetsJSChallengeRuleAction) IsKnown() bool

type PhaseUpdateParamsRulesRulesetsJSChallengeRuleExposedCredentialCheck 

type PhaseUpdateParamsRulesRulesetsJSChallengeRuleExposedCredentialCheck struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression param.Field[string] `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression param.Field[string] `json:"username_expression" api:"required"`
}

Configuration for exposed credential checking.

func (PhaseUpdateParamsRulesRulesetsJSChallengeRuleExposedCredentialCheck) MarshalJSON 

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

type PhaseUpdateParamsRulesRulesetsJSChallengeRuleRatelimit 

type PhaseUpdateParamsRulesRulesetsJSChallengeRuleRatelimit struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics param.Field[[]string] `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period param.Field[int64] `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression param.Field[string] `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout param.Field[int64] `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod param.Field[int64] `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin param.Field[bool] `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod param.Field[int64] `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName param.Field[string] `json:"score_response_header_name"`
}

An object configuring the rule's rate limit behavior.

func (PhaseUpdateParamsRulesRulesetsJSChallengeRuleRatelimit) MarshalJSON 

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

type PhaseUpdateParamsRulesRulesetsSetCacheControlRule added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRule struct {
	// The unique ID of the rule.
	ID param.Field[string] `json:"id"`
	// The action to perform when the rule matches.
	Action param.Field[PhaseUpdateParamsRulesRulesetsSetCacheControlRuleAction] `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters param.Field[PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParameters] `json:"action_parameters"`
	// An informative description of the rule.
	Description param.Field[string] `json:"description"`
	// Whether the rule should be executed.
	Enabled param.Field[bool] `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck param.Field[PhaseUpdateParamsRulesRulesetsSetCacheControlRuleExposedCredentialCheck] `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression param.Field[string] `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging param.Field[LoggingParam] `json:"logging"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit param.Field[PhaseUpdateParamsRulesRulesetsSetCacheControlRuleRatelimit] `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref param.Field[string] `json:"ref"`
}

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRule) MarshalJSON added in v6.9.0 

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

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleAction added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleAction string

The action to perform when the rule matches. 

const (
	PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionSetCacheControl PhaseUpdateParamsRulesRulesetsSetCacheControlRuleAction = "set_cache_control"
)

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleAction) IsKnown added in v6.9.0 

func (r PhaseUpdateParamsRulesRulesetsSetCacheControlRuleAction) IsKnown() bool

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParameters added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParameters struct {
	// A cache-control directive configuration.
	Immutable param.Field[PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableUnion] `json:"immutable"`
	// A cache-control directive configuration that accepts a duration value in
	// seconds.
	MaxAge param.Field[PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeUnion] `json:"max-age"`
	// A cache-control directive configuration.
	MustRevalidate param.Field[PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateUnion] `json:"must-revalidate"`
	// A cache-control directive configuration.
	MustUnderstand param.Field[PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandUnion] `json:"must-understand"`
	// A cache-control directive configuration that accepts optional qualifiers (header
	// names).
	NoCache param.Field[PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheUnion] `json:"no-cache"`
	// A cache-control directive configuration.
	NoStore param.Field[PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreUnion] `json:"no-store"`
	// A cache-control directive configuration.
	NoTransform param.Field[PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformUnion] `json:"no-transform"`
	// A cache-control directive configuration that accepts optional qualifiers (header
	// names).
	Private param.Field[PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateUnion] `json:"private"`
	// A cache-control directive configuration.
	ProxyRevalidate param.Field[PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateUnion] `json:"proxy-revalidate"`
	// A cache-control directive configuration.
	Public param.Field[PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicUnion] `json:"public"`
	// A cache-control directive configuration that accepts a duration value in
	// seconds.
	SMaxage param.Field[PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageUnion] `json:"s-maxage"`
	// A cache-control directive configuration that accepts a duration value in
	// seconds.
	StaleIfError param.Field[PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorUnion] `json:"stale-if-error"`
	// A cache-control directive configuration that accepts a duration value in
	// seconds.
	StaleWhileRevalidate param.Field[PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateUnion] `json:"stale-while-revalidate"`
}

The parameters configuring the rule's action.

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParameters) MarshalJSON added in v6.9.0 

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

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutable added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutable struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

A cache-control directive configuration.

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutable) MarshalJSON added in v6.9.0 

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

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableOperationSet    PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation = "set"
	PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableOperationRemove PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation = "remove"
)

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation) IsKnown() bool

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Remove the directive.

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective) MarshalJSON added in v6.9.0 

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

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperationSet    PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation = "set"
	PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperationRemove PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation = "remove"
)

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation) IsKnown() bool

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Set the directive.

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective) MarshalJSON added in v6.9.0 

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

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperationSet    PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation = "set"
	PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperationRemove PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation = "remove"
)

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation) IsKnown() bool

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableUnion added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Satisfied by rulesets.PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective, rulesets.PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective, PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutable.

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAge added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAge struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
	// The duration value in seconds for the directive.
	Value param.Field[int64] `json:"value"`
}

A cache-control directive configuration that accepts a duration value in seconds.

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAge) MarshalJSON added in v6.9.0 

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

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperationSet    PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation = "set"
	PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperationRemove PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation = "remove"
)

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation) IsKnown() bool

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Remove the directive.

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective) MarshalJSON added in v6.9.0 

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

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperationSet    PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation = "set"
	PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperationRemove PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation = "remove"
)

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation) IsKnown() bool

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation] `json:"operation" api:"required"`
	// The duration value in seconds for the directive.
	Value param.Field[int64] `json:"value" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Set the directive with a duration value in seconds.

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective) MarshalJSON added in v6.9.0 

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

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperationSet    PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation = "set"
	PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperationRemove PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation = "remove"
)

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation) IsKnown() bool

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeUnion added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts a duration value in seconds.

Satisfied by rulesets.PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective, rulesets.PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective, PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAge.

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

A cache-control directive configuration.

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate) MarshalJSON added in v6.9.0 

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

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperationSet    PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation = "set"
	PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperationRemove PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation = "remove"
)

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation) IsKnown() bool

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Remove the directive.

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective) MarshalJSON added in v6.9.0 

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

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperationSet    PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation = "set"
	PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperationRemove PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation = "remove"
)

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation) IsKnown() bool

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Set the directive.

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective) MarshalJSON added in v6.9.0 

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

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperationSet    PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation = "set"
	PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperationRemove PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation = "remove"
)

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation) IsKnown() bool

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateUnion added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Satisfied by rulesets.PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective, rulesets.PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective, PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate.

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

A cache-control directive configuration.

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand) MarshalJSON added in v6.9.0 

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

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperationSet    PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation = "set"
	PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperationRemove PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation = "remove"
)

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation) IsKnown() bool

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Remove the directive.

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective) MarshalJSON added in v6.9.0 

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

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperationSet    PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation = "set"
	PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperationRemove PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation = "remove"
)

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation) IsKnown() bool

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Set the directive.

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective) MarshalJSON added in v6.9.0 

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

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperationSet    PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation = "set"
	PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperationRemove PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation = "remove"
)

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation) IsKnown() bool

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandUnion added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Satisfied by rulesets.PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective, rulesets.PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective, PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand.

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCache added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCache struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool]        `json:"cloudflare_only"`
	Qualifiers     param.Field[interface{}] `json:"qualifiers"`
}

A cache-control directive configuration that accepts optional qualifiers (header names).

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCache) MarshalJSON added in v6.9.0 

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

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperationSet    PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation = "set"
	PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperationRemove PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation = "remove"
)

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation) IsKnown() bool

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Remove the directive.

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective) MarshalJSON added in v6.9.0 

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

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperationSet    PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation = "set"
	PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperationRemove PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation = "remove"
)

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation) IsKnown() bool

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
	// Optional list of header names to qualify the directive (e.g., for "private" or
	// "no-cache" directives).
	Qualifiers param.Field[[]string] `json:"qualifiers"`
}

Set the directive with optional qualifiers.

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective) MarshalJSON added in v6.9.0 

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

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperationSet    PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation = "set"
	PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperationRemove PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation = "remove"
)

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation) IsKnown() bool

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheUnion added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts optional qualifiers (header names).

Satisfied by rulesets.PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective, rulesets.PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective, PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCache.

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStore added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStore struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

A cache-control directive configuration.

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStore) MarshalJSON added in v6.9.0 

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

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperationSet    PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation = "set"
	PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperationRemove PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation = "remove"
)

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation) IsKnown() bool

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Remove the directive.

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective) MarshalJSON added in v6.9.0 

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

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperationSet    PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation = "set"
	PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperationRemove PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation = "remove"
)

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation) IsKnown() bool

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Set the directive.

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective) MarshalJSON added in v6.9.0 

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

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperationSet    PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation = "set"
	PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperationRemove PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation = "remove"
)

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation) IsKnown() bool

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreUnion added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Satisfied by rulesets.PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective, rulesets.PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective, PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStore.

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransform added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransform struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

A cache-control directive configuration.

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransform) MarshalJSON added in v6.9.0 

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

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperationSet    PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation = "set"
	PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperationRemove PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation = "remove"
)

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation) IsKnown() bool

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Remove the directive.

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective) MarshalJSON added in v6.9.0 

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

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperationSet    PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation = "set"
	PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperationRemove PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation = "remove"
)

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation) IsKnown() bool

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Set the directive.

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective) MarshalJSON added in v6.9.0 

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

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperationSet    PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation = "set"
	PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperationRemove PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation = "remove"
)

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation) IsKnown() bool

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformUnion added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Satisfied by rulesets.PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective, rulesets.PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective, PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransform.

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivate added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivate struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool]        `json:"cloudflare_only"`
	Qualifiers     param.Field[interface{}] `json:"qualifiers"`
}

A cache-control directive configuration that accepts optional qualifiers (header names).

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivate) MarshalJSON added in v6.9.0 

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

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateOperationSet    PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation = "set"
	PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateOperationRemove PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation = "remove"
)

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation) IsKnown() bool

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Remove the directive.

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective) MarshalJSON added in v6.9.0 

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

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperationSet    PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation = "set"
	PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperationRemove PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation = "remove"
)

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation) IsKnown() bool

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
	// Optional list of header names to qualify the directive (e.g., for "private" or
	// "no-cache" directives).
	Qualifiers param.Field[[]string] `json:"qualifiers"`
}

Set the directive with optional qualifiers.

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective) MarshalJSON added in v6.9.0 

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

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperationSet    PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation = "set"
	PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperationRemove PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation = "remove"
)

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation) IsKnown() bool

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateUnion added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts optional qualifiers (header names).

Satisfied by rulesets.PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective, rulesets.PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective, PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivate.

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

A cache-control directive configuration.

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate) MarshalJSON added in v6.9.0 

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

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperationSet    PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation = "set"
	PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperationRemove PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation = "remove"
)

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation) IsKnown() bool

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Remove the directive.

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective) MarshalJSON added in v6.9.0 

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

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperationSet    PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation = "set"
	PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperationRemove PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation = "remove"
)

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation) IsKnown() bool

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Set the directive.

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective) MarshalJSON added in v6.9.0 

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

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperationSet    PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation = "set"
	PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperationRemove PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation = "remove"
)

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation) IsKnown() bool

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateUnion added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Satisfied by rulesets.PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective, rulesets.PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective, PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate.

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublic added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublic struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

A cache-control directive configuration.

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublic) MarshalJSON added in v6.9.0 

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

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicOperation added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicOperationSet    PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicOperation = "set"
	PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicOperationRemove PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicOperation = "remove"
)

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicOperation) IsKnown() bool

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Remove the directive.

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective) MarshalJSON added in v6.9.0 

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

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperationSet    PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation = "set"
	PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperationRemove PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation = "remove"
)

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation) IsKnown() bool

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Set the directive.

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective) MarshalJSON added in v6.9.0 

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

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperationSet    PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation = "set"
	PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperationRemove PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation = "remove"
)

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation) IsKnown() bool

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicUnion added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Satisfied by rulesets.PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective, rulesets.PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective, PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublic.

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxage added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxage struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
	// The duration value in seconds for the directive.
	Value param.Field[int64] `json:"value"`
}

A cache-control directive configuration that accepts a duration value in seconds.

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxage) MarshalJSON added in v6.9.0 

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

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperationSet    PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation = "set"
	PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperationRemove PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation = "remove"
)

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation) IsKnown() bool

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Remove the directive.

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective) MarshalJSON added in v6.9.0 

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

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperationSet    PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation = "set"
	PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperationRemove PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation = "remove"
)

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation) IsKnown() bool

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation] `json:"operation" api:"required"`
	// The duration value in seconds for the directive.
	Value param.Field[int64] `json:"value" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Set the directive with a duration value in seconds.

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective) MarshalJSON added in v6.9.0 

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

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperationSet    PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation = "set"
	PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperationRemove PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation = "remove"
)

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation) IsKnown() bool

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageUnion added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts a duration value in seconds.

Satisfied by rulesets.PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective, rulesets.PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective, PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxage.

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfError added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfError struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
	// The duration value in seconds for the directive.
	Value param.Field[int64] `json:"value"`
}

A cache-control directive configuration that accepts a duration value in seconds.

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfError) MarshalJSON added in v6.9.0 

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

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperationSet    PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation = "set"
	PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperationRemove PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation = "remove"
)

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation) IsKnown() bool

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Remove the directive.

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective) MarshalJSON added in v6.9.0 

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

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperationSet    PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation = "set"
	PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperationRemove PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation = "remove"
)

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation) IsKnown() bool

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation] `json:"operation" api:"required"`
	// The duration value in seconds for the directive.
	Value param.Field[int64] `json:"value" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Set the directive with a duration value in seconds.

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective) MarshalJSON added in v6.9.0 

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

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperationSet    PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation = "set"
	PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperationRemove PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation = "remove"
)

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation) IsKnown() bool

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorUnion added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts a duration value in seconds.

Satisfied by rulesets.PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective, rulesets.PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective, PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfError.

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
	// The duration value in seconds for the directive.
	Value param.Field[int64] `json:"value"`
}

A cache-control directive configuration that accepts a duration value in seconds.

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate) MarshalJSON added in v6.9.0 

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

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperationSet    PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation = "set"
	PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperationRemove PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation = "remove"
)

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation) IsKnown() bool

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Remove the directive.

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective) MarshalJSON added in v6.9.0 

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

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperationSet    PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation = "set"
	PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperationRemove PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation = "remove"
)

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation) IsKnown() bool

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation] `json:"operation" api:"required"`
	// The duration value in seconds for the directive.
	Value param.Field[int64] `json:"value" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Set the directive with a duration value in seconds.

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective) MarshalJSON added in v6.9.0 

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

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperationSet    PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation = "set"
	PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperationRemove PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation = "remove"
)

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation) IsKnown() bool

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateUnion added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts a duration value in seconds.

Satisfied by rulesets.PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective, rulesets.PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective, PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate.

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleExposedCredentialCheck added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleExposedCredentialCheck struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression param.Field[string] `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression param.Field[string] `json:"username_expression" api:"required"`
}

Configuration for exposed credential checking.

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleExposedCredentialCheck) MarshalJSON added in v6.9.0 

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

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleRatelimit added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleRatelimit struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics param.Field[[]string] `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period param.Field[int64] `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression param.Field[string] `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout param.Field[int64] `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod param.Field[int64] `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin param.Field[bool] `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod param.Field[int64] `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName param.Field[string] `json:"score_response_header_name"`
}

An object configuring the rule's rate limit behavior.

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleRatelimit) MarshalJSON added in v6.9.0 

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

type PhaseUpdateParamsRulesRulesetsSetCacheTagsRule added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheTagsRule struct {
	// The unique ID of the rule.
	ID param.Field[string] `json:"id"`
	// The action to perform when the rule matches.
	Action param.Field[PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleAction] `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters param.Field[PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersUnion] `json:"action_parameters"`
	// An informative description of the rule.
	Description param.Field[string] `json:"description"`
	// Whether the rule should be executed.
	Enabled param.Field[bool] `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck param.Field[PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleExposedCredentialCheck] `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression param.Field[string] `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging param.Field[LoggingParam] `json:"logging"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit param.Field[PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleRatelimit] `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref param.Field[string] `json:"ref"`
}

func (PhaseUpdateParamsRulesRulesetsSetCacheTagsRule) MarshalJSON added in v6.9.0 

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

type PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleAction added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleAction string

The action to perform when the rule matches. 

const (
	PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionSetCacheTags PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleAction = "set_cache_tags"
)

func (PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleAction) IsKnown added in v6.9.0 

func (r PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleAction) IsKnown() bool

type PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParameters added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParameters struct {
	// The operation to perform on the cache tags.
	Operation param.Field[PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersOperation] `json:"operation" api:"required"`
	// An expression that evaluates to an array of cache tag values.
	Expression param.Field[string]      `json:"expression"`
	Values     param.Field[interface{}] `json:"values"`
}

The parameters configuring the rule's action.

func (PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParameters) MarshalJSON added in v6.9.0 

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

type PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression struct {
	// An expression that evaluates to an array of cache tag values.
	Expression param.Field[string] `json:"expression" api:"required"`
	// The operation to perform on the cache tags.
	Operation param.Field[PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation] `json:"operation" api:"required"`
}

Add cache tags using an expression.

func (PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression) MarshalJSON added in v6.9.0 

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

type PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation string

The operation to perform on the cache tags. 

const (
	PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationAdd    PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "add"
	PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationRemove PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "remove"
	PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationSet    PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "set"
)

func (PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation) IsKnown() bool

type PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues struct {
	// The operation to perform on the cache tags.
	Operation param.Field[PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation] `json:"operation" api:"required"`
	// A list of cache tag values.
	Values param.Field[[]string] `json:"values" api:"required"`
}

Add cache tags using a list of values.

func (PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues) MarshalJSON added in v6.9.0 

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

type PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation string

The operation to perform on the cache tags. 

const (
	PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationAdd    PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "add"
	PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationRemove PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "remove"
	PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationSet    PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "set"
)

func (PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation) IsKnown() bool

type PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersOperation added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersOperation string

The operation to perform on the cache tags. 

const (
	PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersOperationAdd    PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersOperation = "add"
	PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersOperationRemove PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersOperation = "remove"
	PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersOperationSet    PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersOperation = "set"
)

func (PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersOperation) IsKnown() bool

type PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression struct {
	// An expression that evaluates to an array of cache tag values.
	Expression param.Field[string] `json:"expression" api:"required"`
	// The operation to perform on the cache tags.
	Operation param.Field[PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation] `json:"operation" api:"required"`
}

Remove cache tags using an expression.

func (PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression) MarshalJSON added in v6.9.0 

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

type PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation string

The operation to perform on the cache tags. 

const (
	PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationAdd    PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "add"
	PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationRemove PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "remove"
	PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationSet    PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "set"
)

func (PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation) IsKnown() bool

type PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues struct {
	// The operation to perform on the cache tags.
	Operation param.Field[PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation] `json:"operation" api:"required"`
	// A list of cache tag values.
	Values param.Field[[]string] `json:"values" api:"required"`
}

Remove cache tags using a list of values.

func (PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues) MarshalJSON added in v6.9.0 

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

type PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation string

The operation to perform on the cache tags. 

const (
	PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationAdd    PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "add"
	PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationRemove PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "remove"
	PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationSet    PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "set"
)

func (PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation) IsKnown() bool

type PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression struct {
	// An expression that evaluates to an array of cache tag values.
	Expression param.Field[string] `json:"expression" api:"required"`
	// The operation to perform on the cache tags.
	Operation param.Field[PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation] `json:"operation" api:"required"`
}

Set cache tags using an expression.

func (PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression) MarshalJSON added in v6.9.0 

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

type PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation string

The operation to perform on the cache tags. 

const (
	PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationAdd    PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "add"
	PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationRemove PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "remove"
	PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationSet    PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "set"
)

func (PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation) IsKnown() bool

type PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues struct {
	// The operation to perform on the cache tags.
	Operation param.Field[PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation] `json:"operation" api:"required"`
	// A list of cache tag values.
	Values param.Field[[]string] `json:"values" api:"required"`
}

Set cache tags using a list of values.

func (PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues) MarshalJSON added in v6.9.0 

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

type PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation string

The operation to perform on the cache tags. 

const (
	PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationAdd    PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "add"
	PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationRemove PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "remove"
	PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationSet    PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "set"
)

func (PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation) IsKnown() bool

type PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersUnion added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersUnion interface {
	// contains filtered or unexported methods
}

The parameters configuring the rule's action.

Satisfied by rulesets.PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues, rulesets.PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression, rulesets.PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues, rulesets.PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression, rulesets.PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues, rulesets.PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression, PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParameters.

type PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleExposedCredentialCheck added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleExposedCredentialCheck struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression param.Field[string] `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression param.Field[string] `json:"username_expression" api:"required"`
}

Configuration for exposed credential checking.

func (PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleExposedCredentialCheck) MarshalJSON added in v6.9.0 

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

type PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleRatelimit added in v6.9.0 

type PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleRatelimit struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics param.Field[[]string] `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period param.Field[int64] `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression param.Field[string] `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout param.Field[int64] `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod param.Field[int64] `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin param.Field[bool] `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod param.Field[int64] `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName param.Field[string] `json:"score_response_header_name"`
}

An object configuring the rule's rate limit behavior.

func (PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleRatelimit) MarshalJSON added in v6.9.0 

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

type PhaseUpdateResponse 

type PhaseUpdateResponse struct {
	// The unique ID of the ruleset.
	ID string `json:"id" api:"required"`
	// The kind of the ruleset.
	Kind Kind `json:"kind" api:"required"`
	// The timestamp of when the ruleset was last modified.
	LastUpdated time.Time `json:"last_updated" api:"required" format:"date-time"`
	// The human-readable name of the ruleset.
	Name string `json:"name" api:"required"`
	// The phase of the ruleset.
	Phase Phase `json:"phase" api:"required"`
	// The list of rules in the ruleset.
	Rules []PhaseUpdateResponseRule `json:"rules" api:"required"`
	// The version of the ruleset.
	Version string `json:"version" api:"required"`
	// An informative description of the ruleset.
	Description string                  `json:"description"`
	JSON        phaseUpdateResponseJSON `json:"-"`
}

A ruleset object.

func (*PhaseUpdateResponse) UnmarshalJSON 

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

type PhaseUpdateResponseEnvelope 

type PhaseUpdateResponseEnvelope struct {
	// A list of error messages.
	Errors []PhaseUpdateResponseEnvelopeErrors `json:"errors" api:"required"`
	// A list of warning messages.
	Messages []PhaseUpdateResponseEnvelopeMessages `json:"messages" api:"required"`
	// A ruleset object.
	Result PhaseUpdateResponse `json:"result" api:"required"`
	// Whether the API call was successful.
	Success PhaseUpdateResponseEnvelopeSuccess `json:"success" api:"required"`
	JSON    phaseUpdateResponseEnvelopeJSON    `json:"-"`
}

A response object.

func (*PhaseUpdateResponseEnvelope) UnmarshalJSON 

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

type PhaseUpdateResponseEnvelopeErrors 

type PhaseUpdateResponseEnvelopeErrors struct {
	// A text description of this message.
	Message string `json:"message" api:"required"`
	// A unique code for this message.
	Code int64 `json:"code"`
	// The source of this message.
	Source PhaseUpdateResponseEnvelopeErrorsSource `json:"source"`
	JSON   phaseUpdateResponseEnvelopeErrorsJSON   `json:"-"`
}

A message.

func (*PhaseUpdateResponseEnvelopeErrors) UnmarshalJSON 

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

type PhaseUpdateResponseEnvelopeErrorsSource 

type PhaseUpdateResponseEnvelopeErrorsSource struct {
	// A JSON pointer to the field that is the source of the message.
	Pointer string                                      `json:"pointer" api:"required"`
	JSON    phaseUpdateResponseEnvelopeErrorsSourceJSON `json:"-"`
}

The source of this message.

func (*PhaseUpdateResponseEnvelopeErrorsSource) UnmarshalJSON 

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

type PhaseUpdateResponseEnvelopeMessages 

type PhaseUpdateResponseEnvelopeMessages struct {
	// A text description of this message.
	Message string `json:"message" api:"required"`
	// A unique code for this message.
	Code int64 `json:"code"`
	// The source of this message.
	Source PhaseUpdateResponseEnvelopeMessagesSource `json:"source"`
	JSON   phaseUpdateResponseEnvelopeMessagesJSON   `json:"-"`
}

A message.

func (*PhaseUpdateResponseEnvelopeMessages) UnmarshalJSON 

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

type PhaseUpdateResponseEnvelopeMessagesSource 

type PhaseUpdateResponseEnvelopeMessagesSource struct {
	// A JSON pointer to the field that is the source of the message.
	Pointer string                                        `json:"pointer" api:"required"`
	JSON    phaseUpdateResponseEnvelopeMessagesSourceJSON `json:"-"`
}

The source of this message.

func (*PhaseUpdateResponseEnvelopeMessagesSource) UnmarshalJSON 

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

type PhaseUpdateResponseEnvelopeSuccess 

type PhaseUpdateResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	PhaseUpdateResponseEnvelopeSuccessTrue PhaseUpdateResponseEnvelopeSuccess = true
)

func (PhaseUpdateResponseEnvelopeSuccess) IsKnown 

func (r PhaseUpdateResponseEnvelopeSuccess) IsKnown() bool

type PhaseUpdateResponseRule 

type PhaseUpdateResponseRule struct {
	// The timestamp of when the rule was last modified.
	LastUpdated time.Time `json:"last_updated" api:"required" format:"date-time"`
	// The version of the rule.
	Version string `json:"version" api:"required"`
	// The unique ID of the rule.
	ID string `json:"id"`
	// The action to perform when the rule matches.
	Action PhaseUpdateResponseRulesAction `json:"action"`
	// This field can have the runtime type of [BlockRuleActionParameters],
	// [interface{}], [CompressResponseRuleActionParameters],
	// [ExecuteRuleActionParameters], [LogCustomFieldRuleActionParameters],
	// [RedirectRuleActionParameters], [RewriteRuleActionParameters],
	// [RouteRuleActionParameters], [ScoreRuleActionParameters],
	// [ServeErrorRuleActionParameters],
	// [PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParameters],
	// [SetCacheSettingsRuleActionParameters],
	// [PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParameters],
	// [SetConfigRuleActionParameters], [SkipRuleActionParameters].
	ActionParameters interface{} `json:"action_parameters"`
	// This field can have the runtime type of [[]string].
	Categories interface{} `json:"categories"`
	// An informative description of the rule.
	Description string `json:"description"`
	// Whether the rule should be executed.
	Enabled bool `json:"enabled"`
	// This field can have the runtime type of [BlockRuleExposedCredentialCheck],
	// [PhaseUpdateResponseRulesRulesetsChallengeRuleExposedCredentialCheck],
	// [CompressResponseRuleExposedCredentialCheck],
	// [DDoSDynamicRuleExposedCredentialCheck], [ExecuteRuleExposedCredentialCheck],
	// [ForceConnectionCloseRuleExposedCredentialCheck],
	// [PhaseUpdateResponseRulesRulesetsJSChallengeRuleExposedCredentialCheck],
	// [LogRuleExposedCredentialCheck], [LogCustomFieldRuleExposedCredentialCheck],
	// [ManagedChallengeRuleExposedCredentialCheck],
	// [RedirectRuleExposedCredentialCheck], [RewriteRuleExposedCredentialCheck],
	// [RouteRuleExposedCredentialCheck], [ScoreRuleExposedCredentialCheck],
	// [ServeErrorRuleExposedCredentialCheck],
	// [PhaseUpdateResponseRulesRulesetsSetCacheControlRuleExposedCredentialCheck],
	// [SetCacheSettingsRuleExposedCredentialCheck],
	// [PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleExposedCredentialCheck],
	// [SetConfigRuleExposedCredentialCheck], [SkipRuleExposedCredentialCheck].
	ExposedCredentialCheck interface{} `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression string `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging Logging `json:"logging"`
	// This field can have the runtime type of [BlockRuleRatelimit],
	// [PhaseUpdateResponseRulesRulesetsChallengeRuleRatelimit],
	// [CompressResponseRuleRatelimit], [DDoSDynamicRuleRatelimit],
	// [ExecuteRuleRatelimit], [ForceConnectionCloseRuleRatelimit],
	// [PhaseUpdateResponseRulesRulesetsJSChallengeRuleRatelimit], [LogRuleRatelimit],
	// [LogCustomFieldRuleRatelimit], [ManagedChallengeRuleRatelimit],
	// [RedirectRuleRatelimit], [RewriteRuleRatelimit], [RouteRuleRatelimit],
	// [ScoreRuleRatelimit], [ServeErrorRuleRatelimit],
	// [PhaseUpdateResponseRulesRulesetsSetCacheControlRuleRatelimit],
	// [SetCacheSettingsRuleRatelimit],
	// [PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleRatelimit],
	// [SetConfigRuleRatelimit], [SkipRuleRatelimit].
	Ratelimit interface{} `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                      `json:"ref"`
	JSON phaseUpdateResponseRuleJSON `json:"-"`
	// contains filtered or unexported fields
}

func (PhaseUpdateResponseRule) AsUnion 

func (r PhaseUpdateResponseRule) AsUnion() PhaseUpdateResponseRulesUnion

AsUnion returns a PhaseUpdateResponseRulesUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are BlockRule, PhaseUpdateResponseRulesRulesetsChallengeRule, CompressResponseRule, DDoSDynamicRule, ExecuteRule, ForceConnectionCloseRule, PhaseUpdateResponseRulesRulesetsJSChallengeRule, LogRule, LogCustomFieldRule, ManagedChallengeRule, RedirectRule, RewriteRule, RouteRule, ScoreRule, ServeErrorRule, PhaseUpdateResponseRulesRulesetsSetCacheControlRule, SetCacheSettingsRule, PhaseUpdateResponseRulesRulesetsSetCacheTagsRule, SetConfigRule, SkipRule.

func (*PhaseUpdateResponseRule) UnmarshalJSON 

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

type PhaseUpdateResponseRulesAction 

type PhaseUpdateResponseRulesAction string

The action to perform when the rule matches. 

const (
	PhaseUpdateResponseRulesActionBlock                PhaseUpdateResponseRulesAction = "block"
	PhaseUpdateResponseRulesActionChallenge            PhaseUpdateResponseRulesAction = "challenge"
	PhaseUpdateResponseRulesActionCompressResponse     PhaseUpdateResponseRulesAction = "compress_response"
	PhaseUpdateResponseRulesActionDDoSDynamic          PhaseUpdateResponseRulesAction = "ddos_dynamic"
	PhaseUpdateResponseRulesActionExecute              PhaseUpdateResponseRulesAction = "execute"
	PhaseUpdateResponseRulesActionForceConnectionClose PhaseUpdateResponseRulesAction = "force_connection_close"
	PhaseUpdateResponseRulesActionJSChallenge          PhaseUpdateResponseRulesAction = "js_challenge"
	PhaseUpdateResponseRulesActionLog                  PhaseUpdateResponseRulesAction = "log"
	PhaseUpdateResponseRulesActionLogCustomField       PhaseUpdateResponseRulesAction = "log_custom_field"
	PhaseUpdateResponseRulesActionManagedChallenge     PhaseUpdateResponseRulesAction = "managed_challenge"
	PhaseUpdateResponseRulesActionRedirect             PhaseUpdateResponseRulesAction = "redirect"
	PhaseUpdateResponseRulesActionRewrite              PhaseUpdateResponseRulesAction = "rewrite"
	PhaseUpdateResponseRulesActionRoute                PhaseUpdateResponseRulesAction = "route"
	PhaseUpdateResponseRulesActionScore                PhaseUpdateResponseRulesAction = "score"
	PhaseUpdateResponseRulesActionServeError           PhaseUpdateResponseRulesAction = "serve_error"
	PhaseUpdateResponseRulesActionSetCacheControl      PhaseUpdateResponseRulesAction = "set_cache_control"
	PhaseUpdateResponseRulesActionSetCacheSettings     PhaseUpdateResponseRulesAction = "set_cache_settings"
	PhaseUpdateResponseRulesActionSetCacheTags         PhaseUpdateResponseRulesAction = "set_cache_tags"
	PhaseUpdateResponseRulesActionSetConfig            PhaseUpdateResponseRulesAction = "set_config"
	PhaseUpdateResponseRulesActionSkip                 PhaseUpdateResponseRulesAction = "skip"
)

func (PhaseUpdateResponseRulesAction) IsKnown 

func (r PhaseUpdateResponseRulesAction) IsKnown() bool

type PhaseUpdateResponseRulesRulesetsChallengeRule 

type PhaseUpdateResponseRulesRulesetsChallengeRule struct {
	// The timestamp of when the rule was last modified.
	LastUpdated time.Time `json:"last_updated" api:"required" format:"date-time"`
	// The version of the rule.
	Version string `json:"version" api:"required"`
	// The unique ID of the rule.
	ID string `json:"id"`
	// The action to perform when the rule matches.
	Action PhaseUpdateResponseRulesRulesetsChallengeRuleAction `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters interface{} `json:"action_parameters"`
	// The categories of the rule.
	Categories []string `json:"categories"`
	// An informative description of the rule.
	Description string `json:"description"`
	// Whether the rule should be executed.
	Enabled bool `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck PhaseUpdateResponseRulesRulesetsChallengeRuleExposedCredentialCheck `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression string `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging Logging `json:"logging"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit PhaseUpdateResponseRulesRulesetsChallengeRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                                            `json:"ref"`
	JSON phaseUpdateResponseRulesRulesetsChallengeRuleJSON `json:"-"`
}

func (*PhaseUpdateResponseRulesRulesetsChallengeRule) UnmarshalJSON 

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

type PhaseUpdateResponseRulesRulesetsChallengeRuleAction 

type PhaseUpdateResponseRulesRulesetsChallengeRuleAction string

The action to perform when the rule matches. 

const (
	PhaseUpdateResponseRulesRulesetsChallengeRuleActionChallenge PhaseUpdateResponseRulesRulesetsChallengeRuleAction = "challenge"
)

func (PhaseUpdateResponseRulesRulesetsChallengeRuleAction) IsKnown 

func (r PhaseUpdateResponseRulesRulesetsChallengeRuleAction) IsKnown() bool

type PhaseUpdateResponseRulesRulesetsChallengeRuleExposedCredentialCheck 

type PhaseUpdateResponseRulesRulesetsChallengeRuleExposedCredentialCheck struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression string `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression string                                                                  `json:"username_expression" api:"required"`
	JSON               phaseUpdateResponseRulesRulesetsChallengeRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*PhaseUpdateResponseRulesRulesetsChallengeRuleExposedCredentialCheck) UnmarshalJSON 

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

type PhaseUpdateResponseRulesRulesetsChallengeRuleRatelimit 

type PhaseUpdateResponseRulesRulesetsChallengeRuleRatelimit struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics []string `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period int64 `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression string `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout int64 `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod int64 `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin bool `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod int64 `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName string                                                     `json:"score_response_header_name"`
	JSON                    phaseUpdateResponseRulesRulesetsChallengeRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*PhaseUpdateResponseRulesRulesetsChallengeRuleRatelimit) UnmarshalJSON 

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

type PhaseUpdateResponseRulesRulesetsJSChallengeRule 

type PhaseUpdateResponseRulesRulesetsJSChallengeRule struct {
	// The timestamp of when the rule was last modified.
	LastUpdated time.Time `json:"last_updated" api:"required" format:"date-time"`
	// The version of the rule.
	Version string `json:"version" api:"required"`
	// The unique ID of the rule.
	ID string `json:"id"`
	// The action to perform when the rule matches.
	Action PhaseUpdateResponseRulesRulesetsJSChallengeRuleAction `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters interface{} `json:"action_parameters"`
	// The categories of the rule.
	Categories []string `json:"categories"`
	// An informative description of the rule.
	Description string `json:"description"`
	// Whether the rule should be executed.
	Enabled bool `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck PhaseUpdateResponseRulesRulesetsJSChallengeRuleExposedCredentialCheck `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression string `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging Logging `json:"logging"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit PhaseUpdateResponseRulesRulesetsJSChallengeRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                                              `json:"ref"`
	JSON phaseUpdateResponseRulesRulesetsJSChallengeRuleJSON `json:"-"`
}

func (*PhaseUpdateResponseRulesRulesetsJSChallengeRule) UnmarshalJSON 

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

type PhaseUpdateResponseRulesRulesetsJSChallengeRuleAction 

type PhaseUpdateResponseRulesRulesetsJSChallengeRuleAction string

The action to perform when the rule matches. 

const (
	PhaseUpdateResponseRulesRulesetsJSChallengeRuleActionJSChallenge PhaseUpdateResponseRulesRulesetsJSChallengeRuleAction = "js_challenge"
)

func (PhaseUpdateResponseRulesRulesetsJSChallengeRuleAction) IsKnown 

func (r PhaseUpdateResponseRulesRulesetsJSChallengeRuleAction) IsKnown() bool

type PhaseUpdateResponseRulesRulesetsJSChallengeRuleExposedCredentialCheck 

type PhaseUpdateResponseRulesRulesetsJSChallengeRuleExposedCredentialCheck struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression string `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression string                                                                    `json:"username_expression" api:"required"`
	JSON               phaseUpdateResponseRulesRulesetsJSChallengeRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*PhaseUpdateResponseRulesRulesetsJSChallengeRuleExposedCredentialCheck) UnmarshalJSON 

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

type PhaseUpdateResponseRulesRulesetsJSChallengeRuleRatelimit 

type PhaseUpdateResponseRulesRulesetsJSChallengeRuleRatelimit struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics []string `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period int64 `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression string `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout int64 `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod int64 `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin bool `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod int64 `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName string                                                       `json:"score_response_header_name"`
	JSON                    phaseUpdateResponseRulesRulesetsJSChallengeRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*PhaseUpdateResponseRulesRulesetsJSChallengeRuleRatelimit) UnmarshalJSON 

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

type PhaseUpdateResponseRulesRulesetsSetCacheControlRule added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRule struct {
	// The timestamp of when the rule was last modified.
	LastUpdated time.Time `json:"last_updated" api:"required" format:"date-time"`
	// The version of the rule.
	Version string `json:"version" api:"required"`
	// The unique ID of the rule.
	ID string `json:"id"`
	// The action to perform when the rule matches.
	Action PhaseUpdateResponseRulesRulesetsSetCacheControlRuleAction `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParameters `json:"action_parameters"`
	// The categories of the rule.
	Categories []string `json:"categories"`
	// An informative description of the rule.
	Description string `json:"description"`
	// Whether the rule should be executed.
	Enabled bool `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck PhaseUpdateResponseRulesRulesetsSetCacheControlRuleExposedCredentialCheck `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression string `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging Logging `json:"logging"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit PhaseUpdateResponseRulesRulesetsSetCacheControlRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                                                  `json:"ref"`
	JSON phaseUpdateResponseRulesRulesetsSetCacheControlRuleJSON `json:"-"`
}

func (*PhaseUpdateResponseRulesRulesetsSetCacheControlRule) UnmarshalJSON added in v6.9.0 

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

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleAction added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleAction string

The action to perform when the rule matches. 

const (
	PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionSetCacheControl PhaseUpdateResponseRulesRulesetsSetCacheControlRuleAction = "set_cache_control"
)

func (PhaseUpdateResponseRulesRulesetsSetCacheControlRuleAction) IsKnown added in v6.9.0 

func (r PhaseUpdateResponseRulesRulesetsSetCacheControlRuleAction) IsKnown() bool

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParameters added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParameters struct {
	// A cache-control directive configuration.
	Immutable PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutable `json:"immutable"`
	// A cache-control directive configuration that accepts a duration value in
	// seconds.
	MaxAge PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAge `json:"max-age"`
	// A cache-control directive configuration.
	MustRevalidate PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate `json:"must-revalidate"`
	// A cache-control directive configuration.
	MustUnderstand PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand `json:"must-understand"`
	// A cache-control directive configuration that accepts optional qualifiers (header
	// names).
	NoCache PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCache `json:"no-cache"`
	// A cache-control directive configuration.
	NoStore PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStore `json:"no-store"`
	// A cache-control directive configuration.
	NoTransform PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransform `json:"no-transform"`
	// A cache-control directive configuration that accepts optional qualifiers (header
	// names).
	Private PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivate `json:"private"`
	// A cache-control directive configuration.
	ProxyRevalidate PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate `json:"proxy-revalidate"`
	// A cache-control directive configuration.
	Public PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublic `json:"public"`
	// A cache-control directive configuration that accepts a duration value in
	// seconds.
	SMaxage PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxage `json:"s-maxage"`
	// A cache-control directive configuration that accepts a duration value in
	// seconds.
	StaleIfError PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfError `json:"stale-if-error"`
	// A cache-control directive configuration that accepts a duration value in
	// seconds.
	StaleWhileRevalidate PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate `json:"stale-while-revalidate"`
	JSON                 phaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersJSON                 `json:"-"`
}

The parameters configuring the rule's action.

func (*PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParameters) UnmarshalJSON added in v6.9.0 

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

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutable added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutable struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                             `json:"cloudflare_only"`
	JSON           phaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration.

func (PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutable) AsUnion added in v6.9.0 

func (r PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutable) AsUnion() PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableUnion

AsUnion returns a PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective, PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective.

func (*PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutable) UnmarshalJSON added in v6.9.0 

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

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperationSet    PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation = "set"
	PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperationRemove PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation = "remove"
)

func (PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation) IsKnown() bool

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                            `json:"cloudflare_only"`
	JSON           phaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective) UnmarshalJSON added in v6.9.0 

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

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperationSet    PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation = "set"
	PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperationRemove PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation = "remove"
)

func (PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation) IsKnown() bool

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                         `json:"cloudflare_only"`
	JSON           phaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveJSON `json:"-"`
}

Set the directive.

func (*PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective) UnmarshalJSON added in v6.9.0 

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

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperationSet    PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation = "set"
	PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperationRemove PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation = "remove"
)

func (PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation) IsKnown() bool

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableUnion added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Union satisfied by PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective or PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective.

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAge added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAge struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool `json:"cloudflare_only"`
	// The duration value in seconds for the directive.
	Value int64                                                                         `json:"value"`
	JSON  phaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration that accepts a duration value in seconds.

func (PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAge) AsUnion added in v6.9.0 

func (r PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAge) AsUnion() PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeUnion

AsUnion returns a PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective, PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective.

func (*PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAge) UnmarshalJSON added in v6.9.0 

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

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperationSet    PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation = "set"
	PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperationRemove PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation = "remove"
)

func (PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation) IsKnown() bool

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                         `json:"cloudflare_only"`
	JSON           phaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective) UnmarshalJSON added in v6.9.0 

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

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperationSet    PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation = "set"
	PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperationRemove PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation = "remove"
)

func (PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation) IsKnown() bool

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation `json:"operation" api:"required"`
	// The duration value in seconds for the directive.
	Value int64 `json:"value" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                      `json:"cloudflare_only"`
	JSON           phaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveJSON `json:"-"`
}

Set the directive with a duration value in seconds.

func (*PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective) UnmarshalJSON added in v6.9.0 

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

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperationSet    PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation = "set"
	PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperationRemove PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation = "remove"
)

func (PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation) IsKnown() bool

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeUnion added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts a duration value in seconds.

Union satisfied by PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective or PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective.

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                  `json:"cloudflare_only"`
	JSON           phaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration.

func (PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate) AsUnion added in v6.9.0 

func (r PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate) AsUnion() PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateUnion

AsUnion returns a PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective, PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective.

func (*PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate) UnmarshalJSON added in v6.9.0 

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

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperationSet    PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation = "set"
	PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperationRemove PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation = "remove"
)

func (PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation) IsKnown() bool

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                                 `json:"cloudflare_only"`
	JSON           phaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective) UnmarshalJSON added in v6.9.0 

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

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperationSet    PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation = "set"
	PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperationRemove PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation = "remove"
)

func (PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation) IsKnown() bool

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                              `json:"cloudflare_only"`
	JSON           phaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveJSON `json:"-"`
}

Set the directive.

func (*PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective) UnmarshalJSON added in v6.9.0 

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

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperationSet    PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation = "set"
	PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperationRemove PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation = "remove"
)

func (PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation) IsKnown() bool

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateUnion added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Union satisfied by PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective or PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective.

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                  `json:"cloudflare_only"`
	JSON           phaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration.

func (PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand) AsUnion added in v6.9.0 

func (r PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand) AsUnion() PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandUnion

AsUnion returns a PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective, PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective.

func (*PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand) UnmarshalJSON added in v6.9.0 

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

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperationSet    PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation = "set"
	PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperationRemove PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation = "remove"
)

func (PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation) IsKnown() bool

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                                 `json:"cloudflare_only"`
	JSON           phaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective) UnmarshalJSON added in v6.9.0 

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

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperationSet    PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation = "set"
	PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperationRemove PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation = "remove"
)

func (PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation) IsKnown() bool

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                              `json:"cloudflare_only"`
	JSON           phaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveJSON `json:"-"`
}

Set the directive.

func (*PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective) UnmarshalJSON added in v6.9.0 

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

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperationSet    PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation = "set"
	PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperationRemove PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation = "remove"
)

func (PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation) IsKnown() bool

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandUnion added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Union satisfied by PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective or PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective.

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCache added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCache struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool `json:"cloudflare_only"`
	// This field can have the runtime type of [[]string].
	Qualifiers interface{}                                                                    `json:"qualifiers"`
	JSON       phaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration that accepts optional qualifiers (header names).

func (PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCache) AsUnion added in v6.9.0 

func (r PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCache) AsUnion() PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheUnion

AsUnion returns a PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective, PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective.

func (*PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCache) UnmarshalJSON added in v6.9.0 

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

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperationSet    PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation = "set"
	PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperationRemove PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation = "remove"
)

func (PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation) IsKnown() bool

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                          `json:"cloudflare_only"`
	JSON           phaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective) UnmarshalJSON added in v6.9.0 

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

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperationSet    PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation = "set"
	PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperationRemove PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation = "remove"
)

func (PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation) IsKnown() bool

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool `json:"cloudflare_only"`
	// Optional list of header names to qualify the directive (e.g., for "private" or
	// "no-cache" directives).
	Qualifiers []string                                                                                   `json:"qualifiers"`
	JSON       phaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveJSON `json:"-"`
}

Set the directive with optional qualifiers.

func (*PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective) UnmarshalJSON added in v6.9.0 

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

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperationSet    PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation = "set"
	PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperationRemove PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation = "remove"
)

func (PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation) IsKnown() bool

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheUnion added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts optional qualifiers (header names).

Union satisfied by PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective or PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective.

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStore added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStore struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                           `json:"cloudflare_only"`
	JSON           phaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration.

func (PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStore) AsUnion added in v6.9.0 

func (r PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStore) AsUnion() PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreUnion

AsUnion returns a PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective, PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective.

func (*PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStore) UnmarshalJSON added in v6.9.0 

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

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperationSet    PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation = "set"
	PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperationRemove PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation = "remove"
)

func (PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation) IsKnown() bool

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                          `json:"cloudflare_only"`
	JSON           phaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective) UnmarshalJSON added in v6.9.0 

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

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperationSet    PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation = "set"
	PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperationRemove PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation = "remove"
)

func (PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation) IsKnown() bool

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                       `json:"cloudflare_only"`
	JSON           phaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveJSON `json:"-"`
}

Set the directive.

func (*PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective) UnmarshalJSON added in v6.9.0 

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

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperationSet    PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation = "set"
	PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperationRemove PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation = "remove"
)

func (PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation) IsKnown() bool

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreUnion added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Union satisfied by PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective or PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective.

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransform added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransform struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                               `json:"cloudflare_only"`
	JSON           phaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration.

func (PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransform) AsUnion added in v6.9.0 

func (r PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransform) AsUnion() PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformUnion

AsUnion returns a PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective, PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective.

func (*PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransform) UnmarshalJSON added in v6.9.0 

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

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperationSet    PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation = "set"
	PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperationRemove PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation = "remove"
)

func (PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation) IsKnown() bool

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                              `json:"cloudflare_only"`
	JSON           phaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective) UnmarshalJSON added in v6.9.0 

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

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperationSet    PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation = "set"
	PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperationRemove PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation = "remove"
)

func (PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation) IsKnown() bool

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                           `json:"cloudflare_only"`
	JSON           phaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveJSON `json:"-"`
}

Set the directive.

func (*PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective) UnmarshalJSON added in v6.9.0 

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

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperationSet    PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation = "set"
	PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperationRemove PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation = "remove"
)

func (PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation) IsKnown() bool

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformUnion added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Union satisfied by PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective or PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective.

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivate added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivate struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool `json:"cloudflare_only"`
	// This field can have the runtime type of [[]string].
	Qualifiers interface{}                                                                    `json:"qualifiers"`
	JSON       phaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration that accepts optional qualifiers (header names).

func (PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivate) AsUnion added in v6.9.0 

func (r PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivate) AsUnion() PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateUnion

AsUnion returns a PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective, PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective.

func (*PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivate) UnmarshalJSON added in v6.9.0 

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

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperationSet    PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation = "set"
	PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperationRemove PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation = "remove"
)

func (PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation) IsKnown() bool

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                          `json:"cloudflare_only"`
	JSON           phaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective) UnmarshalJSON added in v6.9.0 

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

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperationSet    PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation = "set"
	PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperationRemove PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation = "remove"
)

func (PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation) IsKnown() bool

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool `json:"cloudflare_only"`
	// Optional list of header names to qualify the directive (e.g., for "private" or
	// "no-cache" directives).
	Qualifiers []string                                                                                   `json:"qualifiers"`
	JSON       phaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveJSON `json:"-"`
}

Set the directive with optional qualifiers.

func (*PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective) UnmarshalJSON added in v6.9.0 

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

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperationSet    PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation = "set"
	PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperationRemove PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation = "remove"
)

func (PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation) IsKnown() bool

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateUnion added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts optional qualifiers (header names).

Union satisfied by PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective or PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective.

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                   `json:"cloudflare_only"`
	JSON           phaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration.

func (PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate) AsUnion added in v6.9.0 

func (r PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate) AsUnion() PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateUnion

AsUnion returns a PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective, PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective.

func (*PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate) UnmarshalJSON added in v6.9.0 

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

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperationSet    PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation = "set"
	PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperationRemove PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation = "remove"
)

func (PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation) IsKnown() bool

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                                  `json:"cloudflare_only"`
	JSON           phaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective) UnmarshalJSON added in v6.9.0 

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

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperationSet    PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation = "set"
	PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperationRemove PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation = "remove"
)

func (PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation) IsKnown() bool

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                               `json:"cloudflare_only"`
	JSON           phaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveJSON `json:"-"`
}

Set the directive.

func (*PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective) UnmarshalJSON added in v6.9.0 

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

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperationSet    PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation = "set"
	PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperationRemove PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation = "remove"
)

func (PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation) IsKnown() bool

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateUnion added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Union satisfied by PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective or PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective.

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublic added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublic struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                          `json:"cloudflare_only"`
	JSON           phaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration.

func (PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublic) AsUnion added in v6.9.0 

func (r PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublic) AsUnion() PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicUnion

AsUnion returns a PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective, PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective.

func (*PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublic) UnmarshalJSON added in v6.9.0 

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

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperationSet    PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation = "set"
	PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperationRemove PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation = "remove"
)

func (PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation) IsKnown() bool

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                         `json:"cloudflare_only"`
	JSON           phaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective) UnmarshalJSON added in v6.9.0 

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

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperationSet    PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation = "set"
	PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperationRemove PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation = "remove"
)

func (PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation) IsKnown() bool

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                      `json:"cloudflare_only"`
	JSON           phaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveJSON `json:"-"`
}

Set the directive.

func (*PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective) UnmarshalJSON added in v6.9.0 

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

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperationSet    PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation = "set"
	PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperationRemove PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation = "remove"
)

func (PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation) IsKnown() bool

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicUnion added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Union satisfied by PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective or PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective.

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxage added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxage struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool `json:"cloudflare_only"`
	// The duration value in seconds for the directive.
	Value int64                                                                          `json:"value"`
	JSON  phaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration that accepts a duration value in seconds.

func (PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxage) AsUnion added in v6.9.0 

func (r PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxage) AsUnion() PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageUnion

AsUnion returns a PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective, PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective.

func (*PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxage) UnmarshalJSON added in v6.9.0 

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

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperationSet    PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation = "set"
	PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperationRemove PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation = "remove"
)

func (PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation) IsKnown() bool

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                          `json:"cloudflare_only"`
	JSON           phaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective) UnmarshalJSON added in v6.9.0 

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

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperationSet    PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation = "set"
	PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperationRemove PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation = "remove"
)

func (PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation) IsKnown() bool

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation `json:"operation" api:"required"`
	// The duration value in seconds for the directive.
	Value int64 `json:"value" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                       `json:"cloudflare_only"`
	JSON           phaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveJSON `json:"-"`
}

Set the directive with a duration value in seconds.

func (*PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective) UnmarshalJSON added in v6.9.0 

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

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperationSet    PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation = "set"
	PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperationRemove PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation = "remove"
)

func (PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation) IsKnown() bool

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageUnion added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts a duration value in seconds.

Union satisfied by PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective or PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective.

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfError added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfError struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool `json:"cloudflare_only"`
	// The duration value in seconds for the directive.
	Value int64                                                                               `json:"value"`
	JSON  phaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration that accepts a duration value in seconds.

func (PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfError) AsUnion added in v6.9.0 

func (r PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfError) AsUnion() PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorUnion

AsUnion returns a PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective, PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective.

func (*PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfError) UnmarshalJSON added in v6.9.0 

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

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperationSet    PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation = "set"
	PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperationRemove PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation = "remove"
)

func (PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation) IsKnown() bool

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                               `json:"cloudflare_only"`
	JSON           phaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective) UnmarshalJSON added in v6.9.0 

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

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperationSet    PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation = "set"
	PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperationRemove PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation = "remove"
)

func (PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation) IsKnown() bool

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation `json:"operation" api:"required"`
	// The duration value in seconds for the directive.
	Value int64 `json:"value" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                            `json:"cloudflare_only"`
	JSON           phaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveJSON `json:"-"`
}

Set the directive with a duration value in seconds.

func (*PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective) UnmarshalJSON added in v6.9.0 

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

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperationSet    PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation = "set"
	PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperationRemove PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation = "remove"
)

func (PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation) IsKnown() bool

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorUnion added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts a duration value in seconds.

Union satisfied by PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective or PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective.

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool `json:"cloudflare_only"`
	// The duration value in seconds for the directive.
	Value int64                                                                                       `json:"value"`
	JSON  phaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration that accepts a duration value in seconds.

func (PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate) AsUnion added in v6.9.0 

func (r PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate) AsUnion() PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateUnion

AsUnion returns a PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective, PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective.

func (*PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate) UnmarshalJSON added in v6.9.0 

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

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperationSet    PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation = "set"
	PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperationRemove PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation = "remove"
)

func (PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation) IsKnown() bool

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                                       `json:"cloudflare_only"`
	JSON           phaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective) UnmarshalJSON added in v6.9.0 

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

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperationSet    PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation = "set"
	PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperationRemove PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation = "remove"
)

func (PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation) IsKnown() bool

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation `json:"operation" api:"required"`
	// The duration value in seconds for the directive.
	Value int64 `json:"value" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                                    `json:"cloudflare_only"`
	JSON           phaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveJSON `json:"-"`
}

Set the directive with a duration value in seconds.

func (*PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective) UnmarshalJSON added in v6.9.0 

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

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperationSet    PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation = "set"
	PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperationRemove PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation = "remove"
)

func (PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation) IsKnown() bool

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateUnion added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts a duration value in seconds.

Union satisfied by PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective or PhaseUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective.

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleExposedCredentialCheck added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleExposedCredentialCheck struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression string `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression string                                                                        `json:"username_expression" api:"required"`
	JSON               phaseUpdateResponseRulesRulesetsSetCacheControlRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*PhaseUpdateResponseRulesRulesetsSetCacheControlRuleExposedCredentialCheck) UnmarshalJSON added in v6.9.0 

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

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleRatelimit added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheControlRuleRatelimit struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics []string `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period int64 `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression string `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout int64 `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod int64 `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin bool `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod int64 `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName string                                                           `json:"score_response_header_name"`
	JSON                    phaseUpdateResponseRulesRulesetsSetCacheControlRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*PhaseUpdateResponseRulesRulesetsSetCacheControlRuleRatelimit) UnmarshalJSON added in v6.9.0 

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

type PhaseUpdateResponseRulesRulesetsSetCacheTagsRule added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheTagsRule struct {
	// The timestamp of when the rule was last modified.
	LastUpdated time.Time `json:"last_updated" api:"required" format:"date-time"`
	// The version of the rule.
	Version string `json:"version" api:"required"`
	// The unique ID of the rule.
	ID string `json:"id"`
	// The action to perform when the rule matches.
	Action PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleAction `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParameters `json:"action_parameters"`
	// The categories of the rule.
	Categories []string `json:"categories"`
	// An informative description of the rule.
	Description string `json:"description"`
	// Whether the rule should be executed.
	Enabled bool `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleExposedCredentialCheck `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression string `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging Logging `json:"logging"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                                               `json:"ref"`
	JSON phaseUpdateResponseRulesRulesetsSetCacheTagsRuleJSON `json:"-"`
}

func (*PhaseUpdateResponseRulesRulesetsSetCacheTagsRule) UnmarshalJSON added in v6.9.0 

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

type PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleAction added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleAction string

The action to perform when the rule matches. 

const (
	PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionSetCacheTags PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleAction = "set_cache_tags"
)

func (PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleAction) IsKnown added in v6.9.0 

func (r PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleAction) IsKnown() bool

type PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParameters added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParameters struct {
	// The operation to perform on the cache tags.
	Operation PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation `json:"operation" api:"required"`
	// An expression that evaluates to an array of cache tag values.
	Expression string `json:"expression"`
	// This field can have the runtime type of [[]string].
	Values interface{}                                                          `json:"values"`
	JSON   phaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersJSON `json:"-"`
	// contains filtered or unexported fields
}

The parameters configuring the rule's action.

func (PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParameters) AsUnion added in v6.9.0 

func (r PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParameters) AsUnion() PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersUnion

AsUnion returns a PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues, PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression, PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues, PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression, PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues, PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression.

func (*PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParameters) UnmarshalJSON added in v6.9.0 

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

type PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression struct {
	// An expression that evaluates to an array of cache tag values.
	Expression string `json:"expression" api:"required"`
	// The operation to perform on the cache tags.
	Operation PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation `json:"operation" api:"required"`
	JSON      phaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionJSON      `json:"-"`
}

Add cache tags using an expression.

func (*PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression) UnmarshalJSON added in v6.9.0 

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

type PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation string

The operation to perform on the cache tags. 

const (
	PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationAdd    PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "add"
	PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationRemove PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "remove"
	PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationSet    PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "set"
)

func (PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation) IsKnown() bool

type PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues struct {
	// The operation to perform on the cache tags.
	Operation PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation `json:"operation" api:"required"`
	// A list of cache tag values.
	Values []string                                                                               `json:"values" api:"required"`
	JSON   phaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesJSON `json:"-"`
}

Add cache tags using a list of values.

func (*PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues) UnmarshalJSON added in v6.9.0 

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

type PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation string

The operation to perform on the cache tags. 

const (
	PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationAdd    PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "add"
	PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationRemove PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "remove"
	PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationSet    PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "set"
)

func (PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation) IsKnown() bool

type PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation string

The operation to perform on the cache tags. 

const (
	PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersOperationAdd    PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation = "add"
	PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersOperationRemove PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation = "remove"
	PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersOperationSet    PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation = "set"
)

func (PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation) IsKnown() bool

type PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression struct {
	// An expression that evaluates to an array of cache tag values.
	Expression string `json:"expression" api:"required"`
	// The operation to perform on the cache tags.
	Operation PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation `json:"operation" api:"required"`
	JSON      phaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionJSON      `json:"-"`
}

Remove cache tags using an expression.

func (*PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression) UnmarshalJSON added in v6.9.0 

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

type PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation string

The operation to perform on the cache tags. 

const (
	PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationAdd    PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "add"
	PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationRemove PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "remove"
	PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationSet    PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "set"
)

func (PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation) IsKnown() bool

type PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues struct {
	// The operation to perform on the cache tags.
	Operation PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation `json:"operation" api:"required"`
	// A list of cache tag values.
	Values []string                                                                                  `json:"values" api:"required"`
	JSON   phaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesJSON `json:"-"`
}

Remove cache tags using a list of values.

func (*PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues) UnmarshalJSON added in v6.9.0 

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

type PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation string

The operation to perform on the cache tags. 

const (
	PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationAdd    PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "add"
	PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationRemove PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "remove"
	PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationSet    PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "set"
)

func (PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation) IsKnown() bool

type PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression struct {
	// An expression that evaluates to an array of cache tag values.
	Expression string `json:"expression" api:"required"`
	// The operation to perform on the cache tags.
	Operation PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation `json:"operation" api:"required"`
	JSON      phaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionJSON      `json:"-"`
}

Set cache tags using an expression.

func (*PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression) UnmarshalJSON added in v6.9.0 

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

type PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation string

The operation to perform on the cache tags. 

const (
	PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationAdd    PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "add"
	PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationRemove PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "remove"
	PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationSet    PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "set"
)

func (PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation) IsKnown() bool

type PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues struct {
	// The operation to perform on the cache tags.
	Operation PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation `json:"operation" api:"required"`
	// A list of cache tag values.
	Values []string                                                                               `json:"values" api:"required"`
	JSON   phaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesJSON `json:"-"`
}

Set cache tags using a list of values.

func (*PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues) UnmarshalJSON added in v6.9.0 

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

type PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation string

The operation to perform on the cache tags. 

const (
	PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationAdd    PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "add"
	PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationRemove PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "remove"
	PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationSet    PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "set"
)

func (PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation) IsKnown added in v6.9.0 

func (r PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation) IsKnown() bool

type PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersUnion added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersUnion interface {
	// contains filtered or unexported methods
}

The parameters configuring the rule's action.

Union satisfied by PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues, PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression, PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues, PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression, PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues or PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression.

type PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleExposedCredentialCheck added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleExposedCredentialCheck struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression string `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression string                                                                     `json:"username_expression" api:"required"`
	JSON               phaseUpdateResponseRulesRulesetsSetCacheTagsRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleExposedCredentialCheck) UnmarshalJSON added in v6.9.0 

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

type PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleRatelimit added in v6.9.0 

type PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleRatelimit struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics []string `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period int64 `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression string `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout int64 `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod int64 `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin bool `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod int64 `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName string                                                        `json:"score_response_header_name"`
	JSON                    phaseUpdateResponseRulesRulesetsSetCacheTagsRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*PhaseUpdateResponseRulesRulesetsSetCacheTagsRuleRatelimit) UnmarshalJSON added in v6.9.0 

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

type PhaseUpdateResponseRulesUnion 

type PhaseUpdateResponseRulesUnion interface {
	// contains filtered or unexported methods
}

Union satisfied by BlockRule, PhaseUpdateResponseRulesRulesetsChallengeRule, CompressResponseRule, DDoSDynamicRule, ExecuteRule, ForceConnectionCloseRule, PhaseUpdateResponseRulesRulesetsJSChallengeRule, LogRule, LogCustomFieldRule, ManagedChallengeRule, RedirectRule, RewriteRule, RouteRule, ScoreRule, ServeErrorRule, PhaseUpdateResponseRulesRulesetsSetCacheControlRule, SetCacheSettingsRule, PhaseUpdateResponseRulesRulesetsSetCacheTagsRule, SetConfigRule or SkipRule.

type PhaseVersionGetParams 

type PhaseVersionGetParams struct {
	// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
	AccountID param.Field[string] `path:"account_id"`
	// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
	ZoneID param.Field[string] `path:"zone_id"`
}

type PhaseVersionGetResponse 

type PhaseVersionGetResponse struct {
	// The unique ID of the ruleset.
	ID string `json:"id" api:"required"`
	// The kind of the ruleset.
	Kind Kind `json:"kind" api:"required"`
	// The timestamp of when the ruleset was last modified.
	LastUpdated time.Time `json:"last_updated" api:"required" format:"date-time"`
	// The human-readable name of the ruleset.
	Name string `json:"name" api:"required"`
	// The phase of the ruleset.
	Phase Phase `json:"phase" api:"required"`
	// The list of rules in the ruleset.
	Rules []PhaseVersionGetResponseRule `json:"rules" api:"required"`
	// The version of the ruleset.
	Version string `json:"version" api:"required"`
	// An informative description of the ruleset.
	Description string                      `json:"description"`
	JSON        phaseVersionGetResponseJSON `json:"-"`
}

A ruleset object.

func (*PhaseVersionGetResponse) UnmarshalJSON 

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

type PhaseVersionGetResponseEnvelope 

type PhaseVersionGetResponseEnvelope struct {
	// A list of error messages.
	Errors []PhaseVersionGetResponseEnvelopeErrors `json:"errors" api:"required"`
	// A list of warning messages.
	Messages []PhaseVersionGetResponseEnvelopeMessages `json:"messages" api:"required"`
	// A ruleset object.
	Result PhaseVersionGetResponse `json:"result" api:"required"`
	// Whether the API call was successful.
	Success PhaseVersionGetResponseEnvelopeSuccess `json:"success" api:"required"`
	JSON    phaseVersionGetResponseEnvelopeJSON    `json:"-"`
}

A response object.

func (*PhaseVersionGetResponseEnvelope) UnmarshalJSON 

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

type PhaseVersionGetResponseEnvelopeErrors 

type PhaseVersionGetResponseEnvelopeErrors struct {
	// A text description of this message.
	Message string `json:"message" api:"required"`
	// A unique code for this message.
	Code int64 `json:"code"`
	// The source of this message.
	Source PhaseVersionGetResponseEnvelopeErrorsSource `json:"source"`
	JSON   phaseVersionGetResponseEnvelopeErrorsJSON   `json:"-"`
}

A message.

func (*PhaseVersionGetResponseEnvelopeErrors) UnmarshalJSON 

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

type PhaseVersionGetResponseEnvelopeErrorsSource 

type PhaseVersionGetResponseEnvelopeErrorsSource struct {
	// A JSON pointer to the field that is the source of the message.
	Pointer string                                          `json:"pointer" api:"required"`
	JSON    phaseVersionGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}

The source of this message.

func (*PhaseVersionGetResponseEnvelopeErrorsSource) UnmarshalJSON 

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

type PhaseVersionGetResponseEnvelopeMessages 

type PhaseVersionGetResponseEnvelopeMessages struct {
	// A text description of this message.
	Message string `json:"message" api:"required"`
	// A unique code for this message.
	Code int64 `json:"code"`
	// The source of this message.
	Source PhaseVersionGetResponseEnvelopeMessagesSource `json:"source"`
	JSON   phaseVersionGetResponseEnvelopeMessagesJSON   `json:"-"`
}

A message.

func (*PhaseVersionGetResponseEnvelopeMessages) UnmarshalJSON 

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

type PhaseVersionGetResponseEnvelopeMessagesSource 

type PhaseVersionGetResponseEnvelopeMessagesSource struct {
	// A JSON pointer to the field that is the source of the message.
	Pointer string                                            `json:"pointer" api:"required"`
	JSON    phaseVersionGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}

The source of this message.

func (*PhaseVersionGetResponseEnvelopeMessagesSource) UnmarshalJSON 

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

type PhaseVersionGetResponseEnvelopeSuccess 

type PhaseVersionGetResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	PhaseVersionGetResponseEnvelopeSuccessTrue PhaseVersionGetResponseEnvelopeSuccess = true
)

func (PhaseVersionGetResponseEnvelopeSuccess) IsKnown 

func (r PhaseVersionGetResponseEnvelopeSuccess) IsKnown() bool

type PhaseVersionGetResponseRule 

type PhaseVersionGetResponseRule struct {
	// The timestamp of when the rule was last modified.
	LastUpdated time.Time `json:"last_updated" api:"required" format:"date-time"`
	// The version of the rule.
	Version string `json:"version" api:"required"`
	// The unique ID of the rule.
	ID string `json:"id"`
	// The action to perform when the rule matches.
	Action PhaseVersionGetResponseRulesAction `json:"action"`
	// This field can have the runtime type of [BlockRuleActionParameters],
	// [interface{}], [CompressResponseRuleActionParameters],
	// [ExecuteRuleActionParameters], [LogCustomFieldRuleActionParameters],
	// [RedirectRuleActionParameters], [RewriteRuleActionParameters],
	// [RouteRuleActionParameters], [ScoreRuleActionParameters],
	// [ServeErrorRuleActionParameters],
	// [PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParameters],
	// [SetCacheSettingsRuleActionParameters],
	// [PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParameters],
	// [SetConfigRuleActionParameters], [SkipRuleActionParameters].
	ActionParameters interface{} `json:"action_parameters"`
	// This field can have the runtime type of [[]string].
	Categories interface{} `json:"categories"`
	// An informative description of the rule.
	Description string `json:"description"`
	// Whether the rule should be executed.
	Enabled bool `json:"enabled"`
	// This field can have the runtime type of [BlockRuleExposedCredentialCheck],
	// [PhaseVersionGetResponseRulesRulesetsChallengeRuleExposedCredentialCheck],
	// [CompressResponseRuleExposedCredentialCheck],
	// [DDoSDynamicRuleExposedCredentialCheck], [ExecuteRuleExposedCredentialCheck],
	// [ForceConnectionCloseRuleExposedCredentialCheck],
	// [PhaseVersionGetResponseRulesRulesetsJSChallengeRuleExposedCredentialCheck],
	// [LogRuleExposedCredentialCheck], [LogCustomFieldRuleExposedCredentialCheck],
	// [ManagedChallengeRuleExposedCredentialCheck],
	// [RedirectRuleExposedCredentialCheck], [RewriteRuleExposedCredentialCheck],
	// [RouteRuleExposedCredentialCheck], [ScoreRuleExposedCredentialCheck],
	// [ServeErrorRuleExposedCredentialCheck],
	// [PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleExposedCredentialCheck],
	// [SetCacheSettingsRuleExposedCredentialCheck],
	// [PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleExposedCredentialCheck],
	// [SetConfigRuleExposedCredentialCheck], [SkipRuleExposedCredentialCheck].
	ExposedCredentialCheck interface{} `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression string `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging Logging `json:"logging"`
	// This field can have the runtime type of [BlockRuleRatelimit],
	// [PhaseVersionGetResponseRulesRulesetsChallengeRuleRatelimit],
	// [CompressResponseRuleRatelimit], [DDoSDynamicRuleRatelimit],
	// [ExecuteRuleRatelimit], [ForceConnectionCloseRuleRatelimit],
	// [PhaseVersionGetResponseRulesRulesetsJSChallengeRuleRatelimit],
	// [LogRuleRatelimit], [LogCustomFieldRuleRatelimit],
	// [ManagedChallengeRuleRatelimit], [RedirectRuleRatelimit],
	// [RewriteRuleRatelimit], [RouteRuleRatelimit], [ScoreRuleRatelimit],
	// [ServeErrorRuleRatelimit],
	// [PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleRatelimit],
	// [SetCacheSettingsRuleRatelimit],
	// [PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleRatelimit],
	// [SetConfigRuleRatelimit], [SkipRuleRatelimit].
	Ratelimit interface{} `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                          `json:"ref"`
	JSON phaseVersionGetResponseRuleJSON `json:"-"`
	// contains filtered or unexported fields
}

func (PhaseVersionGetResponseRule) AsUnion 

func (r PhaseVersionGetResponseRule) AsUnion() PhaseVersionGetResponseRulesUnion

AsUnion returns a PhaseVersionGetResponseRulesUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are BlockRule, PhaseVersionGetResponseRulesRulesetsChallengeRule, CompressResponseRule, DDoSDynamicRule, ExecuteRule, ForceConnectionCloseRule, PhaseVersionGetResponseRulesRulesetsJSChallengeRule, LogRule, LogCustomFieldRule, ManagedChallengeRule, RedirectRule, RewriteRule, RouteRule, ScoreRule, ServeErrorRule, PhaseVersionGetResponseRulesRulesetsSetCacheControlRule, SetCacheSettingsRule, PhaseVersionGetResponseRulesRulesetsSetCacheTagsRule, SetConfigRule, SkipRule.

func (*PhaseVersionGetResponseRule) UnmarshalJSON 

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

type PhaseVersionGetResponseRulesAction 

type PhaseVersionGetResponseRulesAction string

The action to perform when the rule matches. 

const (
	PhaseVersionGetResponseRulesActionBlock                PhaseVersionGetResponseRulesAction = "block"
	PhaseVersionGetResponseRulesActionChallenge            PhaseVersionGetResponseRulesAction = "challenge"
	PhaseVersionGetResponseRulesActionCompressResponse     PhaseVersionGetResponseRulesAction = "compress_response"
	PhaseVersionGetResponseRulesActionDDoSDynamic          PhaseVersionGetResponseRulesAction = "ddos_dynamic"
	PhaseVersionGetResponseRulesActionExecute              PhaseVersionGetResponseRulesAction = "execute"
	PhaseVersionGetResponseRulesActionForceConnectionClose PhaseVersionGetResponseRulesAction = "force_connection_close"
	PhaseVersionGetResponseRulesActionJSChallenge          PhaseVersionGetResponseRulesAction = "js_challenge"
	PhaseVersionGetResponseRulesActionLog                  PhaseVersionGetResponseRulesAction = "log"
	PhaseVersionGetResponseRulesActionLogCustomField       PhaseVersionGetResponseRulesAction = "log_custom_field"
	PhaseVersionGetResponseRulesActionManagedChallenge     PhaseVersionGetResponseRulesAction = "managed_challenge"
	PhaseVersionGetResponseRulesActionRedirect             PhaseVersionGetResponseRulesAction = "redirect"
	PhaseVersionGetResponseRulesActionRewrite              PhaseVersionGetResponseRulesAction = "rewrite"
	PhaseVersionGetResponseRulesActionRoute                PhaseVersionGetResponseRulesAction = "route"
	PhaseVersionGetResponseRulesActionScore                PhaseVersionGetResponseRulesAction = "score"
	PhaseVersionGetResponseRulesActionServeError           PhaseVersionGetResponseRulesAction = "serve_error"
	PhaseVersionGetResponseRulesActionSetCacheControl      PhaseVersionGetResponseRulesAction = "set_cache_control"
	PhaseVersionGetResponseRulesActionSetCacheSettings     PhaseVersionGetResponseRulesAction = "set_cache_settings"
	PhaseVersionGetResponseRulesActionSetCacheTags         PhaseVersionGetResponseRulesAction = "set_cache_tags"
	PhaseVersionGetResponseRulesActionSetConfig            PhaseVersionGetResponseRulesAction = "set_config"
	PhaseVersionGetResponseRulesActionSkip                 PhaseVersionGetResponseRulesAction = "skip"
)

func (PhaseVersionGetResponseRulesAction) IsKnown 

func (r PhaseVersionGetResponseRulesAction) IsKnown() bool

type PhaseVersionGetResponseRulesRulesetsChallengeRule 

type PhaseVersionGetResponseRulesRulesetsChallengeRule struct {
	// The timestamp of when the rule was last modified.
	LastUpdated time.Time `json:"last_updated" api:"required" format:"date-time"`
	// The version of the rule.
	Version string `json:"version" api:"required"`
	// The unique ID of the rule.
	ID string `json:"id"`
	// The action to perform when the rule matches.
	Action PhaseVersionGetResponseRulesRulesetsChallengeRuleAction `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters interface{} `json:"action_parameters"`
	// The categories of the rule.
	Categories []string `json:"categories"`
	// An informative description of the rule.
	Description string `json:"description"`
	// Whether the rule should be executed.
	Enabled bool `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck PhaseVersionGetResponseRulesRulesetsChallengeRuleExposedCredentialCheck `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression string `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging Logging `json:"logging"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit PhaseVersionGetResponseRulesRulesetsChallengeRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                                                `json:"ref"`
	JSON phaseVersionGetResponseRulesRulesetsChallengeRuleJSON `json:"-"`
}

func (*PhaseVersionGetResponseRulesRulesetsChallengeRule) UnmarshalJSON 

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

type PhaseVersionGetResponseRulesRulesetsChallengeRuleAction 

type PhaseVersionGetResponseRulesRulesetsChallengeRuleAction string

The action to perform when the rule matches. 

const (
	PhaseVersionGetResponseRulesRulesetsChallengeRuleActionChallenge PhaseVersionGetResponseRulesRulesetsChallengeRuleAction = "challenge"
)

func (PhaseVersionGetResponseRulesRulesetsChallengeRuleAction) IsKnown 

func (r PhaseVersionGetResponseRulesRulesetsChallengeRuleAction) IsKnown() bool

type PhaseVersionGetResponseRulesRulesetsChallengeRuleExposedCredentialCheck 

type PhaseVersionGetResponseRulesRulesetsChallengeRuleExposedCredentialCheck struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression string `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression string                                                                      `json:"username_expression" api:"required"`
	JSON               phaseVersionGetResponseRulesRulesetsChallengeRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*PhaseVersionGetResponseRulesRulesetsChallengeRuleExposedCredentialCheck) UnmarshalJSON 

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

type PhaseVersionGetResponseRulesRulesetsChallengeRuleRatelimit 

type PhaseVersionGetResponseRulesRulesetsChallengeRuleRatelimit struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics []string `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period int64 `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression string `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout int64 `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod int64 `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin bool `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod int64 `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName string                                                         `json:"score_response_header_name"`
	JSON                    phaseVersionGetResponseRulesRulesetsChallengeRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*PhaseVersionGetResponseRulesRulesetsChallengeRuleRatelimit) UnmarshalJSON 

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

type PhaseVersionGetResponseRulesRulesetsJSChallengeRule 

type PhaseVersionGetResponseRulesRulesetsJSChallengeRule struct {
	// The timestamp of when the rule was last modified.
	LastUpdated time.Time `json:"last_updated" api:"required" format:"date-time"`
	// The version of the rule.
	Version string `json:"version" api:"required"`
	// The unique ID of the rule.
	ID string `json:"id"`
	// The action to perform when the rule matches.
	Action PhaseVersionGetResponseRulesRulesetsJSChallengeRuleAction `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters interface{} `json:"action_parameters"`
	// The categories of the rule.
	Categories []string `json:"categories"`
	// An informative description of the rule.
	Description string `json:"description"`
	// Whether the rule should be executed.
	Enabled bool `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck PhaseVersionGetResponseRulesRulesetsJSChallengeRuleExposedCredentialCheck `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression string `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging Logging `json:"logging"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit PhaseVersionGetResponseRulesRulesetsJSChallengeRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                                                  `json:"ref"`
	JSON phaseVersionGetResponseRulesRulesetsJSChallengeRuleJSON `json:"-"`
}

func (*PhaseVersionGetResponseRulesRulesetsJSChallengeRule) UnmarshalJSON 

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

type PhaseVersionGetResponseRulesRulesetsJSChallengeRuleAction 

type PhaseVersionGetResponseRulesRulesetsJSChallengeRuleAction string

The action to perform when the rule matches. 

const (
	PhaseVersionGetResponseRulesRulesetsJSChallengeRuleActionJSChallenge PhaseVersionGetResponseRulesRulesetsJSChallengeRuleAction = "js_challenge"
)

func (PhaseVersionGetResponseRulesRulesetsJSChallengeRuleAction) IsKnown 

func (r PhaseVersionGetResponseRulesRulesetsJSChallengeRuleAction) IsKnown() bool

type PhaseVersionGetResponseRulesRulesetsJSChallengeRuleExposedCredentialCheck 

type PhaseVersionGetResponseRulesRulesetsJSChallengeRuleExposedCredentialCheck struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression string `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression string                                                                        `json:"username_expression" api:"required"`
	JSON               phaseVersionGetResponseRulesRulesetsJSChallengeRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*PhaseVersionGetResponseRulesRulesetsJSChallengeRuleExposedCredentialCheck) UnmarshalJSON 

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

type PhaseVersionGetResponseRulesRulesetsJSChallengeRuleRatelimit 

type PhaseVersionGetResponseRulesRulesetsJSChallengeRuleRatelimit struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics []string `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period int64 `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression string `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout int64 `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod int64 `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin bool `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod int64 `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName string                                                           `json:"score_response_header_name"`
	JSON                    phaseVersionGetResponseRulesRulesetsJSChallengeRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*PhaseVersionGetResponseRulesRulesetsJSChallengeRuleRatelimit) UnmarshalJSON 

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

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRule added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRule struct {
	// The timestamp of when the rule was last modified.
	LastUpdated time.Time `json:"last_updated" api:"required" format:"date-time"`
	// The version of the rule.
	Version string `json:"version" api:"required"`
	// The unique ID of the rule.
	ID string `json:"id"`
	// The action to perform when the rule matches.
	Action PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleAction `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParameters `json:"action_parameters"`
	// The categories of the rule.
	Categories []string `json:"categories"`
	// An informative description of the rule.
	Description string `json:"description"`
	// Whether the rule should be executed.
	Enabled bool `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleExposedCredentialCheck `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression string `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging Logging `json:"logging"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                                                      `json:"ref"`
	JSON phaseVersionGetResponseRulesRulesetsSetCacheControlRuleJSON `json:"-"`
}

func (*PhaseVersionGetResponseRulesRulesetsSetCacheControlRule) UnmarshalJSON added in v6.9.0 

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

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleAction added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleAction string

The action to perform when the rule matches. 

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionSetCacheControl PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleAction = "set_cache_control"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleAction) IsKnown added in v6.9.0 

func (r PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleAction) IsKnown() bool

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParameters added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParameters struct {
	// A cache-control directive configuration.
	Immutable PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutable `json:"immutable"`
	// A cache-control directive configuration that accepts a duration value in
	// seconds.
	MaxAge PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAge `json:"max-age"`
	// A cache-control directive configuration.
	MustRevalidate PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate `json:"must-revalidate"`
	// A cache-control directive configuration.
	MustUnderstand PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand `json:"must-understand"`
	// A cache-control directive configuration that accepts optional qualifiers (header
	// names).
	NoCache PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCache `json:"no-cache"`
	// A cache-control directive configuration.
	NoStore PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStore `json:"no-store"`
	// A cache-control directive configuration.
	NoTransform PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransform `json:"no-transform"`
	// A cache-control directive configuration that accepts optional qualifiers (header
	// names).
	Private PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivate `json:"private"`
	// A cache-control directive configuration.
	ProxyRevalidate PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate `json:"proxy-revalidate"`
	// A cache-control directive configuration.
	Public PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublic `json:"public"`
	// A cache-control directive configuration that accepts a duration value in
	// seconds.
	SMaxage PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxage `json:"s-maxage"`
	// A cache-control directive configuration that accepts a duration value in
	// seconds.
	StaleIfError PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfError `json:"stale-if-error"`
	// A cache-control directive configuration that accepts a duration value in
	// seconds.
	StaleWhileRevalidate PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate `json:"stale-while-revalidate"`
	JSON                 phaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersJSON                 `json:"-"`
}

The parameters configuring the rule's action.

func (*PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParameters) UnmarshalJSON added in v6.9.0 

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

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutable added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutable struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                 `json:"cloudflare_only"`
	JSON           phaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration.

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutable) AsUnion added in v6.9.0 

func (r PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutable) AsUnion() PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableUnion

AsUnion returns a PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective, PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective.

func (*PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutable) UnmarshalJSON added in v6.9.0 

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

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation = "set"
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation = "remove"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation) IsKnown added in v6.9.0 

func (r PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation) IsKnown() bool

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                                `json:"cloudflare_only"`
	JSON           phaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective) UnmarshalJSON added in v6.9.0 

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

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation = "set"
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation = "remove"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation) IsKnown() bool

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                             `json:"cloudflare_only"`
	JSON           phaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveJSON `json:"-"`
}

Set the directive.

func (*PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective) UnmarshalJSON added in v6.9.0 

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

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation = "set"
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation = "remove"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation) IsKnown() bool

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableUnion added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Union satisfied by PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective or PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective.

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAge added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAge struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool `json:"cloudflare_only"`
	// The duration value in seconds for the directive.
	Value int64                                                                             `json:"value"`
	JSON  phaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration that accepts a duration value in seconds.

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAge) AsUnion added in v6.9.0 

func (r PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAge) AsUnion() PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeUnion

AsUnion returns a PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective, PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective.

func (*PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAge) UnmarshalJSON added in v6.9.0 

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

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation = "set"
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation = "remove"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation) IsKnown added in v6.9.0 

func (r PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation) IsKnown() bool

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                             `json:"cloudflare_only"`
	JSON           phaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective) UnmarshalJSON added in v6.9.0 

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

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation = "set"
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation = "remove"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation) IsKnown() bool

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation `json:"operation" api:"required"`
	// The duration value in seconds for the directive.
	Value int64 `json:"value" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                          `json:"cloudflare_only"`
	JSON           phaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveJSON `json:"-"`
}

Set the directive with a duration value in seconds.

func (*PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective) UnmarshalJSON added in v6.9.0 

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

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation = "set"
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation = "remove"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation) IsKnown() bool

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeUnion added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts a duration value in seconds.

Union satisfied by PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective or PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective.

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                      `json:"cloudflare_only"`
	JSON           phaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration.

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate) AsUnion added in v6.9.0 

func (r PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate) AsUnion() PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateUnion

AsUnion returns a PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective, PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective.

func (*PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate) UnmarshalJSON added in v6.9.0 

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

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation = "set"
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation = "remove"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation) IsKnown added in v6.9.0 

func (r PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation) IsKnown() bool

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                                     `json:"cloudflare_only"`
	JSON           phaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective) UnmarshalJSON added in v6.9.0 

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

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation = "set"
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation = "remove"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation) IsKnown() bool

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                                  `json:"cloudflare_only"`
	JSON           phaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveJSON `json:"-"`
}

Set the directive.

func (*PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective) UnmarshalJSON added in v6.9.0 

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

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation = "set"
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation = "remove"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation) IsKnown() bool

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateUnion added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Union satisfied by PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective or PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective.

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                      `json:"cloudflare_only"`
	JSON           phaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration.

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand) AsUnion added in v6.9.0 

func (r PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand) AsUnion() PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandUnion

AsUnion returns a PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective, PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective.

func (*PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand) UnmarshalJSON added in v6.9.0 

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

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation = "set"
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation = "remove"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation) IsKnown added in v6.9.0 

func (r PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation) IsKnown() bool

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                                     `json:"cloudflare_only"`
	JSON           phaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective) UnmarshalJSON added in v6.9.0 

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

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation = "set"
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation = "remove"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation) IsKnown() bool

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                                  `json:"cloudflare_only"`
	JSON           phaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveJSON `json:"-"`
}

Set the directive.

func (*PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective) UnmarshalJSON added in v6.9.0 

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

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation = "set"
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation = "remove"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation) IsKnown() bool

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandUnion added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Union satisfied by PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective or PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective.

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCache added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCache struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool `json:"cloudflare_only"`
	// This field can have the runtime type of [[]string].
	Qualifiers interface{}                                                                        `json:"qualifiers"`
	JSON       phaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration that accepts optional qualifiers (header names).

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCache) AsUnion added in v6.9.0 

func (r PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCache) AsUnion() PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheUnion

AsUnion returns a PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective, PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective.

func (*PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCache) UnmarshalJSON added in v6.9.0 

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

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation = "set"
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation = "remove"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation) IsKnown added in v6.9.0 

func (r PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation) IsKnown() bool

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                              `json:"cloudflare_only"`
	JSON           phaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective) UnmarshalJSON added in v6.9.0 

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

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation = "set"
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation = "remove"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation) IsKnown() bool

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool `json:"cloudflare_only"`
	// Optional list of header names to qualify the directive (e.g., for "private" or
	// "no-cache" directives).
	Qualifiers []string                                                                                       `json:"qualifiers"`
	JSON       phaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveJSON `json:"-"`
}

Set the directive with optional qualifiers.

func (*PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective) UnmarshalJSON added in v6.9.0 

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

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation = "set"
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation = "remove"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation) IsKnown() bool

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheUnion added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts optional qualifiers (header names).

Union satisfied by PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective or PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective.

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStore added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStore struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                               `json:"cloudflare_only"`
	JSON           phaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration.

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStore) AsUnion added in v6.9.0 

func (r PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStore) AsUnion() PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreUnion

AsUnion returns a PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective, PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective.

func (*PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStore) UnmarshalJSON added in v6.9.0 

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

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation = "set"
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation = "remove"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation) IsKnown added in v6.9.0 

func (r PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation) IsKnown() bool

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                              `json:"cloudflare_only"`
	JSON           phaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective) UnmarshalJSON added in v6.9.0 

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

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation = "set"
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation = "remove"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation) IsKnown() bool

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                           `json:"cloudflare_only"`
	JSON           phaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveJSON `json:"-"`
}

Set the directive.

func (*PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective) UnmarshalJSON added in v6.9.0 

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

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation = "set"
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation = "remove"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation) IsKnown() bool

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreUnion added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Union satisfied by PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective or PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective.

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransform added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransform struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                   `json:"cloudflare_only"`
	JSON           phaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration.

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransform) AsUnion added in v6.9.0 

func (r PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransform) AsUnion() PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformUnion

AsUnion returns a PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective, PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective.

func (*PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransform) UnmarshalJSON added in v6.9.0 

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

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation = "set"
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation = "remove"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation) IsKnown added in v6.9.0 

func (r PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation) IsKnown() bool

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                                  `json:"cloudflare_only"`
	JSON           phaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective) UnmarshalJSON added in v6.9.0 

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

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation = "set"
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation = "remove"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation) IsKnown() bool

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                               `json:"cloudflare_only"`
	JSON           phaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveJSON `json:"-"`
}

Set the directive.

func (*PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective) UnmarshalJSON added in v6.9.0 

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

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation = "set"
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation = "remove"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation) IsKnown() bool

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformUnion added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Union satisfied by PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective or PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective.

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivate added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivate struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool `json:"cloudflare_only"`
	// This field can have the runtime type of [[]string].
	Qualifiers interface{}                                                                        `json:"qualifiers"`
	JSON       phaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration that accepts optional qualifiers (header names).

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivate) AsUnion added in v6.9.0 

func (r PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivate) AsUnion() PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateUnion

AsUnion returns a PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective, PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective.

func (*PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivate) UnmarshalJSON added in v6.9.0 

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

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation = "set"
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation = "remove"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation) IsKnown added in v6.9.0 

func (r PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation) IsKnown() bool

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                              `json:"cloudflare_only"`
	JSON           phaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective) UnmarshalJSON added in v6.9.0 

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

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation = "set"
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation = "remove"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation) IsKnown() bool

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool `json:"cloudflare_only"`
	// Optional list of header names to qualify the directive (e.g., for "private" or
	// "no-cache" directives).
	Qualifiers []string                                                                                       `json:"qualifiers"`
	JSON       phaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveJSON `json:"-"`
}

Set the directive with optional qualifiers.

func (*PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective) UnmarshalJSON added in v6.9.0 

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

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation = "set"
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation = "remove"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation) IsKnown() bool

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateUnion added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts optional qualifiers (header names).

Union satisfied by PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective or PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective.

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                       `json:"cloudflare_only"`
	JSON           phaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration.

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate) AsUnion added in v6.9.0 

func (r PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate) AsUnion() PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateUnion

AsUnion returns a PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective, PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective.

func (*PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate) UnmarshalJSON added in v6.9.0 

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

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation = "set"
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation = "remove"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation) IsKnown added in v6.9.0 

func (r PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation) IsKnown() bool

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                                      `json:"cloudflare_only"`
	JSON           phaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective) UnmarshalJSON added in v6.9.0 

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

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation = "set"
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation = "remove"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation) IsKnown() bool

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                                   `json:"cloudflare_only"`
	JSON           phaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveJSON `json:"-"`
}

Set the directive.

func (*PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective) UnmarshalJSON added in v6.9.0 

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

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation = "set"
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation = "remove"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation) IsKnown() bool

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateUnion added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Union satisfied by PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective or PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective.

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublic added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublic struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                              `json:"cloudflare_only"`
	JSON           phaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration.

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublic) AsUnion added in v6.9.0 

func (r PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublic) AsUnion() PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicUnion

AsUnion returns a PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective, PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective.

func (*PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublic) UnmarshalJSON added in v6.9.0 

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

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation = "set"
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation = "remove"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation) IsKnown added in v6.9.0 

func (r PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation) IsKnown() bool

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                             `json:"cloudflare_only"`
	JSON           phaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective) UnmarshalJSON added in v6.9.0 

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

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation = "set"
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation = "remove"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation) IsKnown() bool

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                          `json:"cloudflare_only"`
	JSON           phaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveJSON `json:"-"`
}

Set the directive.

func (*PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective) UnmarshalJSON added in v6.9.0 

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

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation = "set"
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation = "remove"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation) IsKnown() bool

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicUnion added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Union satisfied by PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective or PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective.

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxage added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxage struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool `json:"cloudflare_only"`
	// The duration value in seconds for the directive.
	Value int64                                                                              `json:"value"`
	JSON  phaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration that accepts a duration value in seconds.

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxage) AsUnion added in v6.9.0 

func (r PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxage) AsUnion() PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageUnion

AsUnion returns a PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective, PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective.

func (*PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxage) UnmarshalJSON added in v6.9.0 

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

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation = "set"
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation = "remove"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation) IsKnown added in v6.9.0 

func (r PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation) IsKnown() bool

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                              `json:"cloudflare_only"`
	JSON           phaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective) UnmarshalJSON added in v6.9.0 

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

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation = "set"
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation = "remove"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation) IsKnown() bool

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation `json:"operation" api:"required"`
	// The duration value in seconds for the directive.
	Value int64 `json:"value" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                           `json:"cloudflare_only"`
	JSON           phaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveJSON `json:"-"`
}

Set the directive with a duration value in seconds.

func (*PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective) UnmarshalJSON added in v6.9.0 

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

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation = "set"
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation = "remove"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation) IsKnown() bool

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageUnion added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts a duration value in seconds.

Union satisfied by PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective or PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective.

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfError added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfError struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool `json:"cloudflare_only"`
	// The duration value in seconds for the directive.
	Value int64                                                                                   `json:"value"`
	JSON  phaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration that accepts a duration value in seconds.

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfError) AsUnion added in v6.9.0 

func (r PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfError) AsUnion() PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorUnion

AsUnion returns a PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective, PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective.

func (*PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfError) UnmarshalJSON added in v6.9.0 

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

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation = "set"
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation = "remove"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation) IsKnown added in v6.9.0 

func (r PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation) IsKnown() bool

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                                   `json:"cloudflare_only"`
	JSON           phaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective) UnmarshalJSON added in v6.9.0 

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

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation = "set"
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation = "remove"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation) IsKnown() bool

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation `json:"operation" api:"required"`
	// The duration value in seconds for the directive.
	Value int64 `json:"value" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                                `json:"cloudflare_only"`
	JSON           phaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveJSON `json:"-"`
}

Set the directive with a duration value in seconds.

func (*PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective) UnmarshalJSON added in v6.9.0 

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

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation = "set"
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation = "remove"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation) IsKnown() bool

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorUnion added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts a duration value in seconds.

Union satisfied by PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective or PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective.

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool `json:"cloudflare_only"`
	// The duration value in seconds for the directive.
	Value int64                                                                                           `json:"value"`
	JSON  phaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration that accepts a duration value in seconds.

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate) AsUnion added in v6.9.0 

func (r PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate) AsUnion() PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateUnion

AsUnion returns a PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective, PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective.

func (*PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate) UnmarshalJSON added in v6.9.0 

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

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation = "set"
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation = "remove"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation) IsKnown added in v6.9.0 

func (r PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation) IsKnown() bool

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                                           `json:"cloudflare_only"`
	JSON           phaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective) UnmarshalJSON added in v6.9.0 

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

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation = "set"
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation = "remove"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation) IsKnown() bool

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation `json:"operation" api:"required"`
	// The duration value in seconds for the directive.
	Value int64 `json:"value" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                                        `json:"cloudflare_only"`
	JSON           phaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveJSON `json:"-"`
}

Set the directive with a duration value in seconds.

func (*PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective) UnmarshalJSON added in v6.9.0 

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

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation = "set"
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation = "remove"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation) IsKnown added in v6.9.0 

func (r PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation) IsKnown() bool

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateUnion added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts a duration value in seconds.

Union satisfied by PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective or PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective.

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleExposedCredentialCheck added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleExposedCredentialCheck struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression string `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression string                                                                            `json:"username_expression" api:"required"`
	JSON               phaseVersionGetResponseRulesRulesetsSetCacheControlRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleExposedCredentialCheck) UnmarshalJSON added in v6.9.0 

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

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleRatelimit added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleRatelimit struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics []string `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period int64 `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression string `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout int64 `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod int64 `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin bool `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod int64 `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName string                                                               `json:"score_response_header_name"`
	JSON                    phaseVersionGetResponseRulesRulesetsSetCacheControlRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleRatelimit) UnmarshalJSON added in v6.9.0 

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

type PhaseVersionGetResponseRulesRulesetsSetCacheTagsRule added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheTagsRule struct {
	// The timestamp of when the rule was last modified.
	LastUpdated time.Time `json:"last_updated" api:"required" format:"date-time"`
	// The version of the rule.
	Version string `json:"version" api:"required"`
	// The unique ID of the rule.
	ID string `json:"id"`
	// The action to perform when the rule matches.
	Action PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleAction `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParameters `json:"action_parameters"`
	// The categories of the rule.
	Categories []string `json:"categories"`
	// An informative description of the rule.
	Description string `json:"description"`
	// Whether the rule should be executed.
	Enabled bool `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleExposedCredentialCheck `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression string `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging Logging `json:"logging"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                                                   `json:"ref"`
	JSON phaseVersionGetResponseRulesRulesetsSetCacheTagsRuleJSON `json:"-"`
}

func (*PhaseVersionGetResponseRulesRulesetsSetCacheTagsRule) UnmarshalJSON added in v6.9.0 

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

type PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleAction added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleAction string

The action to perform when the rule matches. 

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionSetCacheTags PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleAction = "set_cache_tags"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleAction) IsKnown added in v6.9.0 

func (r PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleAction) IsKnown() bool

type PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParameters added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParameters struct {
	// The operation to perform on the cache tags.
	Operation PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation `json:"operation" api:"required"`
	// An expression that evaluates to an array of cache tag values.
	Expression string `json:"expression"`
	// This field can have the runtime type of [[]string].
	Values interface{}                                                              `json:"values"`
	JSON   phaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersJSON `json:"-"`
	// contains filtered or unexported fields
}

The parameters configuring the rule's action.

func (PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParameters) AsUnion added in v6.9.0 

func (r PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParameters) AsUnion() PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersUnion

AsUnion returns a PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues, PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression, PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues, PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression, PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues, PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression.

func (*PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParameters) UnmarshalJSON added in v6.9.0 

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

type PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression struct {
	// An expression that evaluates to an array of cache tag values.
	Expression string `json:"expression" api:"required"`
	// The operation to perform on the cache tags.
	Operation PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation `json:"operation" api:"required"`
	JSON      phaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionJSON      `json:"-"`
}

Add cache tags using an expression.

func (*PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression) UnmarshalJSON added in v6.9.0 

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

type PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation string

The operation to perform on the cache tags. 

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationAdd    PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "add"
	PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "remove"
	PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "set"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation) IsKnown added in v6.9.0 

func (r PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation) IsKnown() bool

type PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues struct {
	// The operation to perform on the cache tags.
	Operation PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation `json:"operation" api:"required"`
	// A list of cache tag values.
	Values []string                                                                                   `json:"values" api:"required"`
	JSON   phaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesJSON `json:"-"`
}

Add cache tags using a list of values.

func (*PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues) UnmarshalJSON added in v6.9.0 

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

type PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation string

The operation to perform on the cache tags. 

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationAdd    PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "add"
	PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "remove"
	PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "set"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation) IsKnown added in v6.9.0 

func (r PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation) IsKnown() bool

type PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation string

The operation to perform on the cache tags. 

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersOperationAdd    PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation = "add"
	PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation = "remove"
	PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation = "set"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation) IsKnown added in v6.9.0 

func (r PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation) IsKnown() bool

type PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression struct {
	// An expression that evaluates to an array of cache tag values.
	Expression string `json:"expression" api:"required"`
	// The operation to perform on the cache tags.
	Operation PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation `json:"operation" api:"required"`
	JSON      phaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionJSON      `json:"-"`
}

Remove cache tags using an expression.

func (*PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression) UnmarshalJSON added in v6.9.0 

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

type PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation string

The operation to perform on the cache tags. 

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationAdd    PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "add"
	PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "remove"
	PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "set"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation) IsKnown added in v6.9.0 

func (r PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation) IsKnown() bool

type PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues struct {
	// The operation to perform on the cache tags.
	Operation PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation `json:"operation" api:"required"`
	// A list of cache tag values.
	Values []string                                                                                      `json:"values" api:"required"`
	JSON   phaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesJSON `json:"-"`
}

Remove cache tags using a list of values.

func (*PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues) UnmarshalJSON added in v6.9.0 

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

type PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation string

The operation to perform on the cache tags. 

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationAdd    PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "add"
	PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "remove"
	PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "set"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation) IsKnown added in v6.9.0 

func (r PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation) IsKnown() bool

type PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression struct {
	// An expression that evaluates to an array of cache tag values.
	Expression string `json:"expression" api:"required"`
	// The operation to perform on the cache tags.
	Operation PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation `json:"operation" api:"required"`
	JSON      phaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionJSON      `json:"-"`
}

Set cache tags using an expression.

func (*PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression) UnmarshalJSON added in v6.9.0 

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

type PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation string

The operation to perform on the cache tags. 

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationAdd    PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "add"
	PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "remove"
	PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "set"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation) IsKnown added in v6.9.0 

func (r PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation) IsKnown() bool

type PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues struct {
	// The operation to perform on the cache tags.
	Operation PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation `json:"operation" api:"required"`
	// A list of cache tag values.
	Values []string                                                                                   `json:"values" api:"required"`
	JSON   phaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesJSON `json:"-"`
}

Set cache tags using a list of values.

func (*PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues) UnmarshalJSON added in v6.9.0 

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

type PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation string

The operation to perform on the cache tags. 

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationAdd    PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "add"
	PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "remove"
	PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "set"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation) IsKnown added in v6.9.0 

func (r PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation) IsKnown() bool

type PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersUnion added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersUnion interface {
	// contains filtered or unexported methods
}

The parameters configuring the rule's action.

Union satisfied by PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues, PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression, PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues, PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression, PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues or PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression.

type PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleExposedCredentialCheck added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleExposedCredentialCheck struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression string `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression string                                                                         `json:"username_expression" api:"required"`
	JSON               phaseVersionGetResponseRulesRulesetsSetCacheTagsRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleExposedCredentialCheck) UnmarshalJSON added in v6.9.0 

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

type PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleRatelimit added in v6.9.0 

type PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleRatelimit struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics []string `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period int64 `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression string `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout int64 `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod int64 `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin bool `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod int64 `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName string                                                            `json:"score_response_header_name"`
	JSON                    phaseVersionGetResponseRulesRulesetsSetCacheTagsRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleRatelimit) UnmarshalJSON added in v6.9.0 

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

type PhaseVersionGetResponseRulesUnion 

type PhaseVersionGetResponseRulesUnion interface {
	// contains filtered or unexported methods
}

Union satisfied by BlockRule, PhaseVersionGetResponseRulesRulesetsChallengeRule, CompressResponseRule, DDoSDynamicRule, ExecuteRule, ForceConnectionCloseRule, PhaseVersionGetResponseRulesRulesetsJSChallengeRule, LogRule, LogCustomFieldRule, ManagedChallengeRule, RedirectRule, RewriteRule, RouteRule, ScoreRule, ServeErrorRule, PhaseVersionGetResponseRulesRulesetsSetCacheControlRule, SetCacheSettingsRule, PhaseVersionGetResponseRulesRulesetsSetCacheTagsRule, SetConfigRule or SkipRule.

type PhaseVersionListParams 

type PhaseVersionListParams struct {
	// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
	AccountID param.Field[string] `path:"account_id"`
	// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
	ZoneID param.Field[string] `path:"zone_id"`
}

type PhaseVersionListResponse 

type PhaseVersionListResponse struct {
	// The unique ID of the ruleset.
	ID string `json:"id" api:"required"`
	// The kind of the ruleset.
	Kind Kind `json:"kind" api:"required"`
	// The timestamp of when the ruleset was last modified.
	LastUpdated time.Time `json:"last_updated" api:"required" format:"date-time"`
	// The human-readable name of the ruleset.
	Name string `json:"name" api:"required"`
	// The phase of the ruleset.
	Phase Phase `json:"phase" api:"required"`
	// The version of the ruleset.
	Version string `json:"version" api:"required"`
	// An informative description of the ruleset.
	Description string                       `json:"description"`
	JSON        phaseVersionListResponseJSON `json:"-"`
}

A ruleset object.

func (*PhaseVersionListResponse) UnmarshalJSON 

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

type PhaseVersionService 

type PhaseVersionService struct {
	Options []option.RequestOption
}

PhaseVersionService 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 NewPhaseVersionService method instead.

func NewPhaseVersionService 

func NewPhaseVersionService(opts ...option.RequestOption) (r *PhaseVersionService)

NewPhaseVersionService 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 (*PhaseVersionService) Get 

func (r *PhaseVersionService) Get(ctx context.Context, rulesetPhase Phase, rulesetVersion string, query PhaseVersionGetParams, opts ...option.RequestOption) (res *PhaseVersionGetResponse, err error)

Fetches a specific version of an account or zone entry point ruleset.

func (*PhaseVersionService) List 

func (r *PhaseVersionService) List(ctx context.Context, rulesetPhase Phase, query PhaseVersionListParams, opts ...option.RequestOption) (res *pagination.SinglePage[PhaseVersionListResponse], err error)

Fetches the versions of an account or zone entry point ruleset.

func (*PhaseVersionService) ListAutoPaging 

func (r *PhaseVersionService) ListAutoPaging(ctx context.Context, rulesetPhase Phase, query PhaseVersionListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[PhaseVersionListResponse]

Fetches the versions of an account or zone entry point ruleset.

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 RedirectRule 

type RedirectRule struct {
	// The timestamp of when the rule was last modified.
	LastUpdated time.Time `json:"last_updated" api:"required" format:"date-time"`
	// The version of the rule.
	Version string `json:"version" api:"required"`
	// The unique ID of the rule.
	ID string `json:"id"`
	// The action to perform when the rule matches.
	Action RedirectRuleAction `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters RedirectRuleActionParameters `json:"action_parameters"`
	// The categories of the rule.
	Categories []string `json:"categories"`
	// An informative description of the rule.
	Description string `json:"description"`
	// Whether the rule should be executed.
	Enabled bool `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck RedirectRuleExposedCredentialCheck `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression string `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging Logging `json:"logging"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit RedirectRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string           `json:"ref"`
	JSON redirectRuleJSON `json:"-"`
}

func (*RedirectRule) UnmarshalJSON 

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

type RedirectRuleAction 

type RedirectRuleAction string

The action to perform when the rule matches. 

const (
	RedirectRuleActionRedirect RedirectRuleAction = "redirect"
)

func (RedirectRuleAction) IsKnown 

func (r RedirectRuleAction) IsKnown() bool

type RedirectRuleActionParameters 

type RedirectRuleActionParameters struct {
	// A redirect based on a bulk list lookup.
	FromList RedirectRuleActionParametersFromList `json:"from_list"`
	// A redirect based on the request properties.
	FromValue RedirectRuleActionParametersFromValue `json:"from_value"`
	JSON      redirectRuleActionParametersJSON      `json:"-"`
}

The parameters configuring the rule's action.

func (*RedirectRuleActionParameters) UnmarshalJSON 

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

type RedirectRuleActionParametersFromList 

type RedirectRuleActionParametersFromList struct {
	// An expression that evaluates to the list lookup key.
	Key string `json:"key" api:"required"`
	// The name of the list to match against.
	Name string                                   `json:"name" api:"required"`
	JSON redirectRuleActionParametersFromListJSON `json:"-"`
}

A redirect based on a bulk list lookup.

func (*RedirectRuleActionParametersFromList) UnmarshalJSON 

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

type RedirectRuleActionParametersFromListParam 

type RedirectRuleActionParametersFromListParam struct {
	// An expression that evaluates to the list lookup key.
	Key param.Field[string] `json:"key" api:"required"`
	// The name of the list to match against.
	Name param.Field[string] `json:"name" api:"required"`
}

A redirect based on a bulk list lookup.

func (RedirectRuleActionParametersFromListParam) MarshalJSON 

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

type RedirectRuleActionParametersFromValue 

type RedirectRuleActionParametersFromValue struct {
	// A URL to redirect the request to.
	TargetURL RedirectRuleActionParametersFromValueTargetURL `json:"target_url" api:"required"`
	// Whether to keep the query string of the original request.
	PreserveQueryString bool `json:"preserve_query_string"`
	// The status code to use for the redirect.
	StatusCode RedirectRuleActionParametersFromValueStatusCode `json:"status_code"`
	JSON       redirectRuleActionParametersFromValueJSON       `json:"-"`
}

A redirect based on the request properties.

func (*RedirectRuleActionParametersFromValue) UnmarshalJSON 

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

type RedirectRuleActionParametersFromValueParam 

type RedirectRuleActionParametersFromValueParam struct {
	// A URL to redirect the request to.
	TargetURL param.Field[RedirectRuleActionParametersFromValueTargetURLParam] `json:"target_url" api:"required"`
	// Whether to keep the query string of the original request.
	PreserveQueryString param.Field[bool] `json:"preserve_query_string"`
	// The status code to use for the redirect.
	StatusCode param.Field[RedirectRuleActionParametersFromValueStatusCode] `json:"status_code"`
}

A redirect based on the request properties.

func (RedirectRuleActionParametersFromValueParam) MarshalJSON 

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

type RedirectRuleActionParametersFromValueStatusCode 

type RedirectRuleActionParametersFromValueStatusCode int64

The status code to use for the redirect. 

const (
	RedirectRuleActionParametersFromValueStatusCode301 RedirectRuleActionParametersFromValueStatusCode = 301
	RedirectRuleActionParametersFromValueStatusCode302 RedirectRuleActionParametersFromValueStatusCode = 302
	RedirectRuleActionParametersFromValueStatusCode303 RedirectRuleActionParametersFromValueStatusCode = 303
	RedirectRuleActionParametersFromValueStatusCode307 RedirectRuleActionParametersFromValueStatusCode = 307
	RedirectRuleActionParametersFromValueStatusCode308 RedirectRuleActionParametersFromValueStatusCode = 308
)

func (RedirectRuleActionParametersFromValueStatusCode) IsKnown 

func (r RedirectRuleActionParametersFromValueStatusCode) IsKnown() bool

type RedirectRuleActionParametersFromValueTargetURL 

type RedirectRuleActionParametersFromValueTargetURL struct {
	// An expression that evaluates to a URL to redirect the request to.
	Expression string `json:"expression"`
	// A URL to redirect the request to.
	Value string                                             `json:"value"`
	JSON  redirectRuleActionParametersFromValueTargetURLJSON `json:"-"`
}

A URL to redirect the request to.

func (*RedirectRuleActionParametersFromValueTargetURL) UnmarshalJSON 

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

type RedirectRuleActionParametersFromValueTargetURLParam 

type RedirectRuleActionParametersFromValueTargetURLParam struct {
	// An expression that evaluates to a URL to redirect the request to.
	Expression param.Field[string] `json:"expression"`
	// A URL to redirect the request to.
	Value param.Field[string] `json:"value"`
}

A URL to redirect the request to.

func (RedirectRuleActionParametersFromValueTargetURLParam) MarshalJSON 

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

type RedirectRuleActionParametersParam 

type RedirectRuleActionParametersParam struct {
	// A redirect based on a bulk list lookup.
	FromList param.Field[RedirectRuleActionParametersFromListParam] `json:"from_list"`
	// A redirect based on the request properties.
	FromValue param.Field[RedirectRuleActionParametersFromValueParam] `json:"from_value"`
}

The parameters configuring the rule's action.

func (RedirectRuleActionParametersParam) MarshalJSON 

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

type RedirectRuleExposedCredentialCheck 

type RedirectRuleExposedCredentialCheck struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression string `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression string                                 `json:"username_expression" api:"required"`
	JSON               redirectRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*RedirectRuleExposedCredentialCheck) UnmarshalJSON 

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

type RedirectRuleExposedCredentialCheckParam 

type RedirectRuleExposedCredentialCheckParam struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression param.Field[string] `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression param.Field[string] `json:"username_expression" api:"required"`
}

Configuration for exposed credential checking.

func (RedirectRuleExposedCredentialCheckParam) MarshalJSON 

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

type RedirectRuleParam 

type RedirectRuleParam struct {
	// The unique ID of the rule.
	ID param.Field[string] `json:"id"`
	// The action to perform when the rule matches.
	Action param.Field[RedirectRuleAction] `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters param.Field[RedirectRuleActionParametersParam] `json:"action_parameters"`
	// An informative description of the rule.
	Description param.Field[string] `json:"description"`
	// Whether the rule should be executed.
	Enabled param.Field[bool] `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck param.Field[RedirectRuleExposedCredentialCheckParam] `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression param.Field[string] `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging param.Field[LoggingParam] `json:"logging"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit param.Field[RedirectRuleRatelimitParam] `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref param.Field[string] `json:"ref"`
}

func (RedirectRuleParam) MarshalJSON 

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

type RedirectRuleRatelimit 

type RedirectRuleRatelimit struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics []string `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period int64 `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression string `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout int64 `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod int64 `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin bool `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod int64 `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName string                    `json:"score_response_header_name"`
	JSON                    redirectRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*RedirectRuleRatelimit) UnmarshalJSON 

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

type RedirectRuleRatelimitParam 

type RedirectRuleRatelimitParam struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics param.Field[[]string] `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period param.Field[int64] `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression param.Field[string] `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout param.Field[int64] `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod param.Field[int64] `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin param.Field[bool] `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod param.Field[int64] `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName param.Field[string] `json:"score_response_header_name"`
}

An object configuring the rule's rate limit behavior.

func (RedirectRuleRatelimitParam) MarshalJSON 

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

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 RewriteRule 

type RewriteRule struct {
	// The timestamp of when the rule was last modified.
	LastUpdated time.Time `json:"last_updated" api:"required" format:"date-time"`
	// The version of the rule.
	Version string `json:"version" api:"required"`
	// The unique ID of the rule.
	ID string `json:"id"`
	// The action to perform when the rule matches.
	Action RewriteRuleAction `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters RewriteRuleActionParameters `json:"action_parameters"`
	// The categories of the rule.
	Categories []string `json:"categories"`
	// An informative description of the rule.
	Description string `json:"description"`
	// Whether the rule should be executed.
	Enabled bool `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck RewriteRuleExposedCredentialCheck `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression string `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging Logging `json:"logging"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit RewriteRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string          `json:"ref"`
	JSON rewriteRuleJSON `json:"-"`
}

func (*RewriteRule) UnmarshalJSON 

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

type RewriteRuleAction 

type RewriteRuleAction string

The action to perform when the rule matches. 

const (
	RewriteRuleActionRewrite RewriteRuleAction = "rewrite"
)

func (RewriteRuleAction) IsKnown 

func (r RewriteRuleAction) IsKnown() bool

type RewriteRuleActionParameters 

type RewriteRuleActionParameters struct {
	// A map of headers to rewrite.
	Headers map[string]RewriteRuleActionParametersHeader `json:"headers"`
	// A URI path rewrite.
	URI  RewriteRuleActionParametersURI  `json:"uri"`
	JSON rewriteRuleActionParametersJSON `json:"-"`
}

The parameters configuring the rule's action.

func (*RewriteRuleActionParameters) UnmarshalJSON 

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

type RewriteRuleActionParametersHeader 

type RewriteRuleActionParametersHeader struct {
	// The operation to perform on the header.
	Operation RewriteRuleActionParametersHeadersOperation `json:"operation" api:"required"`
	// An expression that evaluates to a value for the header.
	Expression string `json:"expression"`
	// A static value for the header.
	Value string                                `json:"value"`
	JSON  rewriteRuleActionParametersHeaderJSON `json:"-"`
	// contains filtered or unexported fields
}

A header with a static value to add.

func (RewriteRuleActionParametersHeader) AsUnion 

func (r RewriteRuleActionParametersHeader) AsUnion() RewriteRuleActionParametersHeadersUnion

AsUnion returns a RewriteRuleActionParametersHeadersUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are RewriteRuleActionParametersHeadersAddStaticHeader, RewriteRuleActionParametersHeadersAddDynamicHeader, RewriteRuleActionParametersHeadersSetStaticHeader, RewriteRuleActionParametersHeadersSetDynamicHeader, RewriteRuleActionParametersHeadersRemoveHeader.

func (*RewriteRuleActionParametersHeader) UnmarshalJSON 

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

type RewriteRuleActionParametersHeaderParam 

type RewriteRuleActionParametersHeaderParam struct {
	// The operation to perform on the header.
	Operation param.Field[RewriteRuleActionParametersHeadersOperation] `json:"operation" api:"required"`
	// An expression that evaluates to a value for the header.
	Expression param.Field[string] `json:"expression"`
	// A static value for the header.
	Value param.Field[string] `json:"value"`
}

A header with a static value to add.

func (RewriteRuleActionParametersHeaderParam) MarshalJSON 

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

type RewriteRuleActionParametersHeadersAddDynamicHeader 

type RewriteRuleActionParametersHeadersAddDynamicHeader struct {
	// An expression that evaluates to a value for the header.
	Expression string `json:"expression" api:"required"`
	// The operation to perform on the header.
	Operation RewriteRuleActionParametersHeadersAddDynamicHeaderOperation `json:"operation" api:"required"`
	JSON      rewriteRuleActionParametersHeadersAddDynamicHeaderJSON      `json:"-"`
}

A header with a dynamic value to add.

func (*RewriteRuleActionParametersHeadersAddDynamicHeader) UnmarshalJSON 

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

type RewriteRuleActionParametersHeadersAddDynamicHeaderOperation 

type RewriteRuleActionParametersHeadersAddDynamicHeaderOperation string

The operation to perform on the header. 

const (
	RewriteRuleActionParametersHeadersAddDynamicHeaderOperationAdd RewriteRuleActionParametersHeadersAddDynamicHeaderOperation = "add"
)

func (RewriteRuleActionParametersHeadersAddDynamicHeaderOperation) IsKnown 

func (r RewriteRuleActionParametersHeadersAddDynamicHeaderOperation) IsKnown() bool

type RewriteRuleActionParametersHeadersAddDynamicHeaderParam 

type RewriteRuleActionParametersHeadersAddDynamicHeaderParam struct {
	// An expression that evaluates to a value for the header.
	Expression param.Field[string] `json:"expression" api:"required"`
	// The operation to perform on the header.
	Operation param.Field[RewriteRuleActionParametersHeadersAddDynamicHeaderOperation] `json:"operation" api:"required"`
}

A header with a dynamic value to add.

func (RewriteRuleActionParametersHeadersAddDynamicHeaderParam) MarshalJSON 

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

type RewriteRuleActionParametersHeadersAddStaticHeader 

type RewriteRuleActionParametersHeadersAddStaticHeader struct {
	// The operation to perform on the header.
	Operation RewriteRuleActionParametersHeadersAddStaticHeaderOperation `json:"operation" api:"required"`
	// A static value for the header.
	Value string                                                `json:"value" api:"required"`
	JSON  rewriteRuleActionParametersHeadersAddStaticHeaderJSON `json:"-"`
}

A header with a static value to add.

func (*RewriteRuleActionParametersHeadersAddStaticHeader) UnmarshalJSON 

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

type RewriteRuleActionParametersHeadersAddStaticHeaderOperation 

type RewriteRuleActionParametersHeadersAddStaticHeaderOperation string

The operation to perform on the header. 

const (
	RewriteRuleActionParametersHeadersAddStaticHeaderOperationAdd RewriteRuleActionParametersHeadersAddStaticHeaderOperation = "add"
)

func (RewriteRuleActionParametersHeadersAddStaticHeaderOperation) IsKnown 

func (r RewriteRuleActionParametersHeadersAddStaticHeaderOperation) IsKnown() bool

type RewriteRuleActionParametersHeadersAddStaticHeaderParam 

type RewriteRuleActionParametersHeadersAddStaticHeaderParam struct {
	// The operation to perform on the header.
	Operation param.Field[RewriteRuleActionParametersHeadersAddStaticHeaderOperation] `json:"operation" api:"required"`
	// A static value for the header.
	Value param.Field[string] `json:"value" api:"required"`
}

A header with a static value to add.

func (RewriteRuleActionParametersHeadersAddStaticHeaderParam) MarshalJSON 

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

type RewriteRuleActionParametersHeadersOperation 

type RewriteRuleActionParametersHeadersOperation string

The operation to perform on the header. 

const (
	RewriteRuleActionParametersHeadersOperationAdd    RewriteRuleActionParametersHeadersOperation = "add"
	RewriteRuleActionParametersHeadersOperationSet    RewriteRuleActionParametersHeadersOperation = "set"
	RewriteRuleActionParametersHeadersOperationRemove RewriteRuleActionParametersHeadersOperation = "remove"
)

func (RewriteRuleActionParametersHeadersOperation) IsKnown 

func (r RewriteRuleActionParametersHeadersOperation) IsKnown() bool

type RewriteRuleActionParametersHeadersRemoveHeader 

type RewriteRuleActionParametersHeadersRemoveHeader struct {
	// The operation to perform on the header.
	Operation RewriteRuleActionParametersHeadersRemoveHeaderOperation `json:"operation" api:"required"`
	JSON      rewriteRuleActionParametersHeadersRemoveHeaderJSON      `json:"-"`
}

A header to remove.

func (*RewriteRuleActionParametersHeadersRemoveHeader) UnmarshalJSON 

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

type RewriteRuleActionParametersHeadersRemoveHeaderOperation 

type RewriteRuleActionParametersHeadersRemoveHeaderOperation string

The operation to perform on the header. 

const (
	RewriteRuleActionParametersHeadersRemoveHeaderOperationRemove RewriteRuleActionParametersHeadersRemoveHeaderOperation = "remove"
)

func (RewriteRuleActionParametersHeadersRemoveHeaderOperation) IsKnown 

func (r RewriteRuleActionParametersHeadersRemoveHeaderOperation) IsKnown() bool

type RewriteRuleActionParametersHeadersRemoveHeaderParam 

type RewriteRuleActionParametersHeadersRemoveHeaderParam struct {
	// The operation to perform on the header.
	Operation param.Field[RewriteRuleActionParametersHeadersRemoveHeaderOperation] `json:"operation" api:"required"`
}

A header to remove.

func (RewriteRuleActionParametersHeadersRemoveHeaderParam) MarshalJSON 

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

type RewriteRuleActionParametersHeadersSetDynamicHeader 

type RewriteRuleActionParametersHeadersSetDynamicHeader struct {
	// An expression that evaluates to a value for the header.
	Expression string `json:"expression" api:"required"`
	// The operation to perform on the header.
	Operation RewriteRuleActionParametersHeadersSetDynamicHeaderOperation `json:"operation" api:"required"`
	JSON      rewriteRuleActionParametersHeadersSetDynamicHeaderJSON      `json:"-"`
}

A header with a dynamic value to set.

func (*RewriteRuleActionParametersHeadersSetDynamicHeader) UnmarshalJSON 

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

type RewriteRuleActionParametersHeadersSetDynamicHeaderOperation 

type RewriteRuleActionParametersHeadersSetDynamicHeaderOperation string

The operation to perform on the header. 

const (
	RewriteRuleActionParametersHeadersSetDynamicHeaderOperationSet RewriteRuleActionParametersHeadersSetDynamicHeaderOperation = "set"
)

func (RewriteRuleActionParametersHeadersSetDynamicHeaderOperation) IsKnown 

func (r RewriteRuleActionParametersHeadersSetDynamicHeaderOperation) IsKnown() bool

type RewriteRuleActionParametersHeadersSetDynamicHeaderParam 

type RewriteRuleActionParametersHeadersSetDynamicHeaderParam struct {
	// An expression that evaluates to a value for the header.
	Expression param.Field[string] `json:"expression" api:"required"`
	// The operation to perform on the header.
	Operation param.Field[RewriteRuleActionParametersHeadersSetDynamicHeaderOperation] `json:"operation" api:"required"`
}

A header with a dynamic value to set.

func (RewriteRuleActionParametersHeadersSetDynamicHeaderParam) MarshalJSON 

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

type RewriteRuleActionParametersHeadersSetStaticHeader 

type RewriteRuleActionParametersHeadersSetStaticHeader struct {
	// The operation to perform on the header.
	Operation RewriteRuleActionParametersHeadersSetStaticHeaderOperation `json:"operation" api:"required"`
	// A static value for the header.
	Value string                                                `json:"value" api:"required"`
	JSON  rewriteRuleActionParametersHeadersSetStaticHeaderJSON `json:"-"`
}

A header with a static value to set.

func (*RewriteRuleActionParametersHeadersSetStaticHeader) UnmarshalJSON 

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

type RewriteRuleActionParametersHeadersSetStaticHeaderOperation 

type RewriteRuleActionParametersHeadersSetStaticHeaderOperation string

The operation to perform on the header. 

const (
	RewriteRuleActionParametersHeadersSetStaticHeaderOperationSet RewriteRuleActionParametersHeadersSetStaticHeaderOperation = "set"
)

func (RewriteRuleActionParametersHeadersSetStaticHeaderOperation) IsKnown 

func (r RewriteRuleActionParametersHeadersSetStaticHeaderOperation) IsKnown() bool

type RewriteRuleActionParametersHeadersSetStaticHeaderParam 

type RewriteRuleActionParametersHeadersSetStaticHeaderParam struct {
	// The operation to perform on the header.
	Operation param.Field[RewriteRuleActionParametersHeadersSetStaticHeaderOperation] `json:"operation" api:"required"`
	// A static value for the header.
	Value param.Field[string] `json:"value" api:"required"`
}

A header with a static value to set.

func (RewriteRuleActionParametersHeadersSetStaticHeaderParam) MarshalJSON 

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

type RewriteRuleActionParametersHeadersUnion 

type RewriteRuleActionParametersHeadersUnion interface {
	// contains filtered or unexported methods
}

A header with a static value to add.

Union satisfied by RewriteRuleActionParametersHeadersAddStaticHeader, RewriteRuleActionParametersHeadersAddDynamicHeader, RewriteRuleActionParametersHeadersSetStaticHeader, RewriteRuleActionParametersHeadersSetDynamicHeader or RewriteRuleActionParametersHeadersRemoveHeader.

type RewriteRuleActionParametersHeadersUnionParam 

type RewriteRuleActionParametersHeadersUnionParam interface {
	// contains filtered or unexported methods
}

A header with a static value to add.

Satisfied by rulesets.RewriteRuleActionParametersHeadersAddStaticHeaderParam, rulesets.RewriteRuleActionParametersHeadersAddDynamicHeaderParam, rulesets.RewriteRuleActionParametersHeadersSetStaticHeaderParam, rulesets.RewriteRuleActionParametersHeadersSetDynamicHeaderParam, rulesets.RewriteRuleActionParametersHeadersRemoveHeaderParam, RewriteRuleActionParametersHeaderParam.

type RewriteRuleActionParametersParam 

type RewriteRuleActionParametersParam struct {
	// A map of headers to rewrite.
	Headers param.Field[map[string]RewriteRuleActionParametersHeadersUnionParam] `json:"headers"`
	// A URI path rewrite.
	URI param.Field[RewriteRuleActionParametersURIUnionParam] `json:"uri"`
}

The parameters configuring the rule's action.

func (RewriteRuleActionParametersParam) MarshalJSON 

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

type RewriteRuleActionParametersURI 

type RewriteRuleActionParametersURI struct {
	// Whether to propagate the rewritten URI to origin.
	Origin bool `json:"origin"`
	// This field can have the runtime type of
	// [RewriteRuleActionParametersURIURIPathPath].
	Path interface{} `json:"path"`
	// This field can have the runtime type of
	// [RewriteRuleActionParametersURIURIQueryQuery].
	Query interface{}                        `json:"query"`
	JSON  rewriteRuleActionParametersURIJSON `json:"-"`
	// contains filtered or unexported fields
}

A URI path rewrite.

func (RewriteRuleActionParametersURI) AsUnion 

func (r RewriteRuleActionParametersURI) AsUnion() RewriteRuleActionParametersURIUnion

AsUnion returns a RewriteRuleActionParametersURIUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are RewriteRuleActionParametersURIURIPath, RewriteRuleActionParametersURIURIQuery.

func (*RewriteRuleActionParametersURI) UnmarshalJSON 

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

type RewriteRuleActionParametersURIParam 

type RewriteRuleActionParametersURIParam struct {
	Path  param.Field[interface{}] `json:"path"`
	Query param.Field[interface{}] `json:"query"`
}

A URI path rewrite.

func (RewriteRuleActionParametersURIParam) MarshalJSON 

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

type RewriteRuleActionParametersURIURIPath 

type RewriteRuleActionParametersURIURIPath struct {
	// A URI path rewrite.
	Path RewriteRuleActionParametersURIURIPathPath `json:"path" api:"required"`
	// Whether to propagate the rewritten URI to origin.
	Origin bool                                      `json:"origin"`
	JSON   rewriteRuleActionParametersUriuriPathJSON `json:"-"`
}

A URI path rewrite.

func (*RewriteRuleActionParametersURIURIPath) UnmarshalJSON 

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

type RewriteRuleActionParametersURIURIPathParam 

type RewriteRuleActionParametersURIURIPathParam struct {
	// A URI path rewrite.
	Path param.Field[RewriteRuleActionParametersURIURIPathPathParam] `json:"path" api:"required"`
}

A URI path rewrite.

func (RewriteRuleActionParametersURIURIPathParam) MarshalJSON 

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

type RewriteRuleActionParametersURIURIPathPath 

type RewriteRuleActionParametersURIURIPathPath struct {
	// An expression that evaluates to a value to rewrite the URI path to.
	Expression string `json:"expression"`
	// A value to rewrite the URI path to.
	Value string                                        `json:"value"`
	JSON  rewriteRuleActionParametersUriuriPathPathJSON `json:"-"`
}

A URI path rewrite.

func (*RewriteRuleActionParametersURIURIPathPath) UnmarshalJSON 

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

type RewriteRuleActionParametersURIURIPathPathParam 

type RewriteRuleActionParametersURIURIPathPathParam struct {
	// An expression that evaluates to a value to rewrite the URI path to.
	Expression param.Field[string] `json:"expression"`
	// A value to rewrite the URI path to.
	Value param.Field[string] `json:"value"`
}

A URI path rewrite.

func (RewriteRuleActionParametersURIURIPathPathParam) MarshalJSON 

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

type RewriteRuleActionParametersURIURIQuery 

type RewriteRuleActionParametersURIURIQuery struct {
	// A URI query rewrite.
	Query RewriteRuleActionParametersURIURIQueryQuery `json:"query" api:"required"`
	// Whether to propagate the rewritten URI to origin.
	Origin bool                                       `json:"origin"`
	JSON   rewriteRuleActionParametersUriuriQueryJSON `json:"-"`
}

A URI query rewrite.

func (*RewriteRuleActionParametersURIURIQuery) UnmarshalJSON 

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

type RewriteRuleActionParametersURIURIQueryParam 

type RewriteRuleActionParametersURIURIQueryParam struct {
	// A URI query rewrite.
	Query param.Field[RewriteRuleActionParametersURIURIQueryQueryParam] `json:"query" api:"required"`
}

A URI query rewrite.

func (RewriteRuleActionParametersURIURIQueryParam) MarshalJSON 

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

type RewriteRuleActionParametersURIURIQueryQuery 

type RewriteRuleActionParametersURIURIQueryQuery struct {
	// An expression that evaluates to a value to rewrite the URI query to.
	Expression string `json:"expression"`
	// A value to rewrite the URI query to.
	Value string                                          `json:"value"`
	JSON  rewriteRuleActionParametersUriuriQueryQueryJSON `json:"-"`
}

A URI query rewrite.

func (*RewriteRuleActionParametersURIURIQueryQuery) UnmarshalJSON 

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

type RewriteRuleActionParametersURIURIQueryQueryParam 

type RewriteRuleActionParametersURIURIQueryQueryParam struct {
	// An expression that evaluates to a value to rewrite the URI query to.
	Expression param.Field[string] `json:"expression"`
	// A value to rewrite the URI query to.
	Value param.Field[string] `json:"value"`
}

A URI query rewrite.

func (RewriteRuleActionParametersURIURIQueryQueryParam) MarshalJSON 

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

type RewriteRuleActionParametersURIUnion 

type RewriteRuleActionParametersURIUnion interface {
	// contains filtered or unexported methods
}

A URI path rewrite.

Union satisfied by RewriteRuleActionParametersURIURIPath or RewriteRuleActionParametersURIURIQuery.

type RewriteRuleActionParametersURIUnionParam 

type RewriteRuleActionParametersURIUnionParam interface {
	// contains filtered or unexported methods
}

A URI path rewrite.

Satisfied by rulesets.RewriteRuleActionParametersURIURIPathParam, rulesets.RewriteRuleActionParametersURIURIQueryParam, RewriteRuleActionParametersURIParam.

type RewriteRuleExposedCredentialCheck 

type RewriteRuleExposedCredentialCheck struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression string `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression string                                `json:"username_expression" api:"required"`
	JSON               rewriteRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*RewriteRuleExposedCredentialCheck) UnmarshalJSON 

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

type RewriteRuleExposedCredentialCheckParam 

type RewriteRuleExposedCredentialCheckParam struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression param.Field[string] `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression param.Field[string] `json:"username_expression" api:"required"`
}

Configuration for exposed credential checking.

func (RewriteRuleExposedCredentialCheckParam) MarshalJSON 

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

type RewriteRuleParam 

type RewriteRuleParam struct {
	// The unique ID of the rule.
	ID param.Field[string] `json:"id"`
	// The action to perform when the rule matches.
	Action param.Field[RewriteRuleAction] `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters param.Field[RewriteRuleActionParametersParam] `json:"action_parameters"`
	// An informative description of the rule.
	Description param.Field[string] `json:"description"`
	// Whether the rule should be executed.
	Enabled param.Field[bool] `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck param.Field[RewriteRuleExposedCredentialCheckParam] `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression param.Field[string] `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging param.Field[LoggingParam] `json:"logging"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit param.Field[RewriteRuleRatelimitParam] `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref param.Field[string] `json:"ref"`
}

func (RewriteRuleParam) MarshalJSON 

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

type RewriteRuleRatelimit 

type RewriteRuleRatelimit struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics []string `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period int64 `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression string `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout int64 `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod int64 `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin bool `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod int64 `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName string                   `json:"score_response_header_name"`
	JSON                    rewriteRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*RewriteRuleRatelimit) UnmarshalJSON 

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

type RewriteRuleRatelimitParam 

type RewriteRuleRatelimitParam struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics param.Field[[]string] `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period param.Field[int64] `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression param.Field[string] `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout param.Field[int64] `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod param.Field[int64] `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin param.Field[bool] `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod param.Field[int64] `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName param.Field[string] `json:"score_response_header_name"`
}

An object configuring the rule's rate limit behavior.

func (RewriteRuleRatelimitParam) MarshalJSON 

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

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 RouteRule 

type RouteRule struct {
	// The timestamp of when the rule was last modified.
	LastUpdated time.Time `json:"last_updated" api:"required" format:"date-time"`
	// The version of the rule.
	Version string `json:"version" api:"required"`
	// The unique ID of the rule.
	ID string `json:"id"`
	// The action to perform when the rule matches.
	Action RouteRuleAction `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters RouteRuleActionParameters `json:"action_parameters"`
	// The categories of the rule.
	Categories []string `json:"categories"`
	// An informative description of the rule.
	Description string `json:"description"`
	// Whether the rule should be executed.
	Enabled bool `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck RouteRuleExposedCredentialCheck `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression string `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging Logging `json:"logging"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit RouteRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string        `json:"ref"`
	JSON routeRuleJSON `json:"-"`
}

func (*RouteRule) UnmarshalJSON 

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

type RouteRuleAction 

type RouteRuleAction string

The action to perform when the rule matches. 

const (
	RouteRuleActionRoute RouteRuleAction = "route"
)

func (RouteRuleAction) IsKnown 

func (r RouteRuleAction) IsKnown() bool

type RouteRuleActionParameters 

type RouteRuleActionParameters struct {
	// A value to rewrite the HTTP host header to.
	HostHeader string `json:"host_header"`
	// An origin to route to.
	Origin RouteRuleActionParametersOrigin `json:"origin"`
	// A Server Name Indication (SNI) override.
	SNI  RouteRuleActionParametersSNI  `json:"sni"`
	JSON routeRuleActionParametersJSON `json:"-"`
}

The parameters configuring the rule's action.

func (*RouteRuleActionParameters) UnmarshalJSON 

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

type RouteRuleActionParametersOrigin 

type RouteRuleActionParametersOrigin struct {
	// A resolved host to route to.
	Host string `json:"host"`
	// A destination port to route to.
	Port int64                               `json:"port"`
	JSON routeRuleActionParametersOriginJSON `json:"-"`
}

An origin to route to.

func (*RouteRuleActionParametersOrigin) UnmarshalJSON 

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

type RouteRuleActionParametersOriginParam 

type RouteRuleActionParametersOriginParam struct {
	// A resolved host to route to.
	Host param.Field[string] `json:"host"`
	// A destination port to route to.
	Port param.Field[int64] `json:"port"`
}

An origin to route to.

func (RouteRuleActionParametersOriginParam) MarshalJSON 

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

type RouteRuleActionParametersParam 

type RouteRuleActionParametersParam struct {
	// A value to rewrite the HTTP host header to.
	HostHeader param.Field[string] `json:"host_header"`
	// An origin to route to.
	Origin param.Field[RouteRuleActionParametersOriginParam] `json:"origin"`
	// A Server Name Indication (SNI) override.
	SNI param.Field[RouteRuleActionParametersSNIParam] `json:"sni"`
}

The parameters configuring the rule's action.

func (RouteRuleActionParametersParam) MarshalJSON 

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

type RouteRuleActionParametersSNI 

type RouteRuleActionParametersSNI struct {
	// A value to override the SNI to.
	Value string                           `json:"value" api:"required"`
	JSON  routeRuleActionParametersSNIJSON `json:"-"`
}

A Server Name Indication (SNI) override.

func (*RouteRuleActionParametersSNI) UnmarshalJSON 

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

type RouteRuleActionParametersSNIParam 

type RouteRuleActionParametersSNIParam struct {
	// A value to override the SNI to.
	Value param.Field[string] `json:"value" api:"required"`
}

A Server Name Indication (SNI) override.

func (RouteRuleActionParametersSNIParam) MarshalJSON 

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

type RouteRuleExposedCredentialCheck 

type RouteRuleExposedCredentialCheck struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression string `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression string                              `json:"username_expression" api:"required"`
	JSON               routeRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*RouteRuleExposedCredentialCheck) UnmarshalJSON 

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

type RouteRuleExposedCredentialCheckParam 

type RouteRuleExposedCredentialCheckParam struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression param.Field[string] `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression param.Field[string] `json:"username_expression" api:"required"`
}

Configuration for exposed credential checking.

func (RouteRuleExposedCredentialCheckParam) MarshalJSON 

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

type RouteRuleParam 

type RouteRuleParam struct {
	// The unique ID of the rule.
	ID param.Field[string] `json:"id"`
	// The action to perform when the rule matches.
	Action param.Field[RouteRuleAction] `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters param.Field[RouteRuleActionParametersParam] `json:"action_parameters"`
	// An informative description of the rule.
	Description param.Field[string] `json:"description"`
	// Whether the rule should be executed.
	Enabled param.Field[bool] `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck param.Field[RouteRuleExposedCredentialCheckParam] `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression param.Field[string] `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging param.Field[LoggingParam] `json:"logging"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit param.Field[RouteRuleRatelimitParam] `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref param.Field[string] `json:"ref"`
}

func (RouteRuleParam) MarshalJSON 

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

type RouteRuleRatelimit 

type RouteRuleRatelimit struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics []string `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period int64 `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression string `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout int64 `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod int64 `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin bool `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod int64 `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName string                 `json:"score_response_header_name"`
	JSON                    routeRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*RouteRuleRatelimit) UnmarshalJSON 

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

type RouteRuleRatelimitParam 

type RouteRuleRatelimitParam struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics param.Field[[]string] `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period param.Field[int64] `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression param.Field[string] `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout param.Field[int64] `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod param.Field[int64] `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin param.Field[bool] `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod param.Field[int64] `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName param.Field[string] `json:"score_response_header_name"`
}

An object configuring the rule's rate limit behavior.

func (RouteRuleRatelimitParam) MarshalJSON 

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

type RuleDeleteParams 

type RuleDeleteParams struct {
	// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
	AccountID param.Field[string] `path:"account_id"`
	// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
	ZoneID param.Field[string] `path:"zone_id"`
}

type RuleDeleteResponse 

type RuleDeleteResponse struct {
	// The unique ID of the ruleset.
	ID string `json:"id" api:"required"`
	// The kind of the ruleset.
	Kind Kind `json:"kind" api:"required"`
	// The timestamp of when the ruleset was last modified.
	LastUpdated time.Time `json:"last_updated" api:"required" format:"date-time"`
	// The human-readable name of the ruleset.
	Name string `json:"name" api:"required"`
	// The phase of the ruleset.
	Phase Phase `json:"phase" api:"required"`
	// The list of rules in the ruleset.
	Rules []RuleDeleteResponseRule `json:"rules" api:"required"`
	// The version of the ruleset.
	Version string `json:"version" api:"required"`
	// An informative description of the ruleset.
	Description string                 `json:"description"`
	JSON        ruleDeleteResponseJSON `json:"-"`
}

A ruleset object.

func (*RuleDeleteResponse) UnmarshalJSON 

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

type RuleDeleteResponseEnvelope 

type RuleDeleteResponseEnvelope struct {
	// A list of error messages.
	Errors []RuleDeleteResponseEnvelopeErrors `json:"errors" api:"required"`
	// A list of warning messages.
	Messages []RuleDeleteResponseEnvelopeMessages `json:"messages" api:"required"`
	// A ruleset object.
	Result RuleDeleteResponse `json:"result" api:"required"`
	// Whether the API call was successful.
	Success RuleDeleteResponseEnvelopeSuccess `json:"success" api:"required"`
	JSON    ruleDeleteResponseEnvelopeJSON    `json:"-"`
}

A response object.

func (*RuleDeleteResponseEnvelope) UnmarshalJSON 

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

type RuleDeleteResponseEnvelopeErrors 

type RuleDeleteResponseEnvelopeErrors struct {
	// A text description of this message.
	Message string `json:"message" api:"required"`
	// A unique code for this message.
	Code int64 `json:"code"`
	// The source of this message.
	Source RuleDeleteResponseEnvelopeErrorsSource `json:"source"`
	JSON   ruleDeleteResponseEnvelopeErrorsJSON   `json:"-"`
}

A message.

func (*RuleDeleteResponseEnvelopeErrors) UnmarshalJSON 

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

type RuleDeleteResponseEnvelopeErrorsSource 

type RuleDeleteResponseEnvelopeErrorsSource struct {
	// A JSON pointer to the field that is the source of the message.
	Pointer string                                     `json:"pointer" api:"required"`
	JSON    ruleDeleteResponseEnvelopeErrorsSourceJSON `json:"-"`
}

The source of this message.

func (*RuleDeleteResponseEnvelopeErrorsSource) UnmarshalJSON 

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

type RuleDeleteResponseEnvelopeMessages 

type RuleDeleteResponseEnvelopeMessages struct {
	// A text description of this message.
	Message string `json:"message" api:"required"`
	// A unique code for this message.
	Code int64 `json:"code"`
	// The source of this message.
	Source RuleDeleteResponseEnvelopeMessagesSource `json:"source"`
	JSON   ruleDeleteResponseEnvelopeMessagesJSON   `json:"-"`
}

A message.

func (*RuleDeleteResponseEnvelopeMessages) UnmarshalJSON 

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

type RuleDeleteResponseEnvelopeMessagesSource 

type RuleDeleteResponseEnvelopeMessagesSource struct {
	// A JSON pointer to the field that is the source of the message.
	Pointer string                                       `json:"pointer" api:"required"`
	JSON    ruleDeleteResponseEnvelopeMessagesSourceJSON `json:"-"`
}

The source of this message.

func (*RuleDeleteResponseEnvelopeMessagesSource) UnmarshalJSON 

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

type RuleDeleteResponseEnvelopeSuccess 

type RuleDeleteResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	RuleDeleteResponseEnvelopeSuccessTrue RuleDeleteResponseEnvelopeSuccess = true
)

func (RuleDeleteResponseEnvelopeSuccess) IsKnown 

func (r RuleDeleteResponseEnvelopeSuccess) IsKnown() bool

type RuleDeleteResponseRule 

type RuleDeleteResponseRule struct {
	// The timestamp of when the rule was last modified.
	LastUpdated time.Time `json:"last_updated" api:"required" format:"date-time"`
	// The version of the rule.
	Version string `json:"version" api:"required"`
	// The unique ID of the rule.
	ID string `json:"id"`
	// The action to perform when the rule matches.
	Action RuleDeleteResponseRulesAction `json:"action"`
	// This field can have the runtime type of [BlockRuleActionParameters],
	// [interface{}], [CompressResponseRuleActionParameters],
	// [ExecuteRuleActionParameters], [LogCustomFieldRuleActionParameters],
	// [RedirectRuleActionParameters], [RewriteRuleActionParameters],
	// [RouteRuleActionParameters], [ScoreRuleActionParameters],
	// [ServeErrorRuleActionParameters],
	// [RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParameters],
	// [SetCacheSettingsRuleActionParameters],
	// [RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParameters],
	// [SetConfigRuleActionParameters], [SkipRuleActionParameters].
	ActionParameters interface{} `json:"action_parameters"`
	// This field can have the runtime type of [[]string].
	Categories interface{} `json:"categories"`
	// An informative description of the rule.
	Description string `json:"description"`
	// Whether the rule should be executed.
	Enabled bool `json:"enabled"`
	// This field can have the runtime type of [BlockRuleExposedCredentialCheck],
	// [RuleDeleteResponseRulesRulesetsChallengeRuleExposedCredentialCheck],
	// [CompressResponseRuleExposedCredentialCheck],
	// [DDoSDynamicRuleExposedCredentialCheck], [ExecuteRuleExposedCredentialCheck],
	// [ForceConnectionCloseRuleExposedCredentialCheck],
	// [RuleDeleteResponseRulesRulesetsJSChallengeRuleExposedCredentialCheck],
	// [LogRuleExposedCredentialCheck], [LogCustomFieldRuleExposedCredentialCheck],
	// [ManagedChallengeRuleExposedCredentialCheck],
	// [RedirectRuleExposedCredentialCheck], [RewriteRuleExposedCredentialCheck],
	// [RouteRuleExposedCredentialCheck], [ScoreRuleExposedCredentialCheck],
	// [ServeErrorRuleExposedCredentialCheck],
	// [RuleDeleteResponseRulesRulesetsSetCacheControlRuleExposedCredentialCheck],
	// [SetCacheSettingsRuleExposedCredentialCheck],
	// [RuleDeleteResponseRulesRulesetsSetCacheTagsRuleExposedCredentialCheck],
	// [SetConfigRuleExposedCredentialCheck], [SkipRuleExposedCredentialCheck].
	ExposedCredentialCheck interface{} `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression string `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging Logging `json:"logging"`
	// This field can have the runtime type of [BlockRuleRatelimit],
	// [RuleDeleteResponseRulesRulesetsChallengeRuleRatelimit],
	// [CompressResponseRuleRatelimit], [DDoSDynamicRuleRatelimit],
	// [ExecuteRuleRatelimit], [ForceConnectionCloseRuleRatelimit],
	// [RuleDeleteResponseRulesRulesetsJSChallengeRuleRatelimit], [LogRuleRatelimit],
	// [LogCustomFieldRuleRatelimit], [ManagedChallengeRuleRatelimit],
	// [RedirectRuleRatelimit], [RewriteRuleRatelimit], [RouteRuleRatelimit],
	// [ScoreRuleRatelimit], [ServeErrorRuleRatelimit],
	// [RuleDeleteResponseRulesRulesetsSetCacheControlRuleRatelimit],
	// [SetCacheSettingsRuleRatelimit],
	// [RuleDeleteResponseRulesRulesetsSetCacheTagsRuleRatelimit],
	// [SetConfigRuleRatelimit], [SkipRuleRatelimit].
	Ratelimit interface{} `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                     `json:"ref"`
	JSON ruleDeleteResponseRuleJSON `json:"-"`
	// contains filtered or unexported fields
}

func (RuleDeleteResponseRule) AsUnion 

func (r RuleDeleteResponseRule) AsUnion() RuleDeleteResponseRulesUnion

AsUnion returns a RuleDeleteResponseRulesUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are BlockRule, RuleDeleteResponseRulesRulesetsChallengeRule, CompressResponseRule, DDoSDynamicRule, ExecuteRule, ForceConnectionCloseRule, RuleDeleteResponseRulesRulesetsJSChallengeRule, LogRule, LogCustomFieldRule, ManagedChallengeRule, RedirectRule, RewriteRule, RouteRule, ScoreRule, ServeErrorRule, RuleDeleteResponseRulesRulesetsSetCacheControlRule, SetCacheSettingsRule, RuleDeleteResponseRulesRulesetsSetCacheTagsRule, SetConfigRule, SkipRule.

func (*RuleDeleteResponseRule) UnmarshalJSON 

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

type RuleDeleteResponseRulesAction 

type RuleDeleteResponseRulesAction string

The action to perform when the rule matches. 

const (
	RuleDeleteResponseRulesActionBlock                RuleDeleteResponseRulesAction = "block"
	RuleDeleteResponseRulesActionChallenge            RuleDeleteResponseRulesAction = "challenge"
	RuleDeleteResponseRulesActionCompressResponse     RuleDeleteResponseRulesAction = "compress_response"
	RuleDeleteResponseRulesActionDDoSDynamic          RuleDeleteResponseRulesAction = "ddos_dynamic"
	RuleDeleteResponseRulesActionExecute              RuleDeleteResponseRulesAction = "execute"
	RuleDeleteResponseRulesActionForceConnectionClose RuleDeleteResponseRulesAction = "force_connection_close"
	RuleDeleteResponseRulesActionJSChallenge          RuleDeleteResponseRulesAction = "js_challenge"
	RuleDeleteResponseRulesActionLog                  RuleDeleteResponseRulesAction = "log"
	RuleDeleteResponseRulesActionLogCustomField       RuleDeleteResponseRulesAction = "log_custom_field"
	RuleDeleteResponseRulesActionManagedChallenge     RuleDeleteResponseRulesAction = "managed_challenge"
	RuleDeleteResponseRulesActionRedirect             RuleDeleteResponseRulesAction = "redirect"
	RuleDeleteResponseRulesActionRewrite              RuleDeleteResponseRulesAction = "rewrite"
	RuleDeleteResponseRulesActionRoute                RuleDeleteResponseRulesAction = "route"
	RuleDeleteResponseRulesActionScore                RuleDeleteResponseRulesAction = "score"
	RuleDeleteResponseRulesActionServeError           RuleDeleteResponseRulesAction = "serve_error"
	RuleDeleteResponseRulesActionSetCacheControl      RuleDeleteResponseRulesAction = "set_cache_control"
	RuleDeleteResponseRulesActionSetCacheSettings     RuleDeleteResponseRulesAction = "set_cache_settings"
	RuleDeleteResponseRulesActionSetCacheTags         RuleDeleteResponseRulesAction = "set_cache_tags"
	RuleDeleteResponseRulesActionSetConfig            RuleDeleteResponseRulesAction = "set_config"
	RuleDeleteResponseRulesActionSkip                 RuleDeleteResponseRulesAction = "skip"
)

func (RuleDeleteResponseRulesAction) IsKnown 

func (r RuleDeleteResponseRulesAction) IsKnown() bool

type RuleDeleteResponseRulesRulesetsChallengeRule 

type RuleDeleteResponseRulesRulesetsChallengeRule struct {
	// The timestamp of when the rule was last modified.
	LastUpdated time.Time `json:"last_updated" api:"required" format:"date-time"`
	// The version of the rule.
	Version string `json:"version" api:"required"`
	// The unique ID of the rule.
	ID string `json:"id"`
	// The action to perform when the rule matches.
	Action RuleDeleteResponseRulesRulesetsChallengeRuleAction `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters interface{} `json:"action_parameters"`
	// The categories of the rule.
	Categories []string `json:"categories"`
	// An informative description of the rule.
	Description string `json:"description"`
	// Whether the rule should be executed.
	Enabled bool `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck RuleDeleteResponseRulesRulesetsChallengeRuleExposedCredentialCheck `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression string `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging Logging `json:"logging"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit RuleDeleteResponseRulesRulesetsChallengeRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                                           `json:"ref"`
	JSON ruleDeleteResponseRulesRulesetsChallengeRuleJSON `json:"-"`
}

func (*RuleDeleteResponseRulesRulesetsChallengeRule) UnmarshalJSON 

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

type RuleDeleteResponseRulesRulesetsChallengeRuleAction 

type RuleDeleteResponseRulesRulesetsChallengeRuleAction string

The action to perform when the rule matches. 

const (
	RuleDeleteResponseRulesRulesetsChallengeRuleActionChallenge RuleDeleteResponseRulesRulesetsChallengeRuleAction = "challenge"
)

func (RuleDeleteResponseRulesRulesetsChallengeRuleAction) IsKnown 

func (r RuleDeleteResponseRulesRulesetsChallengeRuleAction) IsKnown() bool

type RuleDeleteResponseRulesRulesetsChallengeRuleExposedCredentialCheck 

type RuleDeleteResponseRulesRulesetsChallengeRuleExposedCredentialCheck struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression string `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression string                                                                 `json:"username_expression" api:"required"`
	JSON               ruleDeleteResponseRulesRulesetsChallengeRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*RuleDeleteResponseRulesRulesetsChallengeRuleExposedCredentialCheck) UnmarshalJSON 

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

type RuleDeleteResponseRulesRulesetsChallengeRuleRatelimit 

type RuleDeleteResponseRulesRulesetsChallengeRuleRatelimit struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics []string `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period int64 `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression string `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout int64 `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod int64 `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin bool `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod int64 `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName string                                                    `json:"score_response_header_name"`
	JSON                    ruleDeleteResponseRulesRulesetsChallengeRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*RuleDeleteResponseRulesRulesetsChallengeRuleRatelimit) UnmarshalJSON 

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

type RuleDeleteResponseRulesRulesetsJSChallengeRule 

type RuleDeleteResponseRulesRulesetsJSChallengeRule struct {
	// The timestamp of when the rule was last modified.
	LastUpdated time.Time `json:"last_updated" api:"required" format:"date-time"`
	// The version of the rule.
	Version string `json:"version" api:"required"`
	// The unique ID of the rule.
	ID string `json:"id"`
	// The action to perform when the rule matches.
	Action RuleDeleteResponseRulesRulesetsJSChallengeRuleAction `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters interface{} `json:"action_parameters"`
	// The categories of the rule.
	Categories []string `json:"categories"`
	// An informative description of the rule.
	Description string `json:"description"`
	// Whether the rule should be executed.
	Enabled bool `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck RuleDeleteResponseRulesRulesetsJSChallengeRuleExposedCredentialCheck `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression string `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging Logging `json:"logging"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit RuleDeleteResponseRulesRulesetsJSChallengeRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                                             `json:"ref"`
	JSON ruleDeleteResponseRulesRulesetsJSChallengeRuleJSON `json:"-"`
}

func (*RuleDeleteResponseRulesRulesetsJSChallengeRule) UnmarshalJSON 

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

type RuleDeleteResponseRulesRulesetsJSChallengeRuleAction 

type RuleDeleteResponseRulesRulesetsJSChallengeRuleAction string

The action to perform when the rule matches. 

const (
	RuleDeleteResponseRulesRulesetsJSChallengeRuleActionJSChallenge RuleDeleteResponseRulesRulesetsJSChallengeRuleAction = "js_challenge"
)

func (RuleDeleteResponseRulesRulesetsJSChallengeRuleAction) IsKnown 

func (r RuleDeleteResponseRulesRulesetsJSChallengeRuleAction) IsKnown() bool

type RuleDeleteResponseRulesRulesetsJSChallengeRuleExposedCredentialCheck 

type RuleDeleteResponseRulesRulesetsJSChallengeRuleExposedCredentialCheck struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression string `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression string                                                                   `json:"username_expression" api:"required"`
	JSON               ruleDeleteResponseRulesRulesetsJSChallengeRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*RuleDeleteResponseRulesRulesetsJSChallengeRuleExposedCredentialCheck) UnmarshalJSON 

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

type RuleDeleteResponseRulesRulesetsJSChallengeRuleRatelimit 

type RuleDeleteResponseRulesRulesetsJSChallengeRuleRatelimit struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics []string `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period int64 `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression string `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout int64 `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod int64 `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin bool `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod int64 `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName string                                                      `json:"score_response_header_name"`
	JSON                    ruleDeleteResponseRulesRulesetsJSChallengeRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*RuleDeleteResponseRulesRulesetsJSChallengeRuleRatelimit) UnmarshalJSON 

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

type RuleDeleteResponseRulesRulesetsSetCacheControlRule added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRule struct {
	// The timestamp of when the rule was last modified.
	LastUpdated time.Time `json:"last_updated" api:"required" format:"date-time"`
	// The version of the rule.
	Version string `json:"version" api:"required"`
	// The unique ID of the rule.
	ID string `json:"id"`
	// The action to perform when the rule matches.
	Action RuleDeleteResponseRulesRulesetsSetCacheControlRuleAction `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParameters `json:"action_parameters"`
	// The categories of the rule.
	Categories []string `json:"categories"`
	// An informative description of the rule.
	Description string `json:"description"`
	// Whether the rule should be executed.
	Enabled bool `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck RuleDeleteResponseRulesRulesetsSetCacheControlRuleExposedCredentialCheck `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression string `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging Logging `json:"logging"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit RuleDeleteResponseRulesRulesetsSetCacheControlRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                                                 `json:"ref"`
	JSON ruleDeleteResponseRulesRulesetsSetCacheControlRuleJSON `json:"-"`
}

func (*RuleDeleteResponseRulesRulesetsSetCacheControlRule) UnmarshalJSON added in v6.9.0 

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

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleAction added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleAction string

The action to perform when the rule matches. 

const (
	RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionSetCacheControl RuleDeleteResponseRulesRulesetsSetCacheControlRuleAction = "set_cache_control"
)

func (RuleDeleteResponseRulesRulesetsSetCacheControlRuleAction) IsKnown added in v6.9.0 

func (r RuleDeleteResponseRulesRulesetsSetCacheControlRuleAction) IsKnown() bool

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParameters added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParameters struct {
	// A cache-control directive configuration.
	Immutable RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersImmutable `json:"immutable"`
	// A cache-control directive configuration that accepts a duration value in
	// seconds.
	MaxAge RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAge `json:"max-age"`
	// A cache-control directive configuration.
	MustRevalidate RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate `json:"must-revalidate"`
	// A cache-control directive configuration.
	MustUnderstand RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand `json:"must-understand"`
	// A cache-control directive configuration that accepts optional qualifiers (header
	// names).
	NoCache RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoCache `json:"no-cache"`
	// A cache-control directive configuration.
	NoStore RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoStore `json:"no-store"`
	// A cache-control directive configuration.
	NoTransform RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransform `json:"no-transform"`
	// A cache-control directive configuration that accepts optional qualifiers (header
	// names).
	Private RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPrivate `json:"private"`
	// A cache-control directive configuration.
	ProxyRevalidate RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate `json:"proxy-revalidate"`
	// A cache-control directive configuration.
	Public RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPublic `json:"public"`
	// A cache-control directive configuration that accepts a duration value in
	// seconds.
	SMaxage RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxage `json:"s-maxage"`
	// A cache-control directive configuration that accepts a duration value in
	// seconds.
	StaleIfError RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfError `json:"stale-if-error"`
	// A cache-control directive configuration that accepts a duration value in
	// seconds.
	StaleWhileRevalidate RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate `json:"stale-while-revalidate"`
	JSON                 ruleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersJSON                 `json:"-"`
}

The parameters configuring the rule's action.

func (*RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParameters) UnmarshalJSON added in v6.9.0 

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

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersImmutable added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersImmutable struct {
	// The operation to perform on the cache-control directive.
	Operation RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                            `json:"cloudflare_only"`
	JSON           ruleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration.

func (RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersImmutable) AsUnion added in v6.9.0 

func (r RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersImmutable) AsUnion() RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableUnion

AsUnion returns a RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective, RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective.

func (*RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersImmutable) UnmarshalJSON added in v6.9.0 

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

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation string

The operation to perform on the cache-control directive. 

const (
	RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperationSet    RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation = "set"
	RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperationRemove RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation = "remove"
)

func (RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation) IsKnown added in v6.9.0 

func (r RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation) IsKnown() bool

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                           `json:"cloudflare_only"`
	JSON           ruleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective) UnmarshalJSON added in v6.9.0 

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

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperationSet    RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation = "set"
	RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperationRemove RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation = "remove"
)

func (RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation) IsKnown() bool

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                        `json:"cloudflare_only"`
	JSON           ruleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveJSON `json:"-"`
}

Set the directive.

func (*RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective) UnmarshalJSON added in v6.9.0 

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

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperationSet    RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation = "set"
	RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperationRemove RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation = "remove"
)

func (RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation) IsKnown() bool

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableUnion added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Union satisfied by RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective or RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective.

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAge added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAge struct {
	// The operation to perform on the cache-control directive.
	Operation RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool `json:"cloudflare_only"`
	// The duration value in seconds for the directive.
	Value int64                                                                        `json:"value"`
	JSON  ruleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration that accepts a duration value in seconds.

func (RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAge) AsUnion added in v6.9.0 

func (r RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAge) AsUnion() RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeUnion

AsUnion returns a RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective, RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective.

func (*RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAge) UnmarshalJSON added in v6.9.0 

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

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation string

The operation to perform on the cache-control directive. 

const (
	RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperationSet    RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation = "set"
	RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperationRemove RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation = "remove"
)

func (RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation) IsKnown added in v6.9.0 

func (r RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation) IsKnown() bool

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                        `json:"cloudflare_only"`
	JSON           ruleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective) UnmarshalJSON added in v6.9.0 

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

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperationSet    RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation = "set"
	RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperationRemove RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation = "remove"
)

func (RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation) IsKnown() bool

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation `json:"operation" api:"required"`
	// The duration value in seconds for the directive.
	Value int64 `json:"value" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                     `json:"cloudflare_only"`
	JSON           ruleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveJSON `json:"-"`
}

Set the directive with a duration value in seconds.

func (*RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective) UnmarshalJSON added in v6.9.0 

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

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperationSet    RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation = "set"
	RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperationRemove RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation = "remove"
)

func (RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation) IsKnown() bool

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeUnion added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts a duration value in seconds.

Union satisfied by RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective or RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective.

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate struct {
	// The operation to perform on the cache-control directive.
	Operation RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                 `json:"cloudflare_only"`
	JSON           ruleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration.

func (RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate) AsUnion added in v6.9.0 

func (r RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate) AsUnion() RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateUnion

AsUnion returns a RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective, RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective.

func (*RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate) UnmarshalJSON added in v6.9.0 

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

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation string

The operation to perform on the cache-control directive. 

const (
	RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperationSet    RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation = "set"
	RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperationRemove RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation = "remove"
)

func (RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation) IsKnown added in v6.9.0 

func (r RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation) IsKnown() bool

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                                `json:"cloudflare_only"`
	JSON           ruleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective) UnmarshalJSON added in v6.9.0 

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

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperationSet    RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation = "set"
	RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperationRemove RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation = "remove"
)

func (RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation) IsKnown() bool

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                             `json:"cloudflare_only"`
	JSON           ruleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveJSON `json:"-"`
}

Set the directive.

func (*RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective) UnmarshalJSON added in v6.9.0 

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

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperationSet    RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation = "set"
	RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperationRemove RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation = "remove"
)

func (RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation) IsKnown() bool

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateUnion added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Union satisfied by RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective or RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective.

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand struct {
	// The operation to perform on the cache-control directive.
	Operation RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                 `json:"cloudflare_only"`
	JSON           ruleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration.

func (RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand) AsUnion added in v6.9.0 

func (r RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand) AsUnion() RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandUnion

AsUnion returns a RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective, RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective.

func (*RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand) UnmarshalJSON added in v6.9.0 

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

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation string

The operation to perform on the cache-control directive. 

const (
	RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperationSet    RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation = "set"
	RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperationRemove RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation = "remove"
)

func (RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation) IsKnown added in v6.9.0 

func (r RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation) IsKnown() bool

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                                `json:"cloudflare_only"`
	JSON           ruleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective) UnmarshalJSON added in v6.9.0 

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

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperationSet    RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation = "set"
	RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperationRemove RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation = "remove"
)

func (RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation) IsKnown() bool

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                             `json:"cloudflare_only"`
	JSON           ruleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveJSON `json:"-"`
}

Set the directive.

func (*RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective) UnmarshalJSON added in v6.9.0 

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

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperationSet    RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation = "set"
	RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperationRemove RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation = "remove"
)

func (RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation) IsKnown() bool

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandUnion added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Union satisfied by RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective or RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective.

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoCache added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoCache struct {
	// The operation to perform on the cache-control directive.
	Operation RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool `json:"cloudflare_only"`
	// This field can have the runtime type of [[]string].
	Qualifiers interface{}                                                                   `json:"qualifiers"`
	JSON       ruleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration that accepts optional qualifiers (header names).

func (RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoCache) AsUnion added in v6.9.0 

func (r RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoCache) AsUnion() RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheUnion

AsUnion returns a RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective, RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective.

func (*RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoCache) UnmarshalJSON added in v6.9.0 

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

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation string

The operation to perform on the cache-control directive. 

const (
	RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperationSet    RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation = "set"
	RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperationRemove RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation = "remove"
)

func (RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation) IsKnown added in v6.9.0 

func (r RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation) IsKnown() bool

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                         `json:"cloudflare_only"`
	JSON           ruleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective) UnmarshalJSON added in v6.9.0 

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

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperationSet    RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation = "set"
	RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperationRemove RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation = "remove"
)

func (RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation) IsKnown() bool

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool `json:"cloudflare_only"`
	// Optional list of header names to qualify the directive (e.g., for "private" or
	// "no-cache" directives).
	Qualifiers []string                                                                                  `json:"qualifiers"`
	JSON       ruleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveJSON `json:"-"`
}

Set the directive with optional qualifiers.

func (*RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective) UnmarshalJSON added in v6.9.0 

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

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperationSet    RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation = "set"
	RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperationRemove RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation = "remove"
)

func (RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation) IsKnown() bool

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheUnion added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts optional qualifiers (header names).

Union satisfied by RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective or RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective.

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoStore added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoStore struct {
	// The operation to perform on the cache-control directive.
	Operation RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                          `json:"cloudflare_only"`
	JSON           ruleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration.

func (RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoStore) AsUnion added in v6.9.0 

func (r RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoStore) AsUnion() RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreUnion

AsUnion returns a RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective, RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective.

func (*RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoStore) UnmarshalJSON added in v6.9.0 

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

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation string

The operation to perform on the cache-control directive. 

const (
	RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperationSet    RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation = "set"
	RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperationRemove RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation = "remove"
)

func (RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation) IsKnown added in v6.9.0 

func (r RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation) IsKnown() bool

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                         `json:"cloudflare_only"`
	JSON           ruleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective) UnmarshalJSON added in v6.9.0 

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

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperationSet    RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation = "set"
	RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperationRemove RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation = "remove"
)

func (RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation) IsKnown() bool

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                      `json:"cloudflare_only"`
	JSON           ruleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveJSON `json:"-"`
}

Set the directive.

func (*RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective) UnmarshalJSON added in v6.9.0 

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

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperationSet    RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation = "set"
	RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperationRemove RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation = "remove"
)

func (RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation) IsKnown() bool

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreUnion added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Union satisfied by RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective or RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective.

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransform added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransform struct {
	// The operation to perform on the cache-control directive.
	Operation RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                              `json:"cloudflare_only"`
	JSON           ruleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration.

func (RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransform) AsUnion added in v6.9.0 

func (r RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransform) AsUnion() RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformUnion

AsUnion returns a RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective, RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective.

func (*RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransform) UnmarshalJSON added in v6.9.0 

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

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation string

The operation to perform on the cache-control directive. 

const (
	RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperationSet    RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation = "set"
	RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperationRemove RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation = "remove"
)

func (RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation) IsKnown added in v6.9.0 

func (r RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation) IsKnown() bool

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                             `json:"cloudflare_only"`
	JSON           ruleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective) UnmarshalJSON added in v6.9.0 

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

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperationSet    RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation = "set"
	RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperationRemove RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation = "remove"
)

func (RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation) IsKnown() bool

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                          `json:"cloudflare_only"`
	JSON           ruleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveJSON `json:"-"`
}

Set the directive.

func (*RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective) UnmarshalJSON added in v6.9.0 

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

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperationSet    RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation = "set"
	RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperationRemove RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation = "remove"
)

func (RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation) IsKnown() bool

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformUnion added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Union satisfied by RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective or RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective.

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPrivate added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPrivate struct {
	// The operation to perform on the cache-control directive.
	Operation RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool `json:"cloudflare_only"`
	// This field can have the runtime type of [[]string].
	Qualifiers interface{}                                                                   `json:"qualifiers"`
	JSON       ruleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration that accepts optional qualifiers (header names).

func (RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPrivate) AsUnion added in v6.9.0 

func (r RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPrivate) AsUnion() RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateUnion

AsUnion returns a RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective, RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective.

func (*RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPrivate) UnmarshalJSON added in v6.9.0 

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

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation string

The operation to perform on the cache-control directive. 

const (
	RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperationSet    RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation = "set"
	RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperationRemove RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation = "remove"
)

func (RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation) IsKnown added in v6.9.0 

func (r RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation) IsKnown() bool

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                         `json:"cloudflare_only"`
	JSON           ruleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective) UnmarshalJSON added in v6.9.0 

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

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperationSet    RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation = "set"
	RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperationRemove RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation = "remove"
)

func (RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation) IsKnown() bool

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool `json:"cloudflare_only"`
	// Optional list of header names to qualify the directive (e.g., for "private" or
	// "no-cache" directives).
	Qualifiers []string                                                                                  `json:"qualifiers"`
	JSON       ruleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveJSON `json:"-"`
}

Set the directive with optional qualifiers.

func (*RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective) UnmarshalJSON added in v6.9.0 

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

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperationSet    RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation = "set"
	RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperationRemove RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation = "remove"
)

func (RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation) IsKnown() bool

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateUnion added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts optional qualifiers (header names).

Union satisfied by RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective or RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective.

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate struct {
	// The operation to perform on the cache-control directive.
	Operation RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                  `json:"cloudflare_only"`
	JSON           ruleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration.

func (RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate) AsUnion added in v6.9.0 

func (r RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate) AsUnion() RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateUnion

AsUnion returns a RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective, RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective.

func (*RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate) UnmarshalJSON added in v6.9.0 

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

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation string

The operation to perform on the cache-control directive. 

const (
	RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperationSet    RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation = "set"
	RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperationRemove RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation = "remove"
)

func (RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation) IsKnown added in v6.9.0 

func (r RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation) IsKnown() bool

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                                 `json:"cloudflare_only"`
	JSON           ruleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective) UnmarshalJSON added in v6.9.0 

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

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperationSet    RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation = "set"
	RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperationRemove RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation = "remove"
)

func (RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation) IsKnown() bool

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                              `json:"cloudflare_only"`
	JSON           ruleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveJSON `json:"-"`
}

Set the directive.

func (*RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective) UnmarshalJSON added in v6.9.0 

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

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperationSet    RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation = "set"
	RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperationRemove RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation = "remove"
)

func (RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation) IsKnown() bool

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateUnion added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Union satisfied by RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective or RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective.

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPublic added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPublic struct {
	// The operation to perform on the cache-control directive.
	Operation RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                         `json:"cloudflare_only"`
	JSON           ruleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPublicJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration.

func (RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPublic) AsUnion added in v6.9.0 

func (r RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPublic) AsUnion() RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPublicUnion

AsUnion returns a RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPublicUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective, RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective.

func (*RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPublic) UnmarshalJSON added in v6.9.0 

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

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation string

The operation to perform on the cache-control directive. 

const (
	RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperationSet    RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation = "set"
	RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperationRemove RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation = "remove"
)

func (RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation) IsKnown added in v6.9.0 

func (r RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation) IsKnown() bool

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                        `json:"cloudflare_only"`
	JSON           ruleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective) UnmarshalJSON added in v6.9.0 

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

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperationSet    RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation = "set"
	RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperationRemove RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation = "remove"
)

func (RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation) IsKnown() bool

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                     `json:"cloudflare_only"`
	JSON           ruleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveJSON `json:"-"`
}

Set the directive.

func (*RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective) UnmarshalJSON added in v6.9.0 

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

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperationSet    RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation = "set"
	RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperationRemove RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation = "remove"
)

func (RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation) IsKnown() bool

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPublicUnion added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPublicUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Union satisfied by RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective or RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective.

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxage added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxage struct {
	// The operation to perform on the cache-control directive.
	Operation RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool `json:"cloudflare_only"`
	// The duration value in seconds for the directive.
	Value int64                                                                         `json:"value"`
	JSON  ruleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration that accepts a duration value in seconds.

func (RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxage) AsUnion added in v6.9.0 

func (r RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxage) AsUnion() RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageUnion

AsUnion returns a RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective, RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective.

func (*RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxage) UnmarshalJSON added in v6.9.0 

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

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation string

The operation to perform on the cache-control directive. 

const (
	RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperationSet    RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation = "set"
	RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperationRemove RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation = "remove"
)

func (RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation) IsKnown added in v6.9.0 

func (r RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation) IsKnown() bool

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                         `json:"cloudflare_only"`
	JSON           ruleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective) UnmarshalJSON added in v6.9.0 

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

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperationSet    RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation = "set"
	RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperationRemove RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation = "remove"
)

func (RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation) IsKnown() bool

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation `json:"operation" api:"required"`
	// The duration value in seconds for the directive.
	Value int64 `json:"value" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                      `json:"cloudflare_only"`
	JSON           ruleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveJSON `json:"-"`
}

Set the directive with a duration value in seconds.

func (*RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective) UnmarshalJSON added in v6.9.0 

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

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperationSet    RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation = "set"
	RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperationRemove RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation = "remove"
)

func (RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation) IsKnown() bool

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageUnion added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts a duration value in seconds.

Union satisfied by RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective or RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective.

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfError added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfError struct {
	// The operation to perform on the cache-control directive.
	Operation RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool `json:"cloudflare_only"`
	// The duration value in seconds for the directive.
	Value int64                                                                              `json:"value"`
	JSON  ruleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration that accepts a duration value in seconds.

func (RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfError) AsUnion added in v6.9.0 

func (r RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfError) AsUnion() RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorUnion

AsUnion returns a RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective, RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective.

func (*RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfError) UnmarshalJSON added in v6.9.0 

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

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation string

The operation to perform on the cache-control directive. 

const (
	RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperationSet    RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation = "set"
	RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperationRemove RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation = "remove"
)

func (RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation) IsKnown added in v6.9.0 

func (r RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation) IsKnown() bool

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                              `json:"cloudflare_only"`
	JSON           ruleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective) UnmarshalJSON added in v6.9.0 

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

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperationSet    RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation = "set"
	RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperationRemove RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation = "remove"
)

func (RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation) IsKnown() bool

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation `json:"operation" api:"required"`
	// The duration value in seconds for the directive.
	Value int64 `json:"value" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                           `json:"cloudflare_only"`
	JSON           ruleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveJSON `json:"-"`
}

Set the directive with a duration value in seconds.

func (*RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective) UnmarshalJSON added in v6.9.0 

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

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperationSet    RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation = "set"
	RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperationRemove RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation = "remove"
)

func (RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation) IsKnown() bool

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorUnion added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts a duration value in seconds.

Union satisfied by RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective or RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective.

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate struct {
	// The operation to perform on the cache-control directive.
	Operation RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool `json:"cloudflare_only"`
	// The duration value in seconds for the directive.
	Value int64                                                                                      `json:"value"`
	JSON  ruleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration that accepts a duration value in seconds.

func (RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate) AsUnion added in v6.9.0 

func (r RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate) AsUnion() RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateUnion

AsUnion returns a RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective, RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective.

func (*RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate) UnmarshalJSON added in v6.9.0 

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

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation string

The operation to perform on the cache-control directive. 

const (
	RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperationSet    RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation = "set"
	RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperationRemove RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation = "remove"
)

func (RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation) IsKnown added in v6.9.0 

func (r RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation) IsKnown() bool

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                                      `json:"cloudflare_only"`
	JSON           ruleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective) UnmarshalJSON added in v6.9.0 

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

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperationSet    RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation = "set"
	RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperationRemove RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation = "remove"
)

func (RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation) IsKnown() bool

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation `json:"operation" api:"required"`
	// The duration value in seconds for the directive.
	Value int64 `json:"value" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                                   `json:"cloudflare_only"`
	JSON           ruleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveJSON `json:"-"`
}

Set the directive with a duration value in seconds.

func (*RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective) UnmarshalJSON added in v6.9.0 

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

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperationSet    RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation = "set"
	RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperationRemove RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation = "remove"
)

func (RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation) IsKnown() bool

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateUnion added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts a duration value in seconds.

Union satisfied by RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective or RuleDeleteResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective.

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleExposedCredentialCheck added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleExposedCredentialCheck struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression string `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression string                                                                       `json:"username_expression" api:"required"`
	JSON               ruleDeleteResponseRulesRulesetsSetCacheControlRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*RuleDeleteResponseRulesRulesetsSetCacheControlRuleExposedCredentialCheck) UnmarshalJSON added in v6.9.0 

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

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleRatelimit added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheControlRuleRatelimit struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics []string `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period int64 `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression string `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout int64 `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod int64 `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin bool `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod int64 `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName string                                                          `json:"score_response_header_name"`
	JSON                    ruleDeleteResponseRulesRulesetsSetCacheControlRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*RuleDeleteResponseRulesRulesetsSetCacheControlRuleRatelimit) UnmarshalJSON added in v6.9.0 

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

type RuleDeleteResponseRulesRulesetsSetCacheTagsRule added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheTagsRule struct {
	// The timestamp of when the rule was last modified.
	LastUpdated time.Time `json:"last_updated" api:"required" format:"date-time"`
	// The version of the rule.
	Version string `json:"version" api:"required"`
	// The unique ID of the rule.
	ID string `json:"id"`
	// The action to perform when the rule matches.
	Action RuleDeleteResponseRulesRulesetsSetCacheTagsRuleAction `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParameters `json:"action_parameters"`
	// The categories of the rule.
	Categories []string `json:"categories"`
	// An informative description of the rule.
	Description string `json:"description"`
	// Whether the rule should be executed.
	Enabled bool `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck RuleDeleteResponseRulesRulesetsSetCacheTagsRuleExposedCredentialCheck `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression string `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging Logging `json:"logging"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit RuleDeleteResponseRulesRulesetsSetCacheTagsRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                                              `json:"ref"`
	JSON ruleDeleteResponseRulesRulesetsSetCacheTagsRuleJSON `json:"-"`
}

func (*RuleDeleteResponseRulesRulesetsSetCacheTagsRule) UnmarshalJSON added in v6.9.0 

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

type RuleDeleteResponseRulesRulesetsSetCacheTagsRuleAction added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheTagsRuleAction string

The action to perform when the rule matches. 

const (
	RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionSetCacheTags RuleDeleteResponseRulesRulesetsSetCacheTagsRuleAction = "set_cache_tags"
)

func (RuleDeleteResponseRulesRulesetsSetCacheTagsRuleAction) IsKnown added in v6.9.0 

func (r RuleDeleteResponseRulesRulesetsSetCacheTagsRuleAction) IsKnown() bool

type RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParameters added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParameters struct {
	// The operation to perform on the cache tags.
	Operation RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation `json:"operation" api:"required"`
	// An expression that evaluates to an array of cache tag values.
	Expression string `json:"expression"`
	// This field can have the runtime type of [[]string].
	Values interface{}                                                         `json:"values"`
	JSON   ruleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersJSON `json:"-"`
	// contains filtered or unexported fields
}

The parameters configuring the rule's action.

func (RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParameters) AsUnion added in v6.9.0 

func (r RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParameters) AsUnion() RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersUnion

AsUnion returns a RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues, RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression, RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues, RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression, RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues, RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression.

func (*RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParameters) UnmarshalJSON added in v6.9.0 

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

type RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression struct {
	// An expression that evaluates to an array of cache tag values.
	Expression string `json:"expression" api:"required"`
	// The operation to perform on the cache tags.
	Operation RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation `json:"operation" api:"required"`
	JSON      ruleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionJSON      `json:"-"`
}

Add cache tags using an expression.

func (*RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression) UnmarshalJSON added in v6.9.0 

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

type RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation string

The operation to perform on the cache tags. 

const (
	RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationAdd    RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "add"
	RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationRemove RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "remove"
	RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationSet    RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "set"
)

func (RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation) IsKnown added in v6.9.0 

func (r RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation) IsKnown() bool

type RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues struct {
	// The operation to perform on the cache tags.
	Operation RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation `json:"operation" api:"required"`
	// A list of cache tag values.
	Values []string                                                                              `json:"values" api:"required"`
	JSON   ruleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesJSON `json:"-"`
}

Add cache tags using a list of values.

func (*RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues) UnmarshalJSON added in v6.9.0 

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

type RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation string

The operation to perform on the cache tags. 

const (
	RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationAdd    RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "add"
	RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationRemove RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "remove"
	RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationSet    RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "set"
)

func (RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation) IsKnown added in v6.9.0 

func (r RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation) IsKnown() bool

type RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation string

The operation to perform on the cache tags. 

const (
	RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersOperationAdd    RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation = "add"
	RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersOperationRemove RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation = "remove"
	RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersOperationSet    RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation = "set"
)

func (RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation) IsKnown added in v6.9.0 

func (r RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation) IsKnown() bool

type RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression struct {
	// An expression that evaluates to an array of cache tag values.
	Expression string `json:"expression" api:"required"`
	// The operation to perform on the cache tags.
	Operation RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation `json:"operation" api:"required"`
	JSON      ruleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionJSON      `json:"-"`
}

Remove cache tags using an expression.

func (*RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression) UnmarshalJSON added in v6.9.0 

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

type RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation string

The operation to perform on the cache tags. 

const (
	RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationAdd    RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "add"
	RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationRemove RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "remove"
	RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationSet    RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "set"
)

func (RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation) IsKnown added in v6.9.0 

func (r RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation) IsKnown() bool

type RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues struct {
	// The operation to perform on the cache tags.
	Operation RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation `json:"operation" api:"required"`
	// A list of cache tag values.
	Values []string                                                                                 `json:"values" api:"required"`
	JSON   ruleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesJSON `json:"-"`
}

Remove cache tags using a list of values.

func (*RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues) UnmarshalJSON added in v6.9.0 

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

type RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation string

The operation to perform on the cache tags. 

const (
	RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationAdd    RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "add"
	RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationRemove RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "remove"
	RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationSet    RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "set"
)

func (RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation) IsKnown added in v6.9.0 

func (r RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation) IsKnown() bool

type RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression struct {
	// An expression that evaluates to an array of cache tag values.
	Expression string `json:"expression" api:"required"`
	// The operation to perform on the cache tags.
	Operation RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation `json:"operation" api:"required"`
	JSON      ruleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionJSON      `json:"-"`
}

Set cache tags using an expression.

func (*RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression) UnmarshalJSON added in v6.9.0 

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

type RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation string

The operation to perform on the cache tags. 

const (
	RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationAdd    RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "add"
	RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationRemove RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "remove"
	RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationSet    RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "set"
)

func (RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation) IsKnown added in v6.9.0 

func (r RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation) IsKnown() bool

type RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues struct {
	// The operation to perform on the cache tags.
	Operation RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation `json:"operation" api:"required"`
	// A list of cache tag values.
	Values []string                                                                              `json:"values" api:"required"`
	JSON   ruleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesJSON `json:"-"`
}

Set cache tags using a list of values.

func (*RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues) UnmarshalJSON added in v6.9.0 

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

type RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation string

The operation to perform on the cache tags. 

const (
	RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationAdd    RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "add"
	RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationRemove RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "remove"
	RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationSet    RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "set"
)

func (RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation) IsKnown added in v6.9.0 

func (r RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation) IsKnown() bool

type RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersUnion added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersUnion interface {
	// contains filtered or unexported methods
}

The parameters configuring the rule's action.

Union satisfied by RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues, RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression, RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues, RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression, RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues or RuleDeleteResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression.

type RuleDeleteResponseRulesRulesetsSetCacheTagsRuleExposedCredentialCheck added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheTagsRuleExposedCredentialCheck struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression string `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression string                                                                    `json:"username_expression" api:"required"`
	JSON               ruleDeleteResponseRulesRulesetsSetCacheTagsRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*RuleDeleteResponseRulesRulesetsSetCacheTagsRuleExposedCredentialCheck) UnmarshalJSON added in v6.9.0 

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

type RuleDeleteResponseRulesRulesetsSetCacheTagsRuleRatelimit added in v6.9.0 

type RuleDeleteResponseRulesRulesetsSetCacheTagsRuleRatelimit struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics []string `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period int64 `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression string `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout int64 `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod int64 `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin bool `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod int64 `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName string                                                       `json:"score_response_header_name"`
	JSON                    ruleDeleteResponseRulesRulesetsSetCacheTagsRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*RuleDeleteResponseRulesRulesetsSetCacheTagsRuleRatelimit) UnmarshalJSON added in v6.9.0 

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

type RuleDeleteResponseRulesUnion 

type RuleDeleteResponseRulesUnion interface {
	// contains filtered or unexported methods
}

Union satisfied by BlockRule, RuleDeleteResponseRulesRulesetsChallengeRule, CompressResponseRule, DDoSDynamicRule, ExecuteRule, ForceConnectionCloseRule, RuleDeleteResponseRulesRulesetsJSChallengeRule, LogRule, LogCustomFieldRule, ManagedChallengeRule, RedirectRule, RewriteRule, RouteRule, ScoreRule, ServeErrorRule, RuleDeleteResponseRulesRulesetsSetCacheControlRule, SetCacheSettingsRule, RuleDeleteResponseRulesRulesetsSetCacheTagsRule, SetConfigRule or SkipRule.

type RuleEditParams 

type RuleEditParams struct {
	Body RuleEditParamsBodyUnion `json:"body" api:"required"`
	// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
	AccountID param.Field[string] `path:"account_id"`
	// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
	ZoneID param.Field[string] `path:"zone_id"`
}

func (RuleEditParams) MarshalJSON 

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

type RuleEditParamsBody 

type RuleEditParamsBody struct {
	// The unique ID of the rule.
	ID param.Field[string] `json:"id"`
	// The action to perform when the rule matches.
	Action           param.Field[RuleEditParamsBodyAction] `json:"action"`
	ActionParameters param.Field[interface{}]              `json:"action_parameters"`
	Categories       param.Field[interface{}]              `json:"categories"`
	// An informative description of the rule.
	Description param.Field[string] `json:"description"`
	// Whether the rule should be executed.
	Enabled                param.Field[bool]        `json:"enabled"`
	ExposedCredentialCheck param.Field[interface{}] `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression param.Field[string] `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging   param.Field[LoggingParam] `json:"logging"`
	Position  param.Field[interface{}]  `json:"position"`
	Ratelimit param.Field[interface{}]  `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref param.Field[string] `json:"ref"`
}

func (RuleEditParamsBody) MarshalJSON 

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

type RuleEditParamsBodyAction 

type RuleEditParamsBodyAction string

The action to perform when the rule matches. 

const (
	RuleEditParamsBodyActionBlock                RuleEditParamsBodyAction = "block"
	RuleEditParamsBodyActionChallenge            RuleEditParamsBodyAction = "challenge"
	RuleEditParamsBodyActionCompressResponse     RuleEditParamsBodyAction = "compress_response"
	RuleEditParamsBodyActionDDoSDynamic          RuleEditParamsBodyAction = "ddos_dynamic"
	RuleEditParamsBodyActionExecute              RuleEditParamsBodyAction = "execute"
	RuleEditParamsBodyActionForceConnectionClose RuleEditParamsBodyAction = "force_connection_close"
	RuleEditParamsBodyActionJSChallenge          RuleEditParamsBodyAction = "js_challenge"
	RuleEditParamsBodyActionLog                  RuleEditParamsBodyAction = "log"
	RuleEditParamsBodyActionLogCustomField       RuleEditParamsBodyAction = "log_custom_field"
	RuleEditParamsBodyActionManagedChallenge     RuleEditParamsBodyAction = "managed_challenge"
	RuleEditParamsBodyActionRedirect             RuleEditParamsBodyAction = "redirect"
	RuleEditParamsBodyActionRewrite              RuleEditParamsBodyAction = "rewrite"
	RuleEditParamsBodyActionRoute                RuleEditParamsBodyAction = "route"
	RuleEditParamsBodyActionScore                RuleEditParamsBodyAction = "score"
	RuleEditParamsBodyActionServeError           RuleEditParamsBodyAction = "serve_error"
	RuleEditParamsBodyActionSetCacheControl      RuleEditParamsBodyAction = "set_cache_control"
	RuleEditParamsBodyActionSetCacheSettings     RuleEditParamsBodyAction = "set_cache_settings"
	RuleEditParamsBodyActionSetCacheTags         RuleEditParamsBodyAction = "set_cache_tags"
	RuleEditParamsBodyActionSetConfig            RuleEditParamsBodyAction = "set_config"
	RuleEditParamsBodyActionSkip                 RuleEditParamsBodyAction = "skip"
)

func (RuleEditParamsBodyAction) IsKnown 

func (r RuleEditParamsBodyAction) IsKnown() bool

type RuleEditParamsBodyBlockRule 

type RuleEditParamsBodyBlockRule struct {
	// An object configuring where the rule will be placed.
	Position param.Field[RuleEditParamsBodyBlockRulePositionUnion] `json:"position"`
	BlockRuleParam
}

func (RuleEditParamsBodyBlockRule) MarshalJSON 

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

type RuleEditParamsBodyBlockRulePosition 

type RuleEditParamsBodyBlockRulePosition struct {
	// The ID of another rule to place the rule after. An empty value causes the rule
	// to be placed at the bottom.
	After param.Field[string] `json:"after"`
	// The ID of another rule to place the rule before. An empty value causes the rule
	// to be placed at the top.
	Before param.Field[string] `json:"before"`
	// An index at which to place the rule, where index 1 is the first rule.
	Index param.Field[int64] `json:"index"`
}

An object configuring where the rule will be placed.

func (RuleEditParamsBodyBlockRulePosition) MarshalJSON 

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

type RuleEditParamsBodyBlockRulePositionAfterPosition 

type RuleEditParamsBodyBlockRulePositionAfterPosition struct {
	// The ID of another rule to place the rule after. An empty value causes the rule
	// to be placed at the bottom.
	After param.Field[string] `json:"after"`
}

An object configuring where the rule will be placed.

func (RuleEditParamsBodyBlockRulePositionAfterPosition) MarshalJSON 

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

type RuleEditParamsBodyBlockRulePositionBeforePosition 

type RuleEditParamsBodyBlockRulePositionBeforePosition struct {
	// The ID of another rule to place the rule before. An empty value causes the rule
	// to be placed at the top.
	Before param.Field[string] `json:"before"`
}

An object configuring where the rule will be placed.

func (RuleEditParamsBodyBlockRulePositionBeforePosition) MarshalJSON 

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

type RuleEditParamsBodyBlockRulePositionIndexPosition 

type RuleEditParamsBodyBlockRulePositionIndexPosition struct {
	// An index at which to place the rule, where index 1 is the first rule.
	Index param.Field[int64] `json:"index"`
}

An object configuring where the rule will be placed.

func (RuleEditParamsBodyBlockRulePositionIndexPosition) MarshalJSON 

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

type RuleEditParamsBodyBlockRulePositionUnion 

type RuleEditParamsBodyBlockRulePositionUnion interface {
	// contains filtered or unexported methods
}

An object configuring where the rule will be placed.

Satisfied by rulesets.RuleEditParamsBodyBlockRulePositionBeforePosition, rulesets.RuleEditParamsBodyBlockRulePositionAfterPosition, rulesets.RuleEditParamsBodyBlockRulePositionIndexPosition, RuleEditParamsBodyBlockRulePosition.

type RuleEditParamsBodyChallengeRule 

type RuleEditParamsBodyChallengeRule struct {
	// The unique ID of the rule.
	ID param.Field[string] `json:"id"`
	// The action to perform when the rule matches.
	Action param.Field[RuleEditParamsBodyChallengeRuleAction] `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters param.Field[interface{}] `json:"action_parameters"`
	// An informative description of the rule.
	Description param.Field[string] `json:"description"`
	// Whether the rule should be executed.
	Enabled param.Field[bool] `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck param.Field[RuleEditParamsBodyChallengeRuleExposedCredentialCheck] `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression param.Field[string] `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging param.Field[LoggingParam] `json:"logging"`
	// An object configuring where the rule will be placed.
	Position param.Field[RuleEditParamsBodyChallengeRulePositionUnion] `json:"position"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit param.Field[RuleEditParamsBodyChallengeRuleRatelimit] `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref param.Field[string] `json:"ref"`
}

func (RuleEditParamsBodyChallengeRule) MarshalJSON 

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

type RuleEditParamsBodyChallengeRuleAction 

type RuleEditParamsBodyChallengeRuleAction string

The action to perform when the rule matches. 

const (
	RuleEditParamsBodyChallengeRuleActionChallenge RuleEditParamsBodyChallengeRuleAction = "challenge"
)

func (RuleEditParamsBodyChallengeRuleAction) IsKnown 

func (r RuleEditParamsBodyChallengeRuleAction) IsKnown() bool

type RuleEditParamsBodyChallengeRuleExposedCredentialCheck 

type RuleEditParamsBodyChallengeRuleExposedCredentialCheck struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression param.Field[string] `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression param.Field[string] `json:"username_expression" api:"required"`
}

Configuration for exposed credential checking.

func (RuleEditParamsBodyChallengeRuleExposedCredentialCheck) MarshalJSON 

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

type RuleEditParamsBodyChallengeRulePosition 

type RuleEditParamsBodyChallengeRulePosition struct {
	// The ID of another rule to place the rule after. An empty value causes the rule
	// to be placed at the bottom.
	After param.Field[string] `json:"after"`
	// The ID of another rule to place the rule before. An empty value causes the rule
	// to be placed at the top.
	Before param.Field[string] `json:"before"`
	// An index at which to place the rule, where index 1 is the first rule.
	Index param.Field[int64] `json:"index"`
}

An object configuring where the rule will be placed.

func (RuleEditParamsBodyChallengeRulePosition) MarshalJSON 

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

type RuleEditParamsBodyChallengeRulePositionAfterPosition 

type RuleEditParamsBodyChallengeRulePositionAfterPosition struct {
	// The ID of another rule to place the rule after. An empty value causes the rule
	// to be placed at the bottom.
	After param.Field[string] `json:"after"`
}

An object configuring where the rule will be placed.

func (RuleEditParamsBodyChallengeRulePositionAfterPosition) MarshalJSON 

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

type RuleEditParamsBodyChallengeRulePositionBeforePosition 

type RuleEditParamsBodyChallengeRulePositionBeforePosition struct {
	// The ID of another rule to place the rule before. An empty value causes the rule
	// to be placed at the top.
	Before param.Field[string] `json:"before"`
}

An object configuring where the rule will be placed.

func (RuleEditParamsBodyChallengeRulePositionBeforePosition) MarshalJSON 

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

type RuleEditParamsBodyChallengeRulePositionIndexPosition 

type RuleEditParamsBodyChallengeRulePositionIndexPosition struct {
	// An index at which to place the rule, where index 1 is the first rule.
	Index param.Field[int64] `json:"index"`
}

An object configuring where the rule will be placed.

func (RuleEditParamsBodyChallengeRulePositionIndexPosition) MarshalJSON 

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

type RuleEditParamsBodyChallengeRulePositionUnion 

type RuleEditParamsBodyChallengeRulePositionUnion interface {
	// contains filtered or unexported methods
}

An object configuring where the rule will be placed.

Satisfied by rulesets.RuleEditParamsBodyChallengeRulePositionBeforePosition, rulesets.RuleEditParamsBodyChallengeRulePositionAfterPosition, rulesets.RuleEditParamsBodyChallengeRulePositionIndexPosition, RuleEditParamsBodyChallengeRulePosition.

type RuleEditParamsBodyChallengeRuleRatelimit 

type RuleEditParamsBodyChallengeRuleRatelimit struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics param.Field[[]string] `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period param.Field[int64] `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression param.Field[string] `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout param.Field[int64] `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod param.Field[int64] `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin param.Field[bool] `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod param.Field[int64] `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName param.Field[string] `json:"score_response_header_name"`
}

An object configuring the rule's rate limit behavior.

func (RuleEditParamsBodyChallengeRuleRatelimit) MarshalJSON 

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

type RuleEditParamsBodyDDoSDynamicRule 

type RuleEditParamsBodyDDoSDynamicRule struct {
	// An object configuring where the rule will be placed.
	Position param.Field[RuleEditParamsBodyDDoSDynamicRulePositionUnion] `json:"position"`
	DDoSDynamicRuleParam
}

func (RuleEditParamsBodyDDoSDynamicRule) MarshalJSON 

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

type RuleEditParamsBodyDDoSDynamicRulePosition 

type RuleEditParamsBodyDDoSDynamicRulePosition struct {
	// The ID of another rule to place the rule after. An empty value causes the rule
	// to be placed at the bottom.
	After param.Field[string] `json:"after"`
	// The ID of another rule to place the rule before. An empty value causes the rule
	// to be placed at the top.
	Before param.Field[string] `json:"before"`
	// An index at which to place the rule, where index 1 is the first rule.
	Index param.Field[int64] `json:"index"`
}

An object configuring where the rule will be placed.

func (RuleEditParamsBodyDDoSDynamicRulePosition) MarshalJSON 

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

type RuleEditParamsBodyDDoSDynamicRulePositionAfterPosition 

type RuleEditParamsBodyDDoSDynamicRulePositionAfterPosition struct {
	// The ID of another rule to place the rule after. An empty value causes the rule
	// to be placed at the bottom.
	After param.Field[string] `json:"after"`
}

An object configuring where the rule will be placed.

func (RuleEditParamsBodyDDoSDynamicRulePositionAfterPosition) MarshalJSON 

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

type RuleEditParamsBodyDDoSDynamicRulePositionBeforePosition 

type RuleEditParamsBodyDDoSDynamicRulePositionBeforePosition struct {
	// The ID of another rule to place the rule before. An empty value causes the rule
	// to be placed at the top.
	Before param.Field[string] `json:"before"`
}

An object configuring where the rule will be placed.

func (RuleEditParamsBodyDDoSDynamicRulePositionBeforePosition) MarshalJSON 

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

type RuleEditParamsBodyDDoSDynamicRulePositionIndexPosition 

type RuleEditParamsBodyDDoSDynamicRulePositionIndexPosition struct {
	// An index at which to place the rule, where index 1 is the first rule.
	Index param.Field[int64] `json:"index"`
}

An object configuring where the rule will be placed.

func (RuleEditParamsBodyDDoSDynamicRulePositionIndexPosition) MarshalJSON 

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

type RuleEditParamsBodyDDoSDynamicRulePositionUnion 

type RuleEditParamsBodyDDoSDynamicRulePositionUnion interface {
	// contains filtered or unexported methods
}

An object configuring where the rule will be placed.

Satisfied by rulesets.RuleEditParamsBodyDDoSDynamicRulePositionBeforePosition, rulesets.RuleEditParamsBodyDDoSDynamicRulePositionAfterPosition, rulesets.RuleEditParamsBodyDDoSDynamicRulePositionIndexPosition, RuleEditParamsBodyDDoSDynamicRulePosition.

type RuleEditParamsBodyExecuteRule 

type RuleEditParamsBodyExecuteRule struct {
	// An object configuring where the rule will be placed.
	Position param.Field[RuleEditParamsBodyExecuteRulePositionUnion] `json:"position"`
	ExecuteRuleParam
}

func (RuleEditParamsBodyExecuteRule) MarshalJSON 

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

type RuleEditParamsBodyExecuteRulePosition 

type RuleEditParamsBodyExecuteRulePosition struct {
	// The ID of another rule to place the rule after. An empty value causes the rule
	// to be placed at the bottom.
	After param.Field[string] `json:"after"`
	// The ID of another rule to place the rule before. An empty value causes the rule
	// to be placed at the top.
	Before param.Field[string] `json:"before"`
	// An index at which to place the rule, where index 1 is the first rule.
	Index param.Field[int64] `json:"index"`
}

An object configuring where the rule will be placed.

func (RuleEditParamsBodyExecuteRulePosition) MarshalJSON 

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

type RuleEditParamsBodyExecuteRulePositionAfterPosition 

type RuleEditParamsBodyExecuteRulePositionAfterPosition struct {
	// The ID of another rule to place the rule after. An empty value causes the rule
	// to be placed at the bottom.
	After param.Field[string] `json:"after"`
}

An object configuring where the rule will be placed.

func (RuleEditParamsBodyExecuteRulePositionAfterPosition) MarshalJSON 

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

type RuleEditParamsBodyExecuteRulePositionBeforePosition 

type RuleEditParamsBodyExecuteRulePositionBeforePosition struct {
	// The ID of another rule to place the rule before. An empty value causes the rule
	// to be placed at the top.
	Before param.Field[string] `json:"before"`
}

An object configuring where the rule will be placed.

func (RuleEditParamsBodyExecuteRulePositionBeforePosition) MarshalJSON 

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

type RuleEditParamsBodyExecuteRulePositionIndexPosition 

type RuleEditParamsBodyExecuteRulePositionIndexPosition struct {
	// An index at which to place the rule, where index 1 is the first rule.
	Index param.Field[int64] `json:"index"`
}

An object configuring where the rule will be placed.

func (RuleEditParamsBodyExecuteRulePositionIndexPosition) MarshalJSON 

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

type RuleEditParamsBodyExecuteRulePositionUnion 

type RuleEditParamsBodyExecuteRulePositionUnion interface {
	// contains filtered or unexported methods
}

An object configuring where the rule will be placed.

Satisfied by rulesets.RuleEditParamsBodyExecuteRulePositionBeforePosition, rulesets.RuleEditParamsBodyExecuteRulePositionAfterPosition, rulesets.RuleEditParamsBodyExecuteRulePositionIndexPosition, RuleEditParamsBodyExecuteRulePosition.

type RuleEditParamsBodyForceConnectionCloseRule 

type RuleEditParamsBodyForceConnectionCloseRule struct {
	// An object configuring where the rule will be placed.
	Position param.Field[RuleEditParamsBodyForceConnectionCloseRulePositionUnion] `json:"position"`
	ForceConnectionCloseRuleParam
}

func (RuleEditParamsBodyForceConnectionCloseRule) MarshalJSON 

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

type RuleEditParamsBodyForceConnectionCloseRulePosition 

type RuleEditParamsBodyForceConnectionCloseRulePosition struct {
	// The ID of another rule to place the rule after. An empty value causes the rule
	// to be placed at the bottom.
	After param.Field[string] `json:"after"`
	// The ID of another rule to place the rule before. An empty value causes the rule
	// to be placed at the top.
	Before param.Field[string] `json:"before"`
	// An index at which to place the rule, where index 1 is the first rule.
	Index param.Field[int64] `json:"index"`
}

An object configuring where the rule will be placed.

func (RuleEditParamsBodyForceConnectionCloseRulePosition) MarshalJSON 

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

type RuleEditParamsBodyForceConnectionCloseRulePositionAfterPosition 

type RuleEditParamsBodyForceConnectionCloseRulePositionAfterPosition struct {
	// The ID of another rule to place the rule after. An empty value causes the rule
	// to be placed at the bottom.
	After param.Field[string] `json:"after"`
}

An object configuring where the rule will be placed.

func (RuleEditParamsBodyForceConnectionCloseRulePositionAfterPosition) MarshalJSON 

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

type RuleEditParamsBodyForceConnectionCloseRulePositionBeforePosition 

type RuleEditParamsBodyForceConnectionCloseRulePositionBeforePosition struct {
	// The ID of another rule to place the rule before. An empty value causes the rule
	// to be placed at the top.
	Before param.Field[string] `json:"before"`
}

An object configuring where the rule will be placed.

func (RuleEditParamsBodyForceConnectionCloseRulePositionBeforePosition) MarshalJSON 

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

type RuleEditParamsBodyForceConnectionCloseRulePositionIndexPosition 

type RuleEditParamsBodyForceConnectionCloseRulePositionIndexPosition struct {
	// An index at which to place the rule, where index 1 is the first rule.
	Index param.Field[int64] `json:"index"`
}

An object configuring where the rule will be placed.

func (RuleEditParamsBodyForceConnectionCloseRulePositionIndexPosition) MarshalJSON 

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

type RuleEditParamsBodyForceConnectionCloseRulePositionUnion 

type RuleEditParamsBodyForceConnectionCloseRulePositionUnion interface {
	// contains filtered or unexported methods
}

An object configuring where the rule will be placed.

Satisfied by rulesets.RuleEditParamsBodyForceConnectionCloseRulePositionBeforePosition, rulesets.RuleEditParamsBodyForceConnectionCloseRulePositionAfterPosition, rulesets.RuleEditParamsBodyForceConnectionCloseRulePositionIndexPosition, RuleEditParamsBodyForceConnectionCloseRulePosition.

type RuleEditParamsBodyJavaScriptChallengeRule 

type RuleEditParamsBodyJavaScriptChallengeRule struct {
	// The unique ID of the rule.
	ID param.Field[string] `json:"id"`
	// The action to perform when the rule matches.
	Action param.Field[RuleEditParamsBodyJavaScriptChallengeRuleAction] `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters param.Field[interface{}] `json:"action_parameters"`
	// An informative description of the rule.
	Description param.Field[string] `json:"description"`
	// Whether the rule should be executed.
	Enabled param.Field[bool] `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck param.Field[RuleEditParamsBodyJavaScriptChallengeRuleExposedCredentialCheck] `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression param.Field[string] `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging param.Field[LoggingParam] `json:"logging"`
	// An object configuring where the rule will be placed.
	Position param.Field[RuleEditParamsBodyJavaScriptChallengeRulePositionUnion] `json:"position"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit param.Field[RuleEditParamsBodyJavaScriptChallengeRuleRatelimit] `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref param.Field[string] `json:"ref"`
}

func (RuleEditParamsBodyJavaScriptChallengeRule) MarshalJSON 

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

type RuleEditParamsBodyJavaScriptChallengeRuleAction 

type RuleEditParamsBodyJavaScriptChallengeRuleAction string

The action to perform when the rule matches. 

const (
	RuleEditParamsBodyJavaScriptChallengeRuleActionJSChallenge RuleEditParamsBodyJavaScriptChallengeRuleAction = "js_challenge"
)

func (RuleEditParamsBodyJavaScriptChallengeRuleAction) IsKnown 

func (r RuleEditParamsBodyJavaScriptChallengeRuleAction) IsKnown() bool

type RuleEditParamsBodyJavaScriptChallengeRuleExposedCredentialCheck 

type RuleEditParamsBodyJavaScriptChallengeRuleExposedCredentialCheck struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression param.Field[string] `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression param.Field[string] `json:"username_expression" api:"required"`
}

Configuration for exposed credential checking.

func (RuleEditParamsBodyJavaScriptChallengeRuleExposedCredentialCheck) MarshalJSON 

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

type RuleEditParamsBodyJavaScriptChallengeRulePosition 

type RuleEditParamsBodyJavaScriptChallengeRulePosition struct {
	// The ID of another rule to place the rule after. An empty value causes the rule
	// to be placed at the bottom.
	After param.Field[string] `json:"after"`
	// The ID of another rule to place the rule before. An empty value causes the rule
	// to be placed at the top.
	Before param.Field[string] `json:"before"`
	// An index at which to place the rule, where index 1 is the first rule.
	Index param.Field[int64] `json:"index"`
}

An object configuring where the rule will be placed.

func (RuleEditParamsBodyJavaScriptChallengeRulePosition) MarshalJSON 

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

type RuleEditParamsBodyJavaScriptChallengeRulePositionAfterPosition 

type RuleEditParamsBodyJavaScriptChallengeRulePositionAfterPosition struct {
	// The ID of another rule to place the rule after. An empty value causes the rule
	// to be placed at the bottom.
	After param.Field[string] `json:"after"`
}

An object configuring where the rule will be placed.

func (RuleEditParamsBodyJavaScriptChallengeRulePositionAfterPosition) MarshalJSON 

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

type RuleEditParamsBodyJavaScriptChallengeRulePositionBeforePosition 

type RuleEditParamsBodyJavaScriptChallengeRulePositionBeforePosition struct {
	// The ID of another rule to place the rule before. An empty value causes the rule
	// to be placed at the top.
	Before param.Field[string] `json:"before"`
}

An object configuring where the rule will be placed.

func (RuleEditParamsBodyJavaScriptChallengeRulePositionBeforePosition) MarshalJSON 

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

type RuleEditParamsBodyJavaScriptChallengeRulePositionIndexPosition 

type RuleEditParamsBodyJavaScriptChallengeRulePositionIndexPosition struct {
	// An index at which to place the rule, where index 1 is the first rule.
	Index param.Field[int64] `json:"index"`
}

An object configuring where the rule will be placed.

func (RuleEditParamsBodyJavaScriptChallengeRulePositionIndexPosition) MarshalJSON 

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

type RuleEditParamsBodyJavaScriptChallengeRulePositionUnion 

type RuleEditParamsBodyJavaScriptChallengeRulePositionUnion interface {
	// contains filtered or unexported methods
}

An object configuring where the rule will be placed.

Satisfied by rulesets.RuleEditParamsBodyJavaScriptChallengeRulePositionBeforePosition, rulesets.RuleEditParamsBodyJavaScriptChallengeRulePositionAfterPosition, rulesets.RuleEditParamsBodyJavaScriptChallengeRulePositionIndexPosition, RuleEditParamsBodyJavaScriptChallengeRulePosition.

type RuleEditParamsBodyJavaScriptChallengeRuleRatelimit 

type RuleEditParamsBodyJavaScriptChallengeRuleRatelimit struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics param.Field[[]string] `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period param.Field[int64] `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression param.Field[string] `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout param.Field[int64] `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod param.Field[int64] `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin param.Field[bool] `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod param.Field[int64] `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName param.Field[string] `json:"score_response_header_name"`
}

An object configuring the rule's rate limit behavior.

func (RuleEditParamsBodyJavaScriptChallengeRuleRatelimit) MarshalJSON 

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

type RuleEditParamsBodyLogCustomFieldRule 

type RuleEditParamsBodyLogCustomFieldRule struct {
	// An object configuring where the rule will be placed.
	Position param.Field[RuleEditParamsBodyLogCustomFieldRulePositionUnion] `json:"position"`
	LogCustomFieldRuleParam
}

func (RuleEditParamsBodyLogCustomFieldRule) MarshalJSON 

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

type RuleEditParamsBodyLogCustomFieldRulePosition 

type RuleEditParamsBodyLogCustomFieldRulePosition struct {
	// The ID of another rule to place the rule after. An empty value causes the rule
	// to be placed at the bottom.
	After param.Field[string] `json:"after"`
	// The ID of another rule to place the rule before. An empty value causes the rule
	// to be placed at the top.
	Before param.Field[string] `json:"before"`
	// An index at which to place the rule, where index 1 is the first rule.
	Index param.Field[int64] `json:"index"`
}

An object configuring where the rule will be placed.

func (RuleEditParamsBodyLogCustomFieldRulePosition) MarshalJSON 

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

type RuleEditParamsBodyLogCustomFieldRulePositionAfterPosition 

type RuleEditParamsBodyLogCustomFieldRulePositionAfterPosition struct {
	// The ID of another rule to place the rule after. An empty value causes the rule
	// to be placed at the bottom.
	After param.Field[string] `json:"after"`
}

An object configuring where the rule will be placed.

func (RuleEditParamsBodyLogCustomFieldRulePositionAfterPosition) MarshalJSON 

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

type RuleEditParamsBodyLogCustomFieldRulePositionBeforePosition 

type RuleEditParamsBodyLogCustomFieldRulePositionBeforePosition struct {
	// The ID of another rule to place the rule before. An empty value causes the rule
	// to be placed at the top.
	Before param.Field[string] `json:"before"`
}

An object configuring where the rule will be placed.

func (RuleEditParamsBodyLogCustomFieldRulePositionBeforePosition) MarshalJSON 

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

type RuleEditParamsBodyLogCustomFieldRulePositionIndexPosition 

type RuleEditParamsBodyLogCustomFieldRulePositionIndexPosition struct {
	// An index at which to place the rule, where index 1 is the first rule.
	Index param.Field[int64] `json:"index"`
}

An object configuring where the rule will be placed.

func (RuleEditParamsBodyLogCustomFieldRulePositionIndexPosition) MarshalJSON 

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

type RuleEditParamsBodyLogCustomFieldRulePositionUnion 

type RuleEditParamsBodyLogCustomFieldRulePositionUnion interface {
	// contains filtered or unexported methods
}

An object configuring where the rule will be placed.

Satisfied by rulesets.RuleEditParamsBodyLogCustomFieldRulePositionBeforePosition, rulesets.RuleEditParamsBodyLogCustomFieldRulePositionAfterPosition, rulesets.RuleEditParamsBodyLogCustomFieldRulePositionIndexPosition, RuleEditParamsBodyLogCustomFieldRulePosition.

type RuleEditParamsBodyLogRule 

type RuleEditParamsBodyLogRule struct {
	// An object configuring where the rule will be placed.
	Position param.Field[RuleEditParamsBodyLogRulePositionUnion] `json:"position"`
	LogRuleParam
}

func (RuleEditParamsBodyLogRule) MarshalJSON 

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

type RuleEditParamsBodyLogRulePosition 

type RuleEditParamsBodyLogRulePosition struct {
	// The ID of another rule to place the rule after. An empty value causes the rule
	// to be placed at the bottom.
	After param.Field[string] `json:"after"`
	// The ID of another rule to place the rule before. An empty value causes the rule
	// to be placed at the top.
	Before param.Field[string] `json:"before"`
	// An index at which to place the rule, where index 1 is the first rule.
	Index param.Field[int64] `json:"index"`
}

An object configuring where the rule will be placed.

func (RuleEditParamsBodyLogRulePosition) MarshalJSON 

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

type RuleEditParamsBodyLogRulePositionAfterPosition 

type RuleEditParamsBodyLogRulePositionAfterPosition struct {
	// The ID of another rule to place the rule after. An empty value causes the rule
	// to be placed at the bottom.
	After param.Field[string] `json:"after"`
}

An object configuring where the rule will be placed.

func (RuleEditParamsBodyLogRulePositionAfterPosition) MarshalJSON 

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

type RuleEditParamsBodyLogRulePositionBeforePosition 

type RuleEditParamsBodyLogRulePositionBeforePosition struct {
	// The ID of another rule to place the rule before. An empty value causes the rule
	// to be placed at the top.
	Before param.Field[string] `json:"before"`
}

An object configuring where the rule will be placed.

func (RuleEditParamsBodyLogRulePositionBeforePosition) MarshalJSON 

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

type RuleEditParamsBodyLogRulePositionIndexPosition 

type RuleEditParamsBodyLogRulePositionIndexPosition struct {
	// An index at which to place the rule, where index 1 is the first rule.
	Index param.Field[int64] `json:"index"`
}

An object configuring where the rule will be placed.

func (RuleEditParamsBodyLogRulePositionIndexPosition) MarshalJSON 

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

type RuleEditParamsBodyLogRulePositionUnion 

type RuleEditParamsBodyLogRulePositionUnion interface {
	// contains filtered or unexported methods
}

An object configuring where the rule will be placed.

Satisfied by rulesets.RuleEditParamsBodyLogRulePositionBeforePosition, rulesets.RuleEditParamsBodyLogRulePositionAfterPosition, rulesets.RuleEditParamsBodyLogRulePositionIndexPosition, RuleEditParamsBodyLogRulePosition.

type RuleEditParamsBodyManagedChallengeRule 

type RuleEditParamsBodyManagedChallengeRule struct {
	// An object configuring where the rule will be placed.
	Position param.Field[RuleEditParamsBodyManagedChallengeRulePositionUnion] `json:"position"`
	ManagedChallengeRuleParam
}

func (RuleEditParamsBodyManagedChallengeRule) MarshalJSON 

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

type RuleEditParamsBodyManagedChallengeRulePosition 

type RuleEditParamsBodyManagedChallengeRulePosition struct {
	// The ID of another rule to place the rule after. An empty value causes the rule
	// to be placed at the bottom.
	After param.Field[string] `json:"after"`
	// The ID of another rule to place the rule before. An empty value causes the rule
	// to be placed at the top.
	Before param.Field[string] `json:"before"`
	// An index at which to place the rule, where index 1 is the first rule.
	Index param.Field[int64] `json:"index"`
}

An object configuring where the rule will be placed.

func (RuleEditParamsBodyManagedChallengeRulePosition) MarshalJSON 

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

type RuleEditParamsBodyManagedChallengeRulePositionAfterPosition 

type RuleEditParamsBodyManagedChallengeRulePositionAfterPosition struct {
	// The ID of another rule to place the rule after. An empty value causes the rule
	// to be placed at the bottom.
	After param.Field[string] `json:"after"`
}

An object configuring where the rule will be placed.

func (RuleEditParamsBodyManagedChallengeRulePositionAfterPosition) MarshalJSON 

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

type RuleEditParamsBodyManagedChallengeRulePositionBeforePosition 

type RuleEditParamsBodyManagedChallengeRulePositionBeforePosition struct {
	// The ID of another rule to place the rule before. An empty value causes the rule
	// to be placed at the top.
	Before param.Field[string] `json:"before"`
}

An object configuring where the rule will be placed.

func (RuleEditParamsBodyManagedChallengeRulePositionBeforePosition) MarshalJSON 

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

type RuleEditParamsBodyManagedChallengeRulePositionIndexPosition 

type RuleEditParamsBodyManagedChallengeRulePositionIndexPosition struct {
	// An index at which to place the rule, where index 1 is the first rule.
	Index param.Field[int64] `json:"index"`
}

An object configuring where the rule will be placed.

func (RuleEditParamsBodyManagedChallengeRulePositionIndexPosition) MarshalJSON 

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

type RuleEditParamsBodyManagedChallengeRulePositionUnion 

type RuleEditParamsBodyManagedChallengeRulePositionUnion interface {
	// contains filtered or unexported methods
}

An object configuring where the rule will be placed.

Satisfied by rulesets.RuleEditParamsBodyManagedChallengeRulePositionBeforePosition, rulesets.RuleEditParamsBodyManagedChallengeRulePositionAfterPosition, rulesets.RuleEditParamsBodyManagedChallengeRulePositionIndexPosition, RuleEditParamsBodyManagedChallengeRulePosition.

type RuleEditParamsBodyRedirectRule 

type RuleEditParamsBodyRedirectRule struct {
	// An object configuring where the rule will be placed.
	Position param.Field[RuleEditParamsBodyRedirectRulePositionUnion] `json:"position"`
	RedirectRuleParam
}

func (RuleEditParamsBodyRedirectRule) MarshalJSON 

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

type RuleEditParamsBodyRedirectRulePosition 

type RuleEditParamsBodyRedirectRulePosition struct {
	// The ID of another rule to place the rule after. An empty value causes the rule
	// to be placed at the bottom.
	After param.Field[string] `json:"after"`
	// The ID of another rule to place the rule before. An empty value causes the rule
	// to be placed at the top.
	Before param.Field[string] `json:"before"`
	// An index at which to place the rule, where index 1 is the first rule.
	Index param.Field[int64] `json:"index"`
}

An object configuring where the rule will be placed.

func (RuleEditParamsBodyRedirectRulePosition) MarshalJSON 

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

type RuleEditParamsBodyRedirectRulePositionAfterPosition 

type RuleEditParamsBodyRedirectRulePositionAfterPosition struct {
	// The ID of another rule to place the rule after. An empty value causes the rule
	// to be placed at the bottom.
	After param.Field[string] `json:"after"`
}

An object configuring where the rule will be placed.

func (RuleEditParamsBodyRedirectRulePositionAfterPosition) MarshalJSON 

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

type RuleEditParamsBodyRedirectRulePositionBeforePosition 

type RuleEditParamsBodyRedirectRulePositionBeforePosition struct {
	// The ID of another rule to place the rule before. An empty value causes the rule
	// to be placed at the top.
	Before param.Field[string] `json:"before"`
}

An object configuring where the rule will be placed.

func (RuleEditParamsBodyRedirectRulePositionBeforePosition) MarshalJSON 

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

type RuleEditParamsBodyRedirectRulePositionIndexPosition 

type RuleEditParamsBodyRedirectRulePositionIndexPosition struct {
	// An index at which to place the rule, where index 1 is the first rule.
	Index param.Field[int64] `json:"index"`
}

An object configuring where the rule will be placed.

func (RuleEditParamsBodyRedirectRulePositionIndexPosition) MarshalJSON 

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

type RuleEditParamsBodyRedirectRulePositionUnion 

type RuleEditParamsBodyRedirectRulePositionUnion interface {
	// contains filtered or unexported methods
}

An object configuring where the rule will be placed.

Satisfied by rulesets.RuleEditParamsBodyRedirectRulePositionBeforePosition, rulesets.RuleEditParamsBodyRedirectRulePositionAfterPosition, rulesets.RuleEditParamsBodyRedirectRulePositionIndexPosition, RuleEditParamsBodyRedirectRulePosition.

type RuleEditParamsBodyResponseCompressionRule 

type RuleEditParamsBodyResponseCompressionRule struct {
	// An object configuring where the rule will be placed.
	Position param.Field[RuleEditParamsBodyResponseCompressionRulePositionUnion] `json:"position"`
	CompressResponseRuleParam
}

func (RuleEditParamsBodyResponseCompressionRule) MarshalJSON 

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

type RuleEditParamsBodyResponseCompressionRulePosition 

type RuleEditParamsBodyResponseCompressionRulePosition struct {
	// The ID of another rule to place the rule after. An empty value causes the rule
	// to be placed at the bottom.
	After param.Field[string] `json:"after"`
	// The ID of another rule to place the rule before. An empty value causes the rule
	// to be placed at the top.
	Before param.Field[string] `json:"before"`
	// An index at which to place the rule, where index 1 is the first rule.
	Index param.Field[int64] `json:"index"`
}

An object configuring where the rule will be placed.

func (RuleEditParamsBodyResponseCompressionRulePosition) MarshalJSON 

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

type RuleEditParamsBodyResponseCompressionRulePositionAfterPosition 

type RuleEditParamsBodyResponseCompressionRulePositionAfterPosition struct {
	// The ID of another rule to place the rule after. An empty value causes the rule
	// to be placed at the bottom.
	After param.Field[string] `json:"after"`
}

An object configuring where the rule will be placed.

func (RuleEditParamsBodyResponseCompressionRulePositionAfterPosition) MarshalJSON 

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

type RuleEditParamsBodyResponseCompressionRulePositionBeforePosition 

type RuleEditParamsBodyResponseCompressionRulePositionBeforePosition struct {
	// The ID of another rule to place the rule before. An empty value causes the rule
	// to be placed at the top.
	Before param.Field[string] `json:"before"`
}

An object configuring where the rule will be placed.

func (RuleEditParamsBodyResponseCompressionRulePositionBeforePosition) MarshalJSON 

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

type RuleEditParamsBodyResponseCompressionRulePositionIndexPosition 

type RuleEditParamsBodyResponseCompressionRulePositionIndexPosition struct {
	// An index at which to place the rule, where index 1 is the first rule.
	Index param.Field[int64] `json:"index"`
}

An object configuring where the rule will be placed.

func (RuleEditParamsBodyResponseCompressionRulePositionIndexPosition) MarshalJSON 

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

type RuleEditParamsBodyResponseCompressionRulePositionUnion 

type RuleEditParamsBodyResponseCompressionRulePositionUnion interface {
	// contains filtered or unexported methods
}

An object configuring where the rule will be placed.

Satisfied by rulesets.RuleEditParamsBodyResponseCompressionRulePositionBeforePosition, rulesets.RuleEditParamsBodyResponseCompressionRulePositionAfterPosition, rulesets.RuleEditParamsBodyResponseCompressionRulePositionIndexPosition, RuleEditParamsBodyResponseCompressionRulePosition.

type RuleEditParamsBodyRewriteRule 

type RuleEditParamsBodyRewriteRule struct {
	// An object configuring where the rule will be placed.
	Position param.Field[RuleEditParamsBodyRewriteRulePositionUnion] `json:"position"`
	RewriteRuleParam
}

func (RuleEditParamsBodyRewriteRule) MarshalJSON 

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

type RuleEditParamsBodyRewriteRulePosition 

type RuleEditParamsBodyRewriteRulePosition struct {
	// The ID of another rule to place the rule after. An empty value causes the rule
	// to be placed at the bottom.
	After param.Field[string] `json:"after"`
	// The ID of another rule to place the rule before. An empty value causes the rule
	// to be placed at the top.
	Before param.Field[string] `json:"before"`
	// An index at which to place the rule, where index 1 is the first rule.
	Index param.Field[int64] `json:"index"`
}

An object configuring where the rule will be placed.

func (RuleEditParamsBodyRewriteRulePosition) MarshalJSON 

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

type RuleEditParamsBodyRewriteRulePositionAfterPosition 

type RuleEditParamsBodyRewriteRulePositionAfterPosition struct {
	// The ID of another rule to place the rule after. An empty value causes the rule
	// to be placed at the bottom.
	After param.Field[string] `json:"after"`
}

An object configuring where the rule will be placed.

func (RuleEditParamsBodyRewriteRulePositionAfterPosition) MarshalJSON 

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

type RuleEditParamsBodyRewriteRulePositionBeforePosition 

type RuleEditParamsBodyRewriteRulePositionBeforePosition struct {
	// The ID of another rule to place the rule before. An empty value causes the rule
	// to be placed at the top.
	Before param.Field[string] `json:"before"`
}

An object configuring where the rule will be placed.

func (RuleEditParamsBodyRewriteRulePositionBeforePosition) MarshalJSON 

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

type RuleEditParamsBodyRewriteRulePositionIndexPosition 

type RuleEditParamsBodyRewriteRulePositionIndexPosition struct {
	// An index at which to place the rule, where index 1 is the first rule.
	Index param.Field[int64] `json:"index"`
}

An object configuring where the rule will be placed.

func (RuleEditParamsBodyRewriteRulePositionIndexPosition) MarshalJSON 

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

type RuleEditParamsBodyRewriteRulePositionUnion 

type RuleEditParamsBodyRewriteRulePositionUnion interface {
	// contains filtered or unexported methods
}

An object configuring where the rule will be placed.

Satisfied by rulesets.RuleEditParamsBodyRewriteRulePositionBeforePosition, rulesets.RuleEditParamsBodyRewriteRulePositionAfterPosition, rulesets.RuleEditParamsBodyRewriteRulePositionIndexPosition, RuleEditParamsBodyRewriteRulePosition.

type RuleEditParamsBodyRouteRule 

type RuleEditParamsBodyRouteRule struct {
	// An object configuring where the rule will be placed.
	Position param.Field[RuleEditParamsBodyRouteRulePositionUnion] `json:"position"`
	RouteRuleParam
}

func (RuleEditParamsBodyRouteRule) MarshalJSON 

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

type RuleEditParamsBodyRouteRulePosition 

type RuleEditParamsBodyRouteRulePosition struct {
	// The ID of another rule to place the rule after. An empty value causes the rule
	// to be placed at the bottom.
	After param.Field[string] `json:"after"`
	// The ID of another rule to place the rule before. An empty value causes the rule
	// to be placed at the top.
	Before param.Field[string] `json:"before"`
	// An index at which to place the rule, where index 1 is the first rule.
	Index param.Field[int64] `json:"index"`
}

An object configuring where the rule will be placed.

func (RuleEditParamsBodyRouteRulePosition) MarshalJSON 

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

type RuleEditParamsBodyRouteRulePositionAfterPosition 

type RuleEditParamsBodyRouteRulePositionAfterPosition struct {
	// The ID of another rule to place the rule after. An empty value causes the rule
	// to be placed at the bottom.
	After param.Field[string] `json:"after"`
}

An object configuring where the rule will be placed.

func (RuleEditParamsBodyRouteRulePositionAfterPosition) MarshalJSON 

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

type RuleEditParamsBodyRouteRulePositionBeforePosition 

type RuleEditParamsBodyRouteRulePositionBeforePosition struct {
	// The ID of another rule to place the rule before. An empty value causes the rule
	// to be placed at the top.
	Before param.Field[string] `json:"before"`
}

An object configuring where the rule will be placed.

func (RuleEditParamsBodyRouteRulePositionBeforePosition) MarshalJSON 

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

type RuleEditParamsBodyRouteRulePositionIndexPosition 

type RuleEditParamsBodyRouteRulePositionIndexPosition struct {
	// An index at which to place the rule, where index 1 is the first rule.
	Index param.Field[int64] `json:"index"`
}

An object configuring where the rule will be placed.

func (RuleEditParamsBodyRouteRulePositionIndexPosition) MarshalJSON 

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

type RuleEditParamsBodyRouteRulePositionUnion 

type RuleEditParamsBodyRouteRulePositionUnion interface {
	// contains filtered or unexported methods
}

An object configuring where the rule will be placed.

Satisfied by rulesets.RuleEditParamsBodyRouteRulePositionBeforePosition, rulesets.RuleEditParamsBodyRouteRulePositionAfterPosition, rulesets.RuleEditParamsBodyRouteRulePositionIndexPosition, RuleEditParamsBodyRouteRulePosition.

type RuleEditParamsBodyScoreRule 

type RuleEditParamsBodyScoreRule struct {
	// An object configuring where the rule will be placed.
	Position param.Field[RuleEditParamsBodyScoreRulePositionUnion] `json:"position"`
	ScoreRuleParam
}

func (RuleEditParamsBodyScoreRule) MarshalJSON 

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

type RuleEditParamsBodyScoreRulePosition 

type RuleEditParamsBodyScoreRulePosition struct {
	// The ID of another rule to place the rule after. An empty value causes the rule
	// to be placed at the bottom.
	After param.Field[string] `json:"after"`
	// The ID of another rule to place the rule before. An empty value causes the rule
	// to be placed at the top.
	Before param.Field[string] `json:"before"`
	// An index at which to place the rule, where index 1 is the first rule.
	Index param.Field[int64] `json:"index"`
}

An object configuring where the rule will be placed.

func (RuleEditParamsBodyScoreRulePosition) MarshalJSON 

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

type RuleEditParamsBodyScoreRulePositionAfterPosition 

type RuleEditParamsBodyScoreRulePositionAfterPosition struct {
	// The ID of another rule to place the rule after. An empty value causes the rule
	// to be placed at the bottom.
	After param.Field[string] `json:"after"`
}

An object configuring where the rule will be placed.

func (RuleEditParamsBodyScoreRulePositionAfterPosition) MarshalJSON 

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

type RuleEditParamsBodyScoreRulePositionBeforePosition 

type RuleEditParamsBodyScoreRulePositionBeforePosition struct {
	// The ID of another rule to place the rule before. An empty value causes the rule
	// to be placed at the top.
	Before param.Field[string] `json:"before"`
}

An object configuring where the rule will be placed.

func (RuleEditParamsBodyScoreRulePositionBeforePosition) MarshalJSON 

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

type RuleEditParamsBodyScoreRulePositionIndexPosition 

type RuleEditParamsBodyScoreRulePositionIndexPosition struct {
	// An index at which to place the rule, where index 1 is the first rule.
	Index param.Field[int64] `json:"index"`
}

An object configuring where the rule will be placed.

func (RuleEditParamsBodyScoreRulePositionIndexPosition) MarshalJSON 

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

type RuleEditParamsBodyScoreRulePositionUnion 

type RuleEditParamsBodyScoreRulePositionUnion interface {
	// contains filtered or unexported methods
}

An object configuring where the rule will be placed.

Satisfied by rulesets.RuleEditParamsBodyScoreRulePositionBeforePosition, rulesets.RuleEditParamsBodyScoreRulePositionAfterPosition, rulesets.RuleEditParamsBodyScoreRulePositionIndexPosition, RuleEditParamsBodyScoreRulePosition.

type RuleEditParamsBodyServeErrorRule 

type RuleEditParamsBodyServeErrorRule struct {
	// An object configuring where the rule will be placed.
	Position param.Field[RuleEditParamsBodyServeErrorRulePositionUnion] `json:"position"`
	ServeErrorRuleParam
}

func (RuleEditParamsBodyServeErrorRule) MarshalJSON 

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

type RuleEditParamsBodyServeErrorRulePosition 

type RuleEditParamsBodyServeErrorRulePosition struct {
	// The ID of another rule to place the rule after. An empty value causes the rule
	// to be placed at the bottom.
	After param.Field[string] `json:"after"`
	// The ID of another rule to place the rule before. An empty value causes the rule
	// to be placed at the top.
	Before param.Field[string] `json:"before"`
	// An index at which to place the rule, where index 1 is the first rule.
	Index param.Field[int64] `json:"index"`
}

An object configuring where the rule will be placed.

func (RuleEditParamsBodyServeErrorRulePosition) MarshalJSON 

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

type RuleEditParamsBodyServeErrorRulePositionAfterPosition 

type RuleEditParamsBodyServeErrorRulePositionAfterPosition struct {
	// The ID of another rule to place the rule after. An empty value causes the rule
	// to be placed at the bottom.
	After param.Field[string] `json:"after"`
}

An object configuring where the rule will be placed.

func (RuleEditParamsBodyServeErrorRulePositionAfterPosition) MarshalJSON 

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

type RuleEditParamsBodyServeErrorRulePositionBeforePosition 

type RuleEditParamsBodyServeErrorRulePositionBeforePosition struct {
	// The ID of another rule to place the rule before. An empty value causes the rule
	// to be placed at the top.
	Before param.Field[string] `json:"before"`
}

An object configuring where the rule will be placed.

func (RuleEditParamsBodyServeErrorRulePositionBeforePosition) MarshalJSON 

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

type RuleEditParamsBodyServeErrorRulePositionIndexPosition 

type RuleEditParamsBodyServeErrorRulePositionIndexPosition struct {
	// An index at which to place the rule, where index 1 is the first rule.
	Index param.Field[int64] `json:"index"`
}

An object configuring where the rule will be placed.

func (RuleEditParamsBodyServeErrorRulePositionIndexPosition) MarshalJSON 

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

type RuleEditParamsBodyServeErrorRulePositionUnion 

type RuleEditParamsBodyServeErrorRulePositionUnion interface {
	// contains filtered or unexported methods
}

An object configuring where the rule will be placed.

Satisfied by rulesets.RuleEditParamsBodyServeErrorRulePositionBeforePosition, rulesets.RuleEditParamsBodyServeErrorRulePositionAfterPosition, rulesets.RuleEditParamsBodyServeErrorRulePositionIndexPosition, RuleEditParamsBodyServeErrorRulePosition.

type RuleEditParamsBodySetCacheControlRule added in v6.9.0 

type RuleEditParamsBodySetCacheControlRule struct {
	// The unique ID of the rule.
	ID param.Field[string] `json:"id"`
	// The action to perform when the rule matches.
	Action param.Field[RuleEditParamsBodySetCacheControlRuleAction] `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters param.Field[RuleEditParamsBodySetCacheControlRuleActionParameters] `json:"action_parameters"`
	// An informative description of the rule.
	Description param.Field[string] `json:"description"`
	// Whether the rule should be executed.
	Enabled param.Field[bool] `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck param.Field[RuleEditParamsBodySetCacheControlRuleExposedCredentialCheck] `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression param.Field[string] `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging param.Field[LoggingParam] `json:"logging"`
	// An object configuring where the rule will be placed.
	Position param.Field[RuleEditParamsBodySetCacheControlRulePositionUnion] `json:"position"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit param.Field[RuleEditParamsBodySetCacheControlRuleRatelimit] `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref param.Field[string] `json:"ref"`
}

func (RuleEditParamsBodySetCacheControlRule) MarshalJSON added in v6.9.0 

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

type RuleEditParamsBodySetCacheControlRuleAction added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleAction string

The action to perform when the rule matches. 

const (
	RuleEditParamsBodySetCacheControlRuleActionSetCacheControl RuleEditParamsBodySetCacheControlRuleAction = "set_cache_control"
)

func (RuleEditParamsBodySetCacheControlRuleAction) IsKnown added in v6.9.0 

func (r RuleEditParamsBodySetCacheControlRuleAction) IsKnown() bool

type RuleEditParamsBodySetCacheControlRuleActionParameters added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParameters struct {
	// A cache-control directive configuration.
	Immutable param.Field[RuleEditParamsBodySetCacheControlRuleActionParametersImmutableUnion] `json:"immutable"`
	// A cache-control directive configuration that accepts a duration value in
	// seconds.
	MaxAge param.Field[RuleEditParamsBodySetCacheControlRuleActionParametersMaxAgeUnion] `json:"max-age"`
	// A cache-control directive configuration.
	MustRevalidate param.Field[RuleEditParamsBodySetCacheControlRuleActionParametersMustRevalidateUnion] `json:"must-revalidate"`
	// A cache-control directive configuration.
	MustUnderstand param.Field[RuleEditParamsBodySetCacheControlRuleActionParametersMustUnderstandUnion] `json:"must-understand"`
	// A cache-control directive configuration that accepts optional qualifiers (header
	// names).
	NoCache param.Field[RuleEditParamsBodySetCacheControlRuleActionParametersNoCacheUnion] `json:"no-cache"`
	// A cache-control directive configuration.
	NoStore param.Field[RuleEditParamsBodySetCacheControlRuleActionParametersNoStoreUnion] `json:"no-store"`
	// A cache-control directive configuration.
	NoTransform param.Field[RuleEditParamsBodySetCacheControlRuleActionParametersNoTransformUnion] `json:"no-transform"`
	// A cache-control directive configuration that accepts optional qualifiers (header
	// names).
	Private param.Field[RuleEditParamsBodySetCacheControlRuleActionParametersPrivateUnion] `json:"private"`
	// A cache-control directive configuration.
	ProxyRevalidate param.Field[RuleEditParamsBodySetCacheControlRuleActionParametersProxyRevalidateUnion] `json:"proxy-revalidate"`
	// A cache-control directive configuration.
	Public param.Field[RuleEditParamsBodySetCacheControlRuleActionParametersPublicUnion] `json:"public"`
	// A cache-control directive configuration that accepts a duration value in
	// seconds.
	SMaxage param.Field[RuleEditParamsBodySetCacheControlRuleActionParametersSMaxageUnion] `json:"s-maxage"`
	// A cache-control directive configuration that accepts a duration value in
	// seconds.
	StaleIfError param.Field[RuleEditParamsBodySetCacheControlRuleActionParametersStaleIfErrorUnion] `json:"stale-if-error"`
	// A cache-control directive configuration that accepts a duration value in
	// seconds.
	StaleWhileRevalidate param.Field[RuleEditParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateUnion] `json:"stale-while-revalidate"`
}

The parameters configuring the rule's action.

func (RuleEditParamsBodySetCacheControlRuleActionParameters) MarshalJSON added in v6.9.0 

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

type RuleEditParamsBodySetCacheControlRuleActionParametersImmutable added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersImmutable struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RuleEditParamsBodySetCacheControlRuleActionParametersImmutableOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

A cache-control directive configuration.

func (RuleEditParamsBodySetCacheControlRuleActionParametersImmutable) MarshalJSON added in v6.9.0 

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

type RuleEditParamsBodySetCacheControlRuleActionParametersImmutableOperation added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersImmutableOperation string

The operation to perform on the cache-control directive. 

const (
	RuleEditParamsBodySetCacheControlRuleActionParametersImmutableOperationSet    RuleEditParamsBodySetCacheControlRuleActionParametersImmutableOperation = "set"
	RuleEditParamsBodySetCacheControlRuleActionParametersImmutableOperationRemove RuleEditParamsBodySetCacheControlRuleActionParametersImmutableOperation = "remove"
)

func (RuleEditParamsBodySetCacheControlRuleActionParametersImmutableOperation) IsKnown added in v6.9.0 

func (r RuleEditParamsBodySetCacheControlRuleActionParametersImmutableOperation) IsKnown() bool

type RuleEditParamsBodySetCacheControlRuleActionParametersImmutableRemoveDirective added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersImmutableRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RuleEditParamsBodySetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Remove the directive.

func (RuleEditParamsBodySetCacheControlRuleActionParametersImmutableRemoveDirective) MarshalJSON added in v6.9.0 

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

type RuleEditParamsBodySetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleEditParamsBodySetCacheControlRuleActionParametersImmutableRemoveDirectiveOperationSet    RuleEditParamsBodySetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation = "set"
	RuleEditParamsBodySetCacheControlRuleActionParametersImmutableRemoveDirectiveOperationRemove RuleEditParamsBodySetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation = "remove"
)

func (RuleEditParamsBodySetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleEditParamsBodySetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation) IsKnown() bool

type RuleEditParamsBodySetCacheControlRuleActionParametersImmutableSetDirective added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersImmutableSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RuleEditParamsBodySetCacheControlRuleActionParametersImmutableSetDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Set the directive.

func (RuleEditParamsBodySetCacheControlRuleActionParametersImmutableSetDirective) MarshalJSON added in v6.9.0 

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

type RuleEditParamsBodySetCacheControlRuleActionParametersImmutableSetDirectiveOperation added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersImmutableSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleEditParamsBodySetCacheControlRuleActionParametersImmutableSetDirectiveOperationSet    RuleEditParamsBodySetCacheControlRuleActionParametersImmutableSetDirectiveOperation = "set"
	RuleEditParamsBodySetCacheControlRuleActionParametersImmutableSetDirectiveOperationRemove RuleEditParamsBodySetCacheControlRuleActionParametersImmutableSetDirectiveOperation = "remove"
)

func (RuleEditParamsBodySetCacheControlRuleActionParametersImmutableSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleEditParamsBodySetCacheControlRuleActionParametersImmutableSetDirectiveOperation) IsKnown() bool

type RuleEditParamsBodySetCacheControlRuleActionParametersImmutableUnion added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersImmutableUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Satisfied by rulesets.RuleEditParamsBodySetCacheControlRuleActionParametersImmutableSetDirective, rulesets.RuleEditParamsBodySetCacheControlRuleActionParametersImmutableRemoveDirective, RuleEditParamsBodySetCacheControlRuleActionParametersImmutable.

type RuleEditParamsBodySetCacheControlRuleActionParametersMaxAge added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersMaxAge struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RuleEditParamsBodySetCacheControlRuleActionParametersMaxAgeOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
	// The duration value in seconds for the directive.
	Value param.Field[int64] `json:"value"`
}

A cache-control directive configuration that accepts a duration value in seconds.

func (RuleEditParamsBodySetCacheControlRuleActionParametersMaxAge) MarshalJSON added in v6.9.0 

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

type RuleEditParamsBodySetCacheControlRuleActionParametersMaxAgeOperation added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersMaxAgeOperation string

The operation to perform on the cache-control directive. 

const (
	RuleEditParamsBodySetCacheControlRuleActionParametersMaxAgeOperationSet    RuleEditParamsBodySetCacheControlRuleActionParametersMaxAgeOperation = "set"
	RuleEditParamsBodySetCacheControlRuleActionParametersMaxAgeOperationRemove RuleEditParamsBodySetCacheControlRuleActionParametersMaxAgeOperation = "remove"
)

func (RuleEditParamsBodySetCacheControlRuleActionParametersMaxAgeOperation) IsKnown added in v6.9.0 

func (r RuleEditParamsBodySetCacheControlRuleActionParametersMaxAgeOperation) IsKnown() bool

type RuleEditParamsBodySetCacheControlRuleActionParametersMaxAgeRemoveDirective added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersMaxAgeRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RuleEditParamsBodySetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Remove the directive.

func (RuleEditParamsBodySetCacheControlRuleActionParametersMaxAgeRemoveDirective) MarshalJSON added in v6.9.0 

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

type RuleEditParamsBodySetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleEditParamsBodySetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperationSet    RuleEditParamsBodySetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation = "set"
	RuleEditParamsBodySetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperationRemove RuleEditParamsBodySetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation = "remove"
)

func (RuleEditParamsBodySetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleEditParamsBodySetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation) IsKnown() bool

type RuleEditParamsBodySetCacheControlRuleActionParametersMaxAgeSetDirective added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersMaxAgeSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RuleEditParamsBodySetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation] `json:"operation" api:"required"`
	// The duration value in seconds for the directive.
	Value param.Field[int64] `json:"value" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Set the directive with a duration value in seconds.

func (RuleEditParamsBodySetCacheControlRuleActionParametersMaxAgeSetDirective) MarshalJSON added in v6.9.0 

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

type RuleEditParamsBodySetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleEditParamsBodySetCacheControlRuleActionParametersMaxAgeSetDirectiveOperationSet    RuleEditParamsBodySetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation = "set"
	RuleEditParamsBodySetCacheControlRuleActionParametersMaxAgeSetDirectiveOperationRemove RuleEditParamsBodySetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation = "remove"
)

func (RuleEditParamsBodySetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleEditParamsBodySetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation) IsKnown() bool

type RuleEditParamsBodySetCacheControlRuleActionParametersMaxAgeUnion added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersMaxAgeUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts a duration value in seconds.

Satisfied by rulesets.RuleEditParamsBodySetCacheControlRuleActionParametersMaxAgeSetDirective, rulesets.RuleEditParamsBodySetCacheControlRuleActionParametersMaxAgeRemoveDirective, RuleEditParamsBodySetCacheControlRuleActionParametersMaxAge.

type RuleEditParamsBodySetCacheControlRuleActionParametersMustRevalidate added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersMustRevalidate struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RuleEditParamsBodySetCacheControlRuleActionParametersMustRevalidateOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

A cache-control directive configuration.

func (RuleEditParamsBodySetCacheControlRuleActionParametersMustRevalidate) MarshalJSON added in v6.9.0 

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

type RuleEditParamsBodySetCacheControlRuleActionParametersMustRevalidateOperation added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersMustRevalidateOperation string

The operation to perform on the cache-control directive. 

const (
	RuleEditParamsBodySetCacheControlRuleActionParametersMustRevalidateOperationSet    RuleEditParamsBodySetCacheControlRuleActionParametersMustRevalidateOperation = "set"
	RuleEditParamsBodySetCacheControlRuleActionParametersMustRevalidateOperationRemove RuleEditParamsBodySetCacheControlRuleActionParametersMustRevalidateOperation = "remove"
)

func (RuleEditParamsBodySetCacheControlRuleActionParametersMustRevalidateOperation) IsKnown added in v6.9.0 

func (r RuleEditParamsBodySetCacheControlRuleActionParametersMustRevalidateOperation) IsKnown() bool

type RuleEditParamsBodySetCacheControlRuleActionParametersMustRevalidateRemoveDirective added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersMustRevalidateRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RuleEditParamsBodySetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Remove the directive.

func (RuleEditParamsBodySetCacheControlRuleActionParametersMustRevalidateRemoveDirective) MarshalJSON added in v6.9.0 

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

type RuleEditParamsBodySetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleEditParamsBodySetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperationSet    RuleEditParamsBodySetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation = "set"
	RuleEditParamsBodySetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperationRemove RuleEditParamsBodySetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation = "remove"
)

func (RuleEditParamsBodySetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleEditParamsBodySetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation) IsKnown() bool

type RuleEditParamsBodySetCacheControlRuleActionParametersMustRevalidateSetDirective added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersMustRevalidateSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RuleEditParamsBodySetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Set the directive.

func (RuleEditParamsBodySetCacheControlRuleActionParametersMustRevalidateSetDirective) MarshalJSON added in v6.9.0 

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

type RuleEditParamsBodySetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleEditParamsBodySetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperationSet    RuleEditParamsBodySetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation = "set"
	RuleEditParamsBodySetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperationRemove RuleEditParamsBodySetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation = "remove"
)

func (RuleEditParamsBodySetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleEditParamsBodySetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation) IsKnown() bool

type RuleEditParamsBodySetCacheControlRuleActionParametersMustRevalidateUnion added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersMustRevalidateUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Satisfied by rulesets.RuleEditParamsBodySetCacheControlRuleActionParametersMustRevalidateSetDirective, rulesets.RuleEditParamsBodySetCacheControlRuleActionParametersMustRevalidateRemoveDirective, RuleEditParamsBodySetCacheControlRuleActionParametersMustRevalidate.

type RuleEditParamsBodySetCacheControlRuleActionParametersMustUnderstand added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersMustUnderstand struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RuleEditParamsBodySetCacheControlRuleActionParametersMustUnderstandOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

A cache-control directive configuration.

func (RuleEditParamsBodySetCacheControlRuleActionParametersMustUnderstand) MarshalJSON added in v6.9.0 

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

type RuleEditParamsBodySetCacheControlRuleActionParametersMustUnderstandOperation added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersMustUnderstandOperation string

The operation to perform on the cache-control directive. 

const (
	RuleEditParamsBodySetCacheControlRuleActionParametersMustUnderstandOperationSet    RuleEditParamsBodySetCacheControlRuleActionParametersMustUnderstandOperation = "set"
	RuleEditParamsBodySetCacheControlRuleActionParametersMustUnderstandOperationRemove RuleEditParamsBodySetCacheControlRuleActionParametersMustUnderstandOperation = "remove"
)

func (RuleEditParamsBodySetCacheControlRuleActionParametersMustUnderstandOperation) IsKnown added in v6.9.0 

func (r RuleEditParamsBodySetCacheControlRuleActionParametersMustUnderstandOperation) IsKnown() bool

type RuleEditParamsBodySetCacheControlRuleActionParametersMustUnderstandRemoveDirective added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersMustUnderstandRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RuleEditParamsBodySetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Remove the directive.

func (RuleEditParamsBodySetCacheControlRuleActionParametersMustUnderstandRemoveDirective) MarshalJSON added in v6.9.0 

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

type RuleEditParamsBodySetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleEditParamsBodySetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperationSet    RuleEditParamsBodySetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation = "set"
	RuleEditParamsBodySetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperationRemove RuleEditParamsBodySetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation = "remove"
)

func (RuleEditParamsBodySetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleEditParamsBodySetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation) IsKnown() bool

type RuleEditParamsBodySetCacheControlRuleActionParametersMustUnderstandSetDirective added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersMustUnderstandSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RuleEditParamsBodySetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Set the directive.

func (RuleEditParamsBodySetCacheControlRuleActionParametersMustUnderstandSetDirective) MarshalJSON added in v6.9.0 

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

type RuleEditParamsBodySetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleEditParamsBodySetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperationSet    RuleEditParamsBodySetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation = "set"
	RuleEditParamsBodySetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperationRemove RuleEditParamsBodySetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation = "remove"
)

func (RuleEditParamsBodySetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleEditParamsBodySetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation) IsKnown() bool

type RuleEditParamsBodySetCacheControlRuleActionParametersMustUnderstandUnion added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersMustUnderstandUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Satisfied by rulesets.RuleEditParamsBodySetCacheControlRuleActionParametersMustUnderstandSetDirective, rulesets.RuleEditParamsBodySetCacheControlRuleActionParametersMustUnderstandRemoveDirective, RuleEditParamsBodySetCacheControlRuleActionParametersMustUnderstand.

type RuleEditParamsBodySetCacheControlRuleActionParametersNoCache added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersNoCache struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RuleEditParamsBodySetCacheControlRuleActionParametersNoCacheOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool]        `json:"cloudflare_only"`
	Qualifiers     param.Field[interface{}] `json:"qualifiers"`
}

A cache-control directive configuration that accepts optional qualifiers (header names).

func (RuleEditParamsBodySetCacheControlRuleActionParametersNoCache) MarshalJSON added in v6.9.0 

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

type RuleEditParamsBodySetCacheControlRuleActionParametersNoCacheOperation added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersNoCacheOperation string

The operation to perform on the cache-control directive. 

const (
	RuleEditParamsBodySetCacheControlRuleActionParametersNoCacheOperationSet    RuleEditParamsBodySetCacheControlRuleActionParametersNoCacheOperation = "set"
	RuleEditParamsBodySetCacheControlRuleActionParametersNoCacheOperationRemove RuleEditParamsBodySetCacheControlRuleActionParametersNoCacheOperation = "remove"
)

func (RuleEditParamsBodySetCacheControlRuleActionParametersNoCacheOperation) IsKnown added in v6.9.0 

func (r RuleEditParamsBodySetCacheControlRuleActionParametersNoCacheOperation) IsKnown() bool

type RuleEditParamsBodySetCacheControlRuleActionParametersNoCacheRemoveDirective added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersNoCacheRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RuleEditParamsBodySetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Remove the directive.

func (RuleEditParamsBodySetCacheControlRuleActionParametersNoCacheRemoveDirective) MarshalJSON added in v6.9.0 

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

type RuleEditParamsBodySetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleEditParamsBodySetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperationSet    RuleEditParamsBodySetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation = "set"
	RuleEditParamsBodySetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperationRemove RuleEditParamsBodySetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation = "remove"
)

func (RuleEditParamsBodySetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleEditParamsBodySetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation) IsKnown() bool

type RuleEditParamsBodySetCacheControlRuleActionParametersNoCacheSetDirective added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersNoCacheSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RuleEditParamsBodySetCacheControlRuleActionParametersNoCacheSetDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
	// Optional list of header names to qualify the directive (e.g., for "private" or
	// "no-cache" directives).
	Qualifiers param.Field[[]string] `json:"qualifiers"`
}

Set the directive with optional qualifiers.

func (RuleEditParamsBodySetCacheControlRuleActionParametersNoCacheSetDirective) MarshalJSON added in v6.9.0 

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

type RuleEditParamsBodySetCacheControlRuleActionParametersNoCacheSetDirectiveOperation added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersNoCacheSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleEditParamsBodySetCacheControlRuleActionParametersNoCacheSetDirectiveOperationSet    RuleEditParamsBodySetCacheControlRuleActionParametersNoCacheSetDirectiveOperation = "set"
	RuleEditParamsBodySetCacheControlRuleActionParametersNoCacheSetDirectiveOperationRemove RuleEditParamsBodySetCacheControlRuleActionParametersNoCacheSetDirectiveOperation = "remove"
)

func (RuleEditParamsBodySetCacheControlRuleActionParametersNoCacheSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleEditParamsBodySetCacheControlRuleActionParametersNoCacheSetDirectiveOperation) IsKnown() bool

type RuleEditParamsBodySetCacheControlRuleActionParametersNoCacheUnion added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersNoCacheUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts optional qualifiers (header names).

Satisfied by rulesets.RuleEditParamsBodySetCacheControlRuleActionParametersNoCacheSetDirective, rulesets.RuleEditParamsBodySetCacheControlRuleActionParametersNoCacheRemoveDirective, RuleEditParamsBodySetCacheControlRuleActionParametersNoCache.

type RuleEditParamsBodySetCacheControlRuleActionParametersNoStore added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersNoStore struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RuleEditParamsBodySetCacheControlRuleActionParametersNoStoreOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

A cache-control directive configuration.

func (RuleEditParamsBodySetCacheControlRuleActionParametersNoStore) MarshalJSON added in v6.9.0 

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

type RuleEditParamsBodySetCacheControlRuleActionParametersNoStoreOperation added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersNoStoreOperation string

The operation to perform on the cache-control directive. 

const (
	RuleEditParamsBodySetCacheControlRuleActionParametersNoStoreOperationSet    RuleEditParamsBodySetCacheControlRuleActionParametersNoStoreOperation = "set"
	RuleEditParamsBodySetCacheControlRuleActionParametersNoStoreOperationRemove RuleEditParamsBodySetCacheControlRuleActionParametersNoStoreOperation = "remove"
)

func (RuleEditParamsBodySetCacheControlRuleActionParametersNoStoreOperation) IsKnown added in v6.9.0 

func (r RuleEditParamsBodySetCacheControlRuleActionParametersNoStoreOperation) IsKnown() bool

type RuleEditParamsBodySetCacheControlRuleActionParametersNoStoreRemoveDirective added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersNoStoreRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RuleEditParamsBodySetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Remove the directive.

func (RuleEditParamsBodySetCacheControlRuleActionParametersNoStoreRemoveDirective) MarshalJSON added in v6.9.0 

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

type RuleEditParamsBodySetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleEditParamsBodySetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperationSet    RuleEditParamsBodySetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation = "set"
	RuleEditParamsBodySetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperationRemove RuleEditParamsBodySetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation = "remove"
)

func (RuleEditParamsBodySetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleEditParamsBodySetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation) IsKnown() bool

type RuleEditParamsBodySetCacheControlRuleActionParametersNoStoreSetDirective added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersNoStoreSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RuleEditParamsBodySetCacheControlRuleActionParametersNoStoreSetDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Set the directive.

func (RuleEditParamsBodySetCacheControlRuleActionParametersNoStoreSetDirective) MarshalJSON added in v6.9.0 

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

type RuleEditParamsBodySetCacheControlRuleActionParametersNoStoreSetDirectiveOperation added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersNoStoreSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleEditParamsBodySetCacheControlRuleActionParametersNoStoreSetDirectiveOperationSet    RuleEditParamsBodySetCacheControlRuleActionParametersNoStoreSetDirectiveOperation = "set"
	RuleEditParamsBodySetCacheControlRuleActionParametersNoStoreSetDirectiveOperationRemove RuleEditParamsBodySetCacheControlRuleActionParametersNoStoreSetDirectiveOperation = "remove"
)

func (RuleEditParamsBodySetCacheControlRuleActionParametersNoStoreSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleEditParamsBodySetCacheControlRuleActionParametersNoStoreSetDirectiveOperation) IsKnown() bool

type RuleEditParamsBodySetCacheControlRuleActionParametersNoStoreUnion added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersNoStoreUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Satisfied by rulesets.RuleEditParamsBodySetCacheControlRuleActionParametersNoStoreSetDirective, rulesets.RuleEditParamsBodySetCacheControlRuleActionParametersNoStoreRemoveDirective, RuleEditParamsBodySetCacheControlRuleActionParametersNoStore.

type RuleEditParamsBodySetCacheControlRuleActionParametersNoTransform added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersNoTransform struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RuleEditParamsBodySetCacheControlRuleActionParametersNoTransformOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

A cache-control directive configuration.

func (RuleEditParamsBodySetCacheControlRuleActionParametersNoTransform) MarshalJSON added in v6.9.0 

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

type RuleEditParamsBodySetCacheControlRuleActionParametersNoTransformOperation added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersNoTransformOperation string

The operation to perform on the cache-control directive. 

const (
	RuleEditParamsBodySetCacheControlRuleActionParametersNoTransformOperationSet    RuleEditParamsBodySetCacheControlRuleActionParametersNoTransformOperation = "set"
	RuleEditParamsBodySetCacheControlRuleActionParametersNoTransformOperationRemove RuleEditParamsBodySetCacheControlRuleActionParametersNoTransformOperation = "remove"
)

func (RuleEditParamsBodySetCacheControlRuleActionParametersNoTransformOperation) IsKnown added in v6.9.0 

func (r RuleEditParamsBodySetCacheControlRuleActionParametersNoTransformOperation) IsKnown() bool

type RuleEditParamsBodySetCacheControlRuleActionParametersNoTransformRemoveDirective added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersNoTransformRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RuleEditParamsBodySetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Remove the directive.

func (RuleEditParamsBodySetCacheControlRuleActionParametersNoTransformRemoveDirective) MarshalJSON added in v6.9.0 

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

type RuleEditParamsBodySetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleEditParamsBodySetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperationSet    RuleEditParamsBodySetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation = "set"
	RuleEditParamsBodySetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperationRemove RuleEditParamsBodySetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation = "remove"
)

func (RuleEditParamsBodySetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleEditParamsBodySetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation) IsKnown() bool

type RuleEditParamsBodySetCacheControlRuleActionParametersNoTransformSetDirective added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersNoTransformSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RuleEditParamsBodySetCacheControlRuleActionParametersNoTransformSetDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Set the directive.

func (RuleEditParamsBodySetCacheControlRuleActionParametersNoTransformSetDirective) MarshalJSON added in v6.9.0 

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

type RuleEditParamsBodySetCacheControlRuleActionParametersNoTransformSetDirectiveOperation added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersNoTransformSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleEditParamsBodySetCacheControlRuleActionParametersNoTransformSetDirectiveOperationSet    RuleEditParamsBodySetCacheControlRuleActionParametersNoTransformSetDirectiveOperation = "set"
	RuleEditParamsBodySetCacheControlRuleActionParametersNoTransformSetDirectiveOperationRemove RuleEditParamsBodySetCacheControlRuleActionParametersNoTransformSetDirectiveOperation = "remove"
)

func (RuleEditParamsBodySetCacheControlRuleActionParametersNoTransformSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleEditParamsBodySetCacheControlRuleActionParametersNoTransformSetDirectiveOperation) IsKnown() bool

type RuleEditParamsBodySetCacheControlRuleActionParametersNoTransformUnion added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersNoTransformUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Satisfied by rulesets.RuleEditParamsBodySetCacheControlRuleActionParametersNoTransformSetDirective, rulesets.RuleEditParamsBodySetCacheControlRuleActionParametersNoTransformRemoveDirective, RuleEditParamsBodySetCacheControlRuleActionParametersNoTransform.

type RuleEditParamsBodySetCacheControlRuleActionParametersPrivate added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersPrivate struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RuleEditParamsBodySetCacheControlRuleActionParametersPrivateOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool]        `json:"cloudflare_only"`
	Qualifiers     param.Field[interface{}] `json:"qualifiers"`
}

A cache-control directive configuration that accepts optional qualifiers (header names).

func (RuleEditParamsBodySetCacheControlRuleActionParametersPrivate) MarshalJSON added in v6.9.0 

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

type RuleEditParamsBodySetCacheControlRuleActionParametersPrivateOperation added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersPrivateOperation string

The operation to perform on the cache-control directive. 

const (
	RuleEditParamsBodySetCacheControlRuleActionParametersPrivateOperationSet    RuleEditParamsBodySetCacheControlRuleActionParametersPrivateOperation = "set"
	RuleEditParamsBodySetCacheControlRuleActionParametersPrivateOperationRemove RuleEditParamsBodySetCacheControlRuleActionParametersPrivateOperation = "remove"
)

func (RuleEditParamsBodySetCacheControlRuleActionParametersPrivateOperation) IsKnown added in v6.9.0 

func (r RuleEditParamsBodySetCacheControlRuleActionParametersPrivateOperation) IsKnown() bool

type RuleEditParamsBodySetCacheControlRuleActionParametersPrivateRemoveDirective added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersPrivateRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RuleEditParamsBodySetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Remove the directive.

func (RuleEditParamsBodySetCacheControlRuleActionParametersPrivateRemoveDirective) MarshalJSON added in v6.9.0 

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

type RuleEditParamsBodySetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleEditParamsBodySetCacheControlRuleActionParametersPrivateRemoveDirectiveOperationSet    RuleEditParamsBodySetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation = "set"
	RuleEditParamsBodySetCacheControlRuleActionParametersPrivateRemoveDirectiveOperationRemove RuleEditParamsBodySetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation = "remove"
)

func (RuleEditParamsBodySetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleEditParamsBodySetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation) IsKnown() bool

type RuleEditParamsBodySetCacheControlRuleActionParametersPrivateSetDirective added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersPrivateSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RuleEditParamsBodySetCacheControlRuleActionParametersPrivateSetDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
	// Optional list of header names to qualify the directive (e.g., for "private" or
	// "no-cache" directives).
	Qualifiers param.Field[[]string] `json:"qualifiers"`
}

Set the directive with optional qualifiers.

func (RuleEditParamsBodySetCacheControlRuleActionParametersPrivateSetDirective) MarshalJSON added in v6.9.0 

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

type RuleEditParamsBodySetCacheControlRuleActionParametersPrivateSetDirectiveOperation added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersPrivateSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleEditParamsBodySetCacheControlRuleActionParametersPrivateSetDirectiveOperationSet    RuleEditParamsBodySetCacheControlRuleActionParametersPrivateSetDirectiveOperation = "set"
	RuleEditParamsBodySetCacheControlRuleActionParametersPrivateSetDirectiveOperationRemove RuleEditParamsBodySetCacheControlRuleActionParametersPrivateSetDirectiveOperation = "remove"
)

func (RuleEditParamsBodySetCacheControlRuleActionParametersPrivateSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleEditParamsBodySetCacheControlRuleActionParametersPrivateSetDirectiveOperation) IsKnown() bool

type RuleEditParamsBodySetCacheControlRuleActionParametersPrivateUnion added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersPrivateUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts optional qualifiers (header names).

Satisfied by rulesets.RuleEditParamsBodySetCacheControlRuleActionParametersPrivateSetDirective, rulesets.RuleEditParamsBodySetCacheControlRuleActionParametersPrivateRemoveDirective, RuleEditParamsBodySetCacheControlRuleActionParametersPrivate.

type RuleEditParamsBodySetCacheControlRuleActionParametersProxyRevalidate added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersProxyRevalidate struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RuleEditParamsBodySetCacheControlRuleActionParametersProxyRevalidateOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

A cache-control directive configuration.

func (RuleEditParamsBodySetCacheControlRuleActionParametersProxyRevalidate) MarshalJSON added in v6.9.0 

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

type RuleEditParamsBodySetCacheControlRuleActionParametersProxyRevalidateOperation added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersProxyRevalidateOperation string

The operation to perform on the cache-control directive. 

const (
	RuleEditParamsBodySetCacheControlRuleActionParametersProxyRevalidateOperationSet    RuleEditParamsBodySetCacheControlRuleActionParametersProxyRevalidateOperation = "set"
	RuleEditParamsBodySetCacheControlRuleActionParametersProxyRevalidateOperationRemove RuleEditParamsBodySetCacheControlRuleActionParametersProxyRevalidateOperation = "remove"
)

func (RuleEditParamsBodySetCacheControlRuleActionParametersProxyRevalidateOperation) IsKnown added in v6.9.0 

func (r RuleEditParamsBodySetCacheControlRuleActionParametersProxyRevalidateOperation) IsKnown() bool

type RuleEditParamsBodySetCacheControlRuleActionParametersProxyRevalidateRemoveDirective added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersProxyRevalidateRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RuleEditParamsBodySetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Remove the directive.

func (RuleEditParamsBodySetCacheControlRuleActionParametersProxyRevalidateRemoveDirective) MarshalJSON added in v6.9.0 

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

type RuleEditParamsBodySetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleEditParamsBodySetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperationSet    RuleEditParamsBodySetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation = "set"
	RuleEditParamsBodySetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperationRemove RuleEditParamsBodySetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation = "remove"
)

func (RuleEditParamsBodySetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleEditParamsBodySetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation) IsKnown() bool

type RuleEditParamsBodySetCacheControlRuleActionParametersProxyRevalidateSetDirective added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersProxyRevalidateSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RuleEditParamsBodySetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Set the directive.

func (RuleEditParamsBodySetCacheControlRuleActionParametersProxyRevalidateSetDirective) MarshalJSON added in v6.9.0 

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

type RuleEditParamsBodySetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleEditParamsBodySetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperationSet    RuleEditParamsBodySetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation = "set"
	RuleEditParamsBodySetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperationRemove RuleEditParamsBodySetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation = "remove"
)

func (RuleEditParamsBodySetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleEditParamsBodySetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation) IsKnown() bool

type RuleEditParamsBodySetCacheControlRuleActionParametersProxyRevalidateUnion added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersProxyRevalidateUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Satisfied by rulesets.RuleEditParamsBodySetCacheControlRuleActionParametersProxyRevalidateSetDirective, rulesets.RuleEditParamsBodySetCacheControlRuleActionParametersProxyRevalidateRemoveDirective, RuleEditParamsBodySetCacheControlRuleActionParametersProxyRevalidate.

type RuleEditParamsBodySetCacheControlRuleActionParametersPublic added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersPublic struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RuleEditParamsBodySetCacheControlRuleActionParametersPublicOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

A cache-control directive configuration.

func (RuleEditParamsBodySetCacheControlRuleActionParametersPublic) MarshalJSON added in v6.9.0 

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

type RuleEditParamsBodySetCacheControlRuleActionParametersPublicOperation added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersPublicOperation string

The operation to perform on the cache-control directive. 

const (
	RuleEditParamsBodySetCacheControlRuleActionParametersPublicOperationSet    RuleEditParamsBodySetCacheControlRuleActionParametersPublicOperation = "set"
	RuleEditParamsBodySetCacheControlRuleActionParametersPublicOperationRemove RuleEditParamsBodySetCacheControlRuleActionParametersPublicOperation = "remove"
)

func (RuleEditParamsBodySetCacheControlRuleActionParametersPublicOperation) IsKnown added in v6.9.0 

func (r RuleEditParamsBodySetCacheControlRuleActionParametersPublicOperation) IsKnown() bool

type RuleEditParamsBodySetCacheControlRuleActionParametersPublicRemoveDirective added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersPublicRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RuleEditParamsBodySetCacheControlRuleActionParametersPublicRemoveDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Remove the directive.

func (RuleEditParamsBodySetCacheControlRuleActionParametersPublicRemoveDirective) MarshalJSON added in v6.9.0 

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

type RuleEditParamsBodySetCacheControlRuleActionParametersPublicRemoveDirectiveOperation added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersPublicRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleEditParamsBodySetCacheControlRuleActionParametersPublicRemoveDirectiveOperationSet    RuleEditParamsBodySetCacheControlRuleActionParametersPublicRemoveDirectiveOperation = "set"
	RuleEditParamsBodySetCacheControlRuleActionParametersPublicRemoveDirectiveOperationRemove RuleEditParamsBodySetCacheControlRuleActionParametersPublicRemoveDirectiveOperation = "remove"
)

func (RuleEditParamsBodySetCacheControlRuleActionParametersPublicRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleEditParamsBodySetCacheControlRuleActionParametersPublicRemoveDirectiveOperation) IsKnown() bool

type RuleEditParamsBodySetCacheControlRuleActionParametersPublicSetDirective added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersPublicSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RuleEditParamsBodySetCacheControlRuleActionParametersPublicSetDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Set the directive.

func (RuleEditParamsBodySetCacheControlRuleActionParametersPublicSetDirective) MarshalJSON added in v6.9.0 

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

type RuleEditParamsBodySetCacheControlRuleActionParametersPublicSetDirectiveOperation added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersPublicSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleEditParamsBodySetCacheControlRuleActionParametersPublicSetDirectiveOperationSet    RuleEditParamsBodySetCacheControlRuleActionParametersPublicSetDirectiveOperation = "set"
	RuleEditParamsBodySetCacheControlRuleActionParametersPublicSetDirectiveOperationRemove RuleEditParamsBodySetCacheControlRuleActionParametersPublicSetDirectiveOperation = "remove"
)

func (RuleEditParamsBodySetCacheControlRuleActionParametersPublicSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleEditParamsBodySetCacheControlRuleActionParametersPublicSetDirectiveOperation) IsKnown() bool

type RuleEditParamsBodySetCacheControlRuleActionParametersPublicUnion added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersPublicUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Satisfied by rulesets.RuleEditParamsBodySetCacheControlRuleActionParametersPublicSetDirective, rulesets.RuleEditParamsBodySetCacheControlRuleActionParametersPublicRemoveDirective, RuleEditParamsBodySetCacheControlRuleActionParametersPublic.

type RuleEditParamsBodySetCacheControlRuleActionParametersSMaxage added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersSMaxage struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RuleEditParamsBodySetCacheControlRuleActionParametersSMaxageOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
	// The duration value in seconds for the directive.
	Value param.Field[int64] `json:"value"`
}

A cache-control directive configuration that accepts a duration value in seconds.

func (RuleEditParamsBodySetCacheControlRuleActionParametersSMaxage) MarshalJSON added in v6.9.0 

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

type RuleEditParamsBodySetCacheControlRuleActionParametersSMaxageOperation added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersSMaxageOperation string

The operation to perform on the cache-control directive. 

const (
	RuleEditParamsBodySetCacheControlRuleActionParametersSMaxageOperationSet    RuleEditParamsBodySetCacheControlRuleActionParametersSMaxageOperation = "set"
	RuleEditParamsBodySetCacheControlRuleActionParametersSMaxageOperationRemove RuleEditParamsBodySetCacheControlRuleActionParametersSMaxageOperation = "remove"
)

func (RuleEditParamsBodySetCacheControlRuleActionParametersSMaxageOperation) IsKnown added in v6.9.0 

func (r RuleEditParamsBodySetCacheControlRuleActionParametersSMaxageOperation) IsKnown() bool

type RuleEditParamsBodySetCacheControlRuleActionParametersSMaxageRemoveDirective added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersSMaxageRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RuleEditParamsBodySetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Remove the directive.

func (RuleEditParamsBodySetCacheControlRuleActionParametersSMaxageRemoveDirective) MarshalJSON added in v6.9.0 

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

type RuleEditParamsBodySetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleEditParamsBodySetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperationSet    RuleEditParamsBodySetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation = "set"
	RuleEditParamsBodySetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperationRemove RuleEditParamsBodySetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation = "remove"
)

func (RuleEditParamsBodySetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleEditParamsBodySetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation) IsKnown() bool

type RuleEditParamsBodySetCacheControlRuleActionParametersSMaxageSetDirective added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersSMaxageSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RuleEditParamsBodySetCacheControlRuleActionParametersSMaxageSetDirectiveOperation] `json:"operation" api:"required"`
	// The duration value in seconds for the directive.
	Value param.Field[int64] `json:"value" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Set the directive with a duration value in seconds.

func (RuleEditParamsBodySetCacheControlRuleActionParametersSMaxageSetDirective) MarshalJSON added in v6.9.0 

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

type RuleEditParamsBodySetCacheControlRuleActionParametersSMaxageSetDirectiveOperation added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersSMaxageSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleEditParamsBodySetCacheControlRuleActionParametersSMaxageSetDirectiveOperationSet    RuleEditParamsBodySetCacheControlRuleActionParametersSMaxageSetDirectiveOperation = "set"
	RuleEditParamsBodySetCacheControlRuleActionParametersSMaxageSetDirectiveOperationRemove RuleEditParamsBodySetCacheControlRuleActionParametersSMaxageSetDirectiveOperation = "remove"
)

func (RuleEditParamsBodySetCacheControlRuleActionParametersSMaxageSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleEditParamsBodySetCacheControlRuleActionParametersSMaxageSetDirectiveOperation) IsKnown() bool

type RuleEditParamsBodySetCacheControlRuleActionParametersSMaxageUnion added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersSMaxageUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts a duration value in seconds.

Satisfied by rulesets.RuleEditParamsBodySetCacheControlRuleActionParametersSMaxageSetDirective, rulesets.RuleEditParamsBodySetCacheControlRuleActionParametersSMaxageRemoveDirective, RuleEditParamsBodySetCacheControlRuleActionParametersSMaxage.

type RuleEditParamsBodySetCacheControlRuleActionParametersStaleIfError added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersStaleIfError struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RuleEditParamsBodySetCacheControlRuleActionParametersStaleIfErrorOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
	// The duration value in seconds for the directive.
	Value param.Field[int64] `json:"value"`
}

A cache-control directive configuration that accepts a duration value in seconds.

func (RuleEditParamsBodySetCacheControlRuleActionParametersStaleIfError) MarshalJSON added in v6.9.0 

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

type RuleEditParamsBodySetCacheControlRuleActionParametersStaleIfErrorOperation added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersStaleIfErrorOperation string

The operation to perform on the cache-control directive. 

const (
	RuleEditParamsBodySetCacheControlRuleActionParametersStaleIfErrorOperationSet    RuleEditParamsBodySetCacheControlRuleActionParametersStaleIfErrorOperation = "set"
	RuleEditParamsBodySetCacheControlRuleActionParametersStaleIfErrorOperationRemove RuleEditParamsBodySetCacheControlRuleActionParametersStaleIfErrorOperation = "remove"
)

func (RuleEditParamsBodySetCacheControlRuleActionParametersStaleIfErrorOperation) IsKnown added in v6.9.0 

func (r RuleEditParamsBodySetCacheControlRuleActionParametersStaleIfErrorOperation) IsKnown() bool

type RuleEditParamsBodySetCacheControlRuleActionParametersStaleIfErrorRemoveDirective added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersStaleIfErrorRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RuleEditParamsBodySetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Remove the directive.

func (RuleEditParamsBodySetCacheControlRuleActionParametersStaleIfErrorRemoveDirective) MarshalJSON added in v6.9.0 

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

type RuleEditParamsBodySetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleEditParamsBodySetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperationSet    RuleEditParamsBodySetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation = "set"
	RuleEditParamsBodySetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperationRemove RuleEditParamsBodySetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation = "remove"
)

func (RuleEditParamsBodySetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleEditParamsBodySetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation) IsKnown() bool

type RuleEditParamsBodySetCacheControlRuleActionParametersStaleIfErrorSetDirective added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersStaleIfErrorSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RuleEditParamsBodySetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation] `json:"operation" api:"required"`
	// The duration value in seconds for the directive.
	Value param.Field[int64] `json:"value" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Set the directive with a duration value in seconds.

func (RuleEditParamsBodySetCacheControlRuleActionParametersStaleIfErrorSetDirective) MarshalJSON added in v6.9.0 

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

type RuleEditParamsBodySetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleEditParamsBodySetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperationSet    RuleEditParamsBodySetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation = "set"
	RuleEditParamsBodySetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperationRemove RuleEditParamsBodySetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation = "remove"
)

func (RuleEditParamsBodySetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleEditParamsBodySetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation) IsKnown() bool

type RuleEditParamsBodySetCacheControlRuleActionParametersStaleIfErrorUnion added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersStaleIfErrorUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts a duration value in seconds.

Satisfied by rulesets.RuleEditParamsBodySetCacheControlRuleActionParametersStaleIfErrorSetDirective, rulesets.RuleEditParamsBodySetCacheControlRuleActionParametersStaleIfErrorRemoveDirective, RuleEditParamsBodySetCacheControlRuleActionParametersStaleIfError.

type RuleEditParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidate added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidate struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RuleEditParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
	// The duration value in seconds for the directive.
	Value param.Field[int64] `json:"value"`
}

A cache-control directive configuration that accepts a duration value in seconds.

func (RuleEditParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidate) MarshalJSON added in v6.9.0 

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

type RuleEditParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateOperation added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateOperation string

The operation to perform on the cache-control directive. 

const (
	RuleEditParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateOperationSet    RuleEditParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateOperation = "set"
	RuleEditParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateOperationRemove RuleEditParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateOperation = "remove"
)

func (RuleEditParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateOperation) IsKnown added in v6.9.0 

func (r RuleEditParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateOperation) IsKnown() bool

type RuleEditParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RuleEditParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Remove the directive.

func (RuleEditParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective) MarshalJSON added in v6.9.0 

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

type RuleEditParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleEditParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperationSet    RuleEditParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation = "set"
	RuleEditParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperationRemove RuleEditParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation = "remove"
)

func (RuleEditParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleEditParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation) IsKnown() bool

type RuleEditParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RuleEditParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation] `json:"operation" api:"required"`
	// The duration value in seconds for the directive.
	Value param.Field[int64] `json:"value" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Set the directive with a duration value in seconds.

func (RuleEditParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective) MarshalJSON added in v6.9.0 

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

type RuleEditParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleEditParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperationSet    RuleEditParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation = "set"
	RuleEditParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperationRemove RuleEditParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation = "remove"
)

func (RuleEditParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleEditParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation) IsKnown() bool

type RuleEditParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateUnion added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts a duration value in seconds.

Satisfied by rulesets.RuleEditParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective, rulesets.RuleEditParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective, RuleEditParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidate.

type RuleEditParamsBodySetCacheControlRuleExposedCredentialCheck added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleExposedCredentialCheck struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression param.Field[string] `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression param.Field[string] `json:"username_expression" api:"required"`
}

Configuration for exposed credential checking.

func (RuleEditParamsBodySetCacheControlRuleExposedCredentialCheck) MarshalJSON added in v6.9.0 

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

type RuleEditParamsBodySetCacheControlRulePosition added in v6.9.0 

type RuleEditParamsBodySetCacheControlRulePosition struct {
	// The ID of another rule to place the rule after. An empty value causes the rule
	// to be placed at the bottom.
	After param.Field[string] `json:"after"`
	// The ID of another rule to place the rule before. An empty value causes the rule
	// to be placed at the top.
	Before param.Field[string] `json:"before"`
	// An index at which to place the rule, where index 1 is the first rule.
	Index param.Field[int64] `json:"index"`
}

An object configuring where the rule will be placed.

func (RuleEditParamsBodySetCacheControlRulePosition) MarshalJSON added in v6.9.0 

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

type RuleEditParamsBodySetCacheControlRulePositionAfterPosition added in v6.9.0 

type RuleEditParamsBodySetCacheControlRulePositionAfterPosition struct {
	// The ID of another rule to place the rule after. An empty value causes the rule
	// to be placed at the bottom.
	After param.Field[string] `json:"after"`
}

An object configuring where the rule will be placed.

func (RuleEditParamsBodySetCacheControlRulePositionAfterPosition) MarshalJSON added in v6.9.0 

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

type RuleEditParamsBodySetCacheControlRulePositionBeforePosition added in v6.9.0 

type RuleEditParamsBodySetCacheControlRulePositionBeforePosition struct {
	// The ID of another rule to place the rule before. An empty value causes the rule
	// to be placed at the top.
	Before param.Field[string] `json:"before"`
}

An object configuring where the rule will be placed.

func (RuleEditParamsBodySetCacheControlRulePositionBeforePosition) MarshalJSON added in v6.9.0 

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

type RuleEditParamsBodySetCacheControlRulePositionIndexPosition added in v6.9.0 

type RuleEditParamsBodySetCacheControlRulePositionIndexPosition struct {
	// An index at which to place the rule, where index 1 is the first rule.
	Index param.Field[int64] `json:"index"`
}

An object configuring where the rule will be placed.

func (RuleEditParamsBodySetCacheControlRulePositionIndexPosition) MarshalJSON added in v6.9.0 

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

type RuleEditParamsBodySetCacheControlRulePositionUnion added in v6.9.0 

type RuleEditParamsBodySetCacheControlRulePositionUnion interface {
	// contains filtered or unexported methods
}

An object configuring where the rule will be placed.

Satisfied by rulesets.RuleEditParamsBodySetCacheControlRulePositionBeforePosition, rulesets.RuleEditParamsBodySetCacheControlRulePositionAfterPosition, rulesets.RuleEditParamsBodySetCacheControlRulePositionIndexPosition, RuleEditParamsBodySetCacheControlRulePosition.

type RuleEditParamsBodySetCacheControlRuleRatelimit added in v6.9.0 

type RuleEditParamsBodySetCacheControlRuleRatelimit struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics param.Field[[]string] `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period param.Field[int64] `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression param.Field[string] `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout param.Field[int64] `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod param.Field[int64] `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin param.Field[bool] `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod param.Field[int64] `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName param.Field[string] `json:"score_response_header_name"`
}

An object configuring the rule's rate limit behavior.

func (RuleEditParamsBodySetCacheControlRuleRatelimit) MarshalJSON added in v6.9.0 

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

type RuleEditParamsBodySetCacheSettingsRule 

type RuleEditParamsBodySetCacheSettingsRule struct {
	// An object configuring where the rule will be placed.
	Position param.Field[RuleEditParamsBodySetCacheSettingsRulePositionUnion] `json:"position"`
	SetCacheSettingsRuleParam
}

func (RuleEditParamsBodySetCacheSettingsRule) MarshalJSON 

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

type RuleEditParamsBodySetCacheSettingsRulePosition 

type RuleEditParamsBodySetCacheSettingsRulePosition struct {
	// The ID of another rule to place the rule after. An empty value causes the rule
	// to be placed at the bottom.
	After param.Field[string] `json:"after"`
	// The ID of another rule to place the rule before. An empty value causes the rule
	// to be placed at the top.
	Before param.Field[string] `json:"before"`
	// An index at which to place the rule, where index 1 is the first rule.
	Index param.Field[int64] `json:"index"`
}

An object configuring where the rule will be placed.

func (RuleEditParamsBodySetCacheSettingsRulePosition) MarshalJSON 

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

type RuleEditParamsBodySetCacheSettingsRulePositionAfterPosition 

type RuleEditParamsBodySetCacheSettingsRulePositionAfterPosition struct {
	// The ID of another rule to place the rule after. An empty value causes the rule
	// to be placed at the bottom.
	After param.Field[string] `json:"after"`
}

An object configuring where the rule will be placed.

func (RuleEditParamsBodySetCacheSettingsRulePositionAfterPosition) MarshalJSON 

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

type RuleEditParamsBodySetCacheSettingsRulePositionBeforePosition 

type RuleEditParamsBodySetCacheSettingsRulePositionBeforePosition struct {
	// The ID of another rule to place the rule before. An empty value causes the rule
	// to be placed at the top.
	Before param.Field[string] `json:"before"`
}

An object configuring where the rule will be placed.

func (RuleEditParamsBodySetCacheSettingsRulePositionBeforePosition) MarshalJSON 

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

type RuleEditParamsBodySetCacheSettingsRulePositionIndexPosition 

type RuleEditParamsBodySetCacheSettingsRulePositionIndexPosition struct {
	// An index at which to place the rule, where index 1 is the first rule.
	Index param.Field[int64] `json:"index"`
}

An object configuring where the rule will be placed.

func (RuleEditParamsBodySetCacheSettingsRulePositionIndexPosition) MarshalJSON 

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

type RuleEditParamsBodySetCacheSettingsRulePositionUnion 

type RuleEditParamsBodySetCacheSettingsRulePositionUnion interface {
	// contains filtered or unexported methods
}

An object configuring where the rule will be placed.

Satisfied by rulesets.RuleEditParamsBodySetCacheSettingsRulePositionBeforePosition, rulesets.RuleEditParamsBodySetCacheSettingsRulePositionAfterPosition, rulesets.RuleEditParamsBodySetCacheSettingsRulePositionIndexPosition, RuleEditParamsBodySetCacheSettingsRulePosition.

type RuleEditParamsBodySetCacheTagsRule added in v6.9.0 

type RuleEditParamsBodySetCacheTagsRule struct {
	// The unique ID of the rule.
	ID param.Field[string] `json:"id"`
	// The action to perform when the rule matches.
	Action param.Field[RuleEditParamsBodySetCacheTagsRuleAction] `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters param.Field[RuleEditParamsBodySetCacheTagsRuleActionParametersUnion] `json:"action_parameters"`
	// An informative description of the rule.
	Description param.Field[string] `json:"description"`
	// Whether the rule should be executed.
	Enabled param.Field[bool] `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck param.Field[RuleEditParamsBodySetCacheTagsRuleExposedCredentialCheck] `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression param.Field[string] `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging param.Field[LoggingParam] `json:"logging"`
	// An object configuring where the rule will be placed.
	Position param.Field[RuleEditParamsBodySetCacheTagsRulePositionUnion] `json:"position"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit param.Field[RuleEditParamsBodySetCacheTagsRuleRatelimit] `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref param.Field[string] `json:"ref"`
}

func (RuleEditParamsBodySetCacheTagsRule) MarshalJSON added in v6.9.0 

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

type RuleEditParamsBodySetCacheTagsRuleAction added in v6.9.0 

type RuleEditParamsBodySetCacheTagsRuleAction string

The action to perform when the rule matches. 

const (
	RuleEditParamsBodySetCacheTagsRuleActionSetCacheTags RuleEditParamsBodySetCacheTagsRuleAction = "set_cache_tags"
)

func (RuleEditParamsBodySetCacheTagsRuleAction) IsKnown added in v6.9.0 

func (r RuleEditParamsBodySetCacheTagsRuleAction) IsKnown() bool

type RuleEditParamsBodySetCacheTagsRuleActionParameters added in v6.9.0 

type RuleEditParamsBodySetCacheTagsRuleActionParameters struct {
	// The operation to perform on the cache tags.
	Operation param.Field[RuleEditParamsBodySetCacheTagsRuleActionParametersOperation] `json:"operation" api:"required"`
	// An expression that evaluates to an array of cache tag values.
	Expression param.Field[string]      `json:"expression"`
	Values     param.Field[interface{}] `json:"values"`
}

The parameters configuring the rule's action.

func (RuleEditParamsBodySetCacheTagsRuleActionParameters) MarshalJSON added in v6.9.0 

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

type RuleEditParamsBodySetCacheTagsRuleActionParametersAddCacheTagsExpression added in v6.9.0 

type RuleEditParamsBodySetCacheTagsRuleActionParametersAddCacheTagsExpression struct {
	// An expression that evaluates to an array of cache tag values.
	Expression param.Field[string] `json:"expression" api:"required"`
	// The operation to perform on the cache tags.
	Operation param.Field[RuleEditParamsBodySetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation] `json:"operation" api:"required"`
}

Add cache tags using an expression.

func (RuleEditParamsBodySetCacheTagsRuleActionParametersAddCacheTagsExpression) MarshalJSON added in v6.9.0 

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

type RuleEditParamsBodySetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation added in v6.9.0 

type RuleEditParamsBodySetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation string

The operation to perform on the cache tags. 

const (
	RuleEditParamsBodySetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationAdd    RuleEditParamsBodySetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "add"
	RuleEditParamsBodySetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationRemove RuleEditParamsBodySetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "remove"
	RuleEditParamsBodySetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationSet    RuleEditParamsBodySetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "set"
)

func (RuleEditParamsBodySetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation) IsKnown added in v6.9.0 

func (r RuleEditParamsBodySetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation) IsKnown() bool

type RuleEditParamsBodySetCacheTagsRuleActionParametersAddCacheTagsValues added in v6.9.0 

type RuleEditParamsBodySetCacheTagsRuleActionParametersAddCacheTagsValues struct {
	// The operation to perform on the cache tags.
	Operation param.Field[RuleEditParamsBodySetCacheTagsRuleActionParametersAddCacheTagsValuesOperation] `json:"operation" api:"required"`
	// A list of cache tag values.
	Values param.Field[[]string] `json:"values" api:"required"`
}

Add cache tags using a list of values.

func (RuleEditParamsBodySetCacheTagsRuleActionParametersAddCacheTagsValues) MarshalJSON added in v6.9.0 

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

type RuleEditParamsBodySetCacheTagsRuleActionParametersAddCacheTagsValuesOperation added in v6.9.0 

type RuleEditParamsBodySetCacheTagsRuleActionParametersAddCacheTagsValuesOperation string

The operation to perform on the cache tags. 

const (
	RuleEditParamsBodySetCacheTagsRuleActionParametersAddCacheTagsValuesOperationAdd    RuleEditParamsBodySetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "add"
	RuleEditParamsBodySetCacheTagsRuleActionParametersAddCacheTagsValuesOperationRemove RuleEditParamsBodySetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "remove"
	RuleEditParamsBodySetCacheTagsRuleActionParametersAddCacheTagsValuesOperationSet    RuleEditParamsBodySetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "set"
)

func (RuleEditParamsBodySetCacheTagsRuleActionParametersAddCacheTagsValuesOperation) IsKnown added in v6.9.0 

func (r RuleEditParamsBodySetCacheTagsRuleActionParametersAddCacheTagsValuesOperation) IsKnown() bool

type RuleEditParamsBodySetCacheTagsRuleActionParametersOperation added in v6.9.0 

type RuleEditParamsBodySetCacheTagsRuleActionParametersOperation string

The operation to perform on the cache tags. 

const (
	RuleEditParamsBodySetCacheTagsRuleActionParametersOperationAdd    RuleEditParamsBodySetCacheTagsRuleActionParametersOperation = "add"
	RuleEditParamsBodySetCacheTagsRuleActionParametersOperationRemove RuleEditParamsBodySetCacheTagsRuleActionParametersOperation = "remove"
	RuleEditParamsBodySetCacheTagsRuleActionParametersOperationSet    RuleEditParamsBodySetCacheTagsRuleActionParametersOperation = "set"
)

func (RuleEditParamsBodySetCacheTagsRuleActionParametersOperation) IsKnown added in v6.9.0 

func (r RuleEditParamsBodySetCacheTagsRuleActionParametersOperation) IsKnown() bool

type RuleEditParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsExpression added in v6.9.0 

type RuleEditParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsExpression struct {
	// An expression that evaluates to an array of cache tag values.
	Expression param.Field[string] `json:"expression" api:"required"`
	// The operation to perform on the cache tags.
	Operation param.Field[RuleEditParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation] `json:"operation" api:"required"`
}

Remove cache tags using an expression.

func (RuleEditParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsExpression) MarshalJSON added in v6.9.0 

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

type RuleEditParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation added in v6.9.0 

type RuleEditParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation string

The operation to perform on the cache tags. 

const (
	RuleEditParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationAdd    RuleEditParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "add"
	RuleEditParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationRemove RuleEditParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "remove"
	RuleEditParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationSet    RuleEditParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "set"
)

func (RuleEditParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation) IsKnown added in v6.9.0 

func (r RuleEditParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation) IsKnown() bool

type RuleEditParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsValues added in v6.9.0 

type RuleEditParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsValues struct {
	// The operation to perform on the cache tags.
	Operation param.Field[RuleEditParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation] `json:"operation" api:"required"`
	// A list of cache tag values.
	Values param.Field[[]string] `json:"values" api:"required"`
}

Remove cache tags using a list of values.

func (RuleEditParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsValues) MarshalJSON added in v6.9.0 

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

type RuleEditParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation added in v6.9.0 

type RuleEditParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation string

The operation to perform on the cache tags. 

const (
	RuleEditParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationAdd    RuleEditParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "add"
	RuleEditParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationRemove RuleEditParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "remove"
	RuleEditParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationSet    RuleEditParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "set"
)

func (RuleEditParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation) IsKnown added in v6.9.0 

func (r RuleEditParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation) IsKnown() bool

type RuleEditParamsBodySetCacheTagsRuleActionParametersSetCacheTagsExpression added in v6.9.0 

type RuleEditParamsBodySetCacheTagsRuleActionParametersSetCacheTagsExpression struct {
	// An expression that evaluates to an array of cache tag values.
	Expression param.Field[string] `json:"expression" api:"required"`
	// The operation to perform on the cache tags.
	Operation param.Field[RuleEditParamsBodySetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation] `json:"operation" api:"required"`
}

Set cache tags using an expression.

func (RuleEditParamsBodySetCacheTagsRuleActionParametersSetCacheTagsExpression) MarshalJSON added in v6.9.0 

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

type RuleEditParamsBodySetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation added in v6.9.0 

type RuleEditParamsBodySetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation string

The operation to perform on the cache tags. 

const (
	RuleEditParamsBodySetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationAdd    RuleEditParamsBodySetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "add"
	RuleEditParamsBodySetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationRemove RuleEditParamsBodySetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "remove"
	RuleEditParamsBodySetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationSet    RuleEditParamsBodySetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "set"
)

func (RuleEditParamsBodySetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation) IsKnown added in v6.9.0 

func (r RuleEditParamsBodySetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation) IsKnown() bool

type RuleEditParamsBodySetCacheTagsRuleActionParametersSetCacheTagsValues added in v6.9.0 

type RuleEditParamsBodySetCacheTagsRuleActionParametersSetCacheTagsValues struct {
	// The operation to perform on the cache tags.
	Operation param.Field[RuleEditParamsBodySetCacheTagsRuleActionParametersSetCacheTagsValuesOperation] `json:"operation" api:"required"`
	// A list of cache tag values.
	Values param.Field[[]string] `json:"values" api:"required"`
}

Set cache tags using a list of values.

func (RuleEditParamsBodySetCacheTagsRuleActionParametersSetCacheTagsValues) MarshalJSON added in v6.9.0 

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

type RuleEditParamsBodySetCacheTagsRuleActionParametersSetCacheTagsValuesOperation added in v6.9.0 

type RuleEditParamsBodySetCacheTagsRuleActionParametersSetCacheTagsValuesOperation string

The operation to perform on the cache tags. 

const (
	RuleEditParamsBodySetCacheTagsRuleActionParametersSetCacheTagsValuesOperationAdd    RuleEditParamsBodySetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "add"
	RuleEditParamsBodySetCacheTagsRuleActionParametersSetCacheTagsValuesOperationRemove RuleEditParamsBodySetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "remove"
	RuleEditParamsBodySetCacheTagsRuleActionParametersSetCacheTagsValuesOperationSet    RuleEditParamsBodySetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "set"
)

func (RuleEditParamsBodySetCacheTagsRuleActionParametersSetCacheTagsValuesOperation) IsKnown added in v6.9.0 

func (r RuleEditParamsBodySetCacheTagsRuleActionParametersSetCacheTagsValuesOperation) IsKnown() bool

type RuleEditParamsBodySetCacheTagsRuleActionParametersUnion added in v6.9.0 

type RuleEditParamsBodySetCacheTagsRuleActionParametersUnion interface {
	// contains filtered or unexported methods
}

The parameters configuring the rule's action.

Satisfied by rulesets.RuleEditParamsBodySetCacheTagsRuleActionParametersAddCacheTagsValues, rulesets.RuleEditParamsBodySetCacheTagsRuleActionParametersAddCacheTagsExpression, rulesets.RuleEditParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsValues, rulesets.RuleEditParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsExpression, rulesets.RuleEditParamsBodySetCacheTagsRuleActionParametersSetCacheTagsValues, rulesets.RuleEditParamsBodySetCacheTagsRuleActionParametersSetCacheTagsExpression, RuleEditParamsBodySetCacheTagsRuleActionParameters.

type RuleEditParamsBodySetCacheTagsRuleExposedCredentialCheck added in v6.9.0 

type RuleEditParamsBodySetCacheTagsRuleExposedCredentialCheck struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression param.Field[string] `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression param.Field[string] `json:"username_expression" api:"required"`
}

Configuration for exposed credential checking.

func (RuleEditParamsBodySetCacheTagsRuleExposedCredentialCheck) MarshalJSON added in v6.9.0 

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

type RuleEditParamsBodySetCacheTagsRulePosition added in v6.9.0 

type RuleEditParamsBodySetCacheTagsRulePosition struct {
	// The ID of another rule to place the rule after. An empty value causes the rule
	// to be placed at the bottom.
	After param.Field[string] `json:"after"`
	// The ID of another rule to place the rule before. An empty value causes the rule
	// to be placed at the top.
	Before param.Field[string] `json:"before"`
	// An index at which to place the rule, where index 1 is the first rule.
	Index param.Field[int64] `json:"index"`
}

An object configuring where the rule will be placed.

func (RuleEditParamsBodySetCacheTagsRulePosition) MarshalJSON added in v6.9.0 

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

type RuleEditParamsBodySetCacheTagsRulePositionAfterPosition added in v6.9.0 

type RuleEditParamsBodySetCacheTagsRulePositionAfterPosition struct {
	// The ID of another rule to place the rule after. An empty value causes the rule
	// to be placed at the bottom.
	After param.Field[string] `json:"after"`
}

An object configuring where the rule will be placed.

func (RuleEditParamsBodySetCacheTagsRulePositionAfterPosition) MarshalJSON added in v6.9.0 

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

type RuleEditParamsBodySetCacheTagsRulePositionBeforePosition added in v6.9.0 

type RuleEditParamsBodySetCacheTagsRulePositionBeforePosition struct {
	// The ID of another rule to place the rule before. An empty value causes the rule
	// to be placed at the top.
	Before param.Field[string] `json:"before"`
}

An object configuring where the rule will be placed.

func (RuleEditParamsBodySetCacheTagsRulePositionBeforePosition) MarshalJSON added in v6.9.0 

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

type RuleEditParamsBodySetCacheTagsRulePositionIndexPosition added in v6.9.0 

type RuleEditParamsBodySetCacheTagsRulePositionIndexPosition struct {
	// An index at which to place the rule, where index 1 is the first rule.
	Index param.Field[int64] `json:"index"`
}

An object configuring where the rule will be placed.

func (RuleEditParamsBodySetCacheTagsRulePositionIndexPosition) MarshalJSON added in v6.9.0 

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

type RuleEditParamsBodySetCacheTagsRulePositionUnion added in v6.9.0 

type RuleEditParamsBodySetCacheTagsRulePositionUnion interface {
	// contains filtered or unexported methods
}

An object configuring where the rule will be placed.

Satisfied by rulesets.RuleEditParamsBodySetCacheTagsRulePositionBeforePosition, rulesets.RuleEditParamsBodySetCacheTagsRulePositionAfterPosition, rulesets.RuleEditParamsBodySetCacheTagsRulePositionIndexPosition, RuleEditParamsBodySetCacheTagsRulePosition.

type RuleEditParamsBodySetCacheTagsRuleRatelimit added in v6.9.0 

type RuleEditParamsBodySetCacheTagsRuleRatelimit struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics param.Field[[]string] `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period param.Field[int64] `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression param.Field[string] `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout param.Field[int64] `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod param.Field[int64] `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin param.Field[bool] `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod param.Field[int64] `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName param.Field[string] `json:"score_response_header_name"`
}

An object configuring the rule's rate limit behavior.

func (RuleEditParamsBodySetCacheTagsRuleRatelimit) MarshalJSON added in v6.9.0 

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

type RuleEditParamsBodySetConfigurationRule 

type RuleEditParamsBodySetConfigurationRule struct {
	// An object configuring where the rule will be placed.
	Position param.Field[RuleEditParamsBodySetConfigurationRulePositionUnion] `json:"position"`
	SetConfigRuleParam
}

func (RuleEditParamsBodySetConfigurationRule) MarshalJSON 

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

type RuleEditParamsBodySetConfigurationRulePosition 

type RuleEditParamsBodySetConfigurationRulePosition struct {
	// The ID of another rule to place the rule after. An empty value causes the rule
	// to be placed at the bottom.
	After param.Field[string] `json:"after"`
	// The ID of another rule to place the rule before. An empty value causes the rule
	// to be placed at the top.
	Before param.Field[string] `json:"before"`
	// An index at which to place the rule, where index 1 is the first rule.
	Index param.Field[int64] `json:"index"`
}

An object configuring where the rule will be placed.

func (RuleEditParamsBodySetConfigurationRulePosition) MarshalJSON 

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

type RuleEditParamsBodySetConfigurationRulePositionAfterPosition 

type RuleEditParamsBodySetConfigurationRulePositionAfterPosition struct {
	// The ID of another rule to place the rule after. An empty value causes the rule
	// to be placed at the bottom.
	After param.Field[string] `json:"after"`
}

An object configuring where the rule will be placed.

func (RuleEditParamsBodySetConfigurationRulePositionAfterPosition) MarshalJSON 

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

type RuleEditParamsBodySetConfigurationRulePositionBeforePosition 

type RuleEditParamsBodySetConfigurationRulePositionBeforePosition struct {
	// The ID of another rule to place the rule before. An empty value causes the rule
	// to be placed at the top.
	Before param.Field[string] `json:"before"`
}

An object configuring where the rule will be placed.

func (RuleEditParamsBodySetConfigurationRulePositionBeforePosition) MarshalJSON 

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

type RuleEditParamsBodySetConfigurationRulePositionIndexPosition 

type RuleEditParamsBodySetConfigurationRulePositionIndexPosition struct {
	// An index at which to place the rule, where index 1 is the first rule.
	Index param.Field[int64] `json:"index"`
}

An object configuring where the rule will be placed.

func (RuleEditParamsBodySetConfigurationRulePositionIndexPosition) MarshalJSON 

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

type RuleEditParamsBodySetConfigurationRulePositionUnion 

type RuleEditParamsBodySetConfigurationRulePositionUnion interface {
	// contains filtered or unexported methods
}

An object configuring where the rule will be placed.

Satisfied by rulesets.RuleEditParamsBodySetConfigurationRulePositionBeforePosition, rulesets.RuleEditParamsBodySetConfigurationRulePositionAfterPosition, rulesets.RuleEditParamsBodySetConfigurationRulePositionIndexPosition, RuleEditParamsBodySetConfigurationRulePosition.

type RuleEditParamsBodySkipRule 

type RuleEditParamsBodySkipRule struct {
	// An object configuring where the rule will be placed.
	Position param.Field[RuleEditParamsBodySkipRulePositionUnion] `json:"position"`
	SkipRuleParam
}

func (RuleEditParamsBodySkipRule) MarshalJSON 

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

type RuleEditParamsBodySkipRulePosition 

type RuleEditParamsBodySkipRulePosition struct {
	// The ID of another rule to place the rule after. An empty value causes the rule
	// to be placed at the bottom.
	After param.Field[string] `json:"after"`
	// The ID of another rule to place the rule before. An empty value causes the rule
	// to be placed at the top.
	Before param.Field[string] `json:"before"`
	// An index at which to place the rule, where index 1 is the first rule.
	Index param.Field[int64] `json:"index"`
}

An object configuring where the rule will be placed.

func (RuleEditParamsBodySkipRulePosition) MarshalJSON 

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

type RuleEditParamsBodySkipRulePositionAfterPosition 

type RuleEditParamsBodySkipRulePositionAfterPosition struct {
	// The ID of another rule to place the rule after. An empty value causes the rule
	// to be placed at the bottom.
	After param.Field[string] `json:"after"`
}

An object configuring where the rule will be placed.

func (RuleEditParamsBodySkipRulePositionAfterPosition) MarshalJSON 

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

type RuleEditParamsBodySkipRulePositionBeforePosition 

type RuleEditParamsBodySkipRulePositionBeforePosition struct {
	// The ID of another rule to place the rule before. An empty value causes the rule
	// to be placed at the top.
	Before param.Field[string] `json:"before"`
}

An object configuring where the rule will be placed.

func (RuleEditParamsBodySkipRulePositionBeforePosition) MarshalJSON 

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

type RuleEditParamsBodySkipRulePositionIndexPosition 

type RuleEditParamsBodySkipRulePositionIndexPosition struct {
	// An index at which to place the rule, where index 1 is the first rule.
	Index param.Field[int64] `json:"index"`
}

An object configuring where the rule will be placed.

func (RuleEditParamsBodySkipRulePositionIndexPosition) MarshalJSON 

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

type RuleEditParamsBodySkipRulePositionUnion 

type RuleEditParamsBodySkipRulePositionUnion interface {
	// contains filtered or unexported methods
}

An object configuring where the rule will be placed.

Satisfied by rulesets.RuleEditParamsBodySkipRulePositionBeforePosition, rulesets.RuleEditParamsBodySkipRulePositionAfterPosition, rulesets.RuleEditParamsBodySkipRulePositionIndexPosition, RuleEditParamsBodySkipRulePosition.

type RuleEditParamsBodyUnion 

type RuleEditParamsBodyUnion interface {
	// contains filtered or unexported methods
}

Satisfied by rulesets.RuleEditParamsBodyBlockRule, rulesets.RuleEditParamsBodyChallengeRule, rulesets.RuleEditParamsBodyResponseCompressionRule, rulesets.RuleEditParamsBodyDDoSDynamicRule, rulesets.RuleEditParamsBodyExecuteRule, rulesets.RuleEditParamsBodyForceConnectionCloseRule, rulesets.RuleEditParamsBodyJavaScriptChallengeRule, rulesets.RuleEditParamsBodyLogRule, rulesets.RuleEditParamsBodyLogCustomFieldRule, rulesets.RuleEditParamsBodyManagedChallengeRule, rulesets.RuleEditParamsBodyRedirectRule, rulesets.RuleEditParamsBodyRewriteRule, rulesets.RuleEditParamsBodyRouteRule, rulesets.RuleEditParamsBodyScoreRule, rulesets.RuleEditParamsBodyServeErrorRule, rulesets.RuleEditParamsBodySetCacheControlRule, rulesets.RuleEditParamsBodySetCacheSettingsRule, rulesets.RuleEditParamsBodySetCacheTagsRule, rulesets.RuleEditParamsBodySetConfigurationRule, rulesets.RuleEditParamsBodySkipRule, RuleEditParamsBody.

type RuleEditResponse 

type RuleEditResponse struct {
	// The unique ID of the ruleset.
	ID string `json:"id" api:"required"`
	// The kind of the ruleset.
	Kind Kind `json:"kind" api:"required"`
	// The timestamp of when the ruleset was last modified.
	LastUpdated time.Time `json:"last_updated" api:"required" format:"date-time"`
	// The human-readable name of the ruleset.
	Name string `json:"name" api:"required"`
	// The phase of the ruleset.
	Phase Phase `json:"phase" api:"required"`
	// The list of rules in the ruleset.
	Rules []RuleEditResponseRule `json:"rules" api:"required"`
	// The version of the ruleset.
	Version string `json:"version" api:"required"`
	// An informative description of the ruleset.
	Description string               `json:"description"`
	JSON        ruleEditResponseJSON `json:"-"`
}

A ruleset object.

func (*RuleEditResponse) UnmarshalJSON 

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

type RuleEditResponseEnvelope 

type RuleEditResponseEnvelope struct {
	// A list of error messages.
	Errors []RuleEditResponseEnvelopeErrors `json:"errors" api:"required"`
	// A list of warning messages.
	Messages []RuleEditResponseEnvelopeMessages `json:"messages" api:"required"`
	// A ruleset object.
	Result RuleEditResponse `json:"result" api:"required"`
	// Whether the API call was successful.
	Success RuleEditResponseEnvelopeSuccess `json:"success" api:"required"`
	JSON    ruleEditResponseEnvelopeJSON    `json:"-"`
}

A response object.

func (*RuleEditResponseEnvelope) UnmarshalJSON 

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

type RuleEditResponseEnvelopeErrors 

type RuleEditResponseEnvelopeErrors struct {
	// A text description of this message.
	Message string `json:"message" api:"required"`
	// A unique code for this message.
	Code int64 `json:"code"`
	// The source of this message.
	Source RuleEditResponseEnvelopeErrorsSource `json:"source"`
	JSON   ruleEditResponseEnvelopeErrorsJSON   `json:"-"`
}

A message.

func (*RuleEditResponseEnvelopeErrors) UnmarshalJSON 

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

type RuleEditResponseEnvelopeErrorsSource 

type RuleEditResponseEnvelopeErrorsSource struct {
	// A JSON pointer to the field that is the source of the message.
	Pointer string                                   `json:"pointer" api:"required"`
	JSON    ruleEditResponseEnvelopeErrorsSourceJSON `json:"-"`
}

The source of this message.

func (*RuleEditResponseEnvelopeErrorsSource) UnmarshalJSON 

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

type RuleEditResponseEnvelopeMessages 

type RuleEditResponseEnvelopeMessages struct {
	// A text description of this message.
	Message string `json:"message" api:"required"`
	// A unique code for this message.
	Code int64 `json:"code"`
	// The source of this message.
	Source RuleEditResponseEnvelopeMessagesSource `json:"source"`
	JSON   ruleEditResponseEnvelopeMessagesJSON   `json:"-"`
}

A message.

func (*RuleEditResponseEnvelopeMessages) UnmarshalJSON 

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

type RuleEditResponseEnvelopeMessagesSource 

type RuleEditResponseEnvelopeMessagesSource struct {
	// A JSON pointer to the field that is the source of the message.
	Pointer string                                     `json:"pointer" api:"required"`
	JSON    ruleEditResponseEnvelopeMessagesSourceJSON `json:"-"`
}

The source of this message.

func (*RuleEditResponseEnvelopeMessagesSource) UnmarshalJSON 

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

type RuleEditResponseEnvelopeSuccess 

type RuleEditResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	RuleEditResponseEnvelopeSuccessTrue RuleEditResponseEnvelopeSuccess = true
)

func (RuleEditResponseEnvelopeSuccess) IsKnown 

func (r RuleEditResponseEnvelopeSuccess) IsKnown() bool

type RuleEditResponseRule 

type RuleEditResponseRule struct {
	// The timestamp of when the rule was last modified.
	LastUpdated time.Time `json:"last_updated" api:"required" format:"date-time"`
	// The version of the rule.
	Version string `json:"version" api:"required"`
	// The unique ID of the rule.
	ID string `json:"id"`
	// The action to perform when the rule matches.
	Action RuleEditResponseRulesAction `json:"action"`
	// This field can have the runtime type of [BlockRuleActionParameters],
	// [interface{}], [CompressResponseRuleActionParameters],
	// [ExecuteRuleActionParameters], [LogCustomFieldRuleActionParameters],
	// [RedirectRuleActionParameters], [RewriteRuleActionParameters],
	// [RouteRuleActionParameters], [ScoreRuleActionParameters],
	// [ServeErrorRuleActionParameters],
	// [RuleEditResponseRulesRulesetsSetCacheControlRuleActionParameters],
	// [SetCacheSettingsRuleActionParameters],
	// [RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParameters],
	// [SetConfigRuleActionParameters], [SkipRuleActionParameters].
	ActionParameters interface{} `json:"action_parameters"`
	// This field can have the runtime type of [[]string].
	Categories interface{} `json:"categories"`
	// An informative description of the rule.
	Description string `json:"description"`
	// Whether the rule should be executed.
	Enabled bool `json:"enabled"`
	// This field can have the runtime type of [BlockRuleExposedCredentialCheck],
	// [RuleEditResponseRulesRulesetsChallengeRuleExposedCredentialCheck],
	// [CompressResponseRuleExposedCredentialCheck],
	// [DDoSDynamicRuleExposedCredentialCheck], [ExecuteRuleExposedCredentialCheck],
	// [ForceConnectionCloseRuleExposedCredentialCheck],
	// [RuleEditResponseRulesRulesetsJSChallengeRuleExposedCredentialCheck],
	// [LogRuleExposedCredentialCheck], [LogCustomFieldRuleExposedCredentialCheck],
	// [ManagedChallengeRuleExposedCredentialCheck],
	// [RedirectRuleExposedCredentialCheck], [RewriteRuleExposedCredentialCheck],
	// [RouteRuleExposedCredentialCheck], [ScoreRuleExposedCredentialCheck],
	// [ServeErrorRuleExposedCredentialCheck],
	// [RuleEditResponseRulesRulesetsSetCacheControlRuleExposedCredentialCheck],
	// [SetCacheSettingsRuleExposedCredentialCheck],
	// [RuleEditResponseRulesRulesetsSetCacheTagsRuleExposedCredentialCheck],
	// [SetConfigRuleExposedCredentialCheck], [SkipRuleExposedCredentialCheck].
	ExposedCredentialCheck interface{} `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression string `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging Logging `json:"logging"`
	// This field can have the runtime type of [BlockRuleRatelimit],
	// [RuleEditResponseRulesRulesetsChallengeRuleRatelimit],
	// [CompressResponseRuleRatelimit], [DDoSDynamicRuleRatelimit],
	// [ExecuteRuleRatelimit], [ForceConnectionCloseRuleRatelimit],
	// [RuleEditResponseRulesRulesetsJSChallengeRuleRatelimit], [LogRuleRatelimit],
	// [LogCustomFieldRuleRatelimit], [ManagedChallengeRuleRatelimit],
	// [RedirectRuleRatelimit], [RewriteRuleRatelimit], [RouteRuleRatelimit],
	// [ScoreRuleRatelimit], [ServeErrorRuleRatelimit],
	// [RuleEditResponseRulesRulesetsSetCacheControlRuleRatelimit],
	// [SetCacheSettingsRuleRatelimit],
	// [RuleEditResponseRulesRulesetsSetCacheTagsRuleRatelimit],
	// [SetConfigRuleRatelimit], [SkipRuleRatelimit].
	Ratelimit interface{} `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                   `json:"ref"`
	JSON ruleEditResponseRuleJSON `json:"-"`
	// contains filtered or unexported fields
}

func (RuleEditResponseRule) AsUnion 

func (r RuleEditResponseRule) AsUnion() RuleEditResponseRulesUnion

AsUnion returns a RuleEditResponseRulesUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are BlockRule, RuleEditResponseRulesRulesetsChallengeRule, CompressResponseRule, DDoSDynamicRule, ExecuteRule, ForceConnectionCloseRule, RuleEditResponseRulesRulesetsJSChallengeRule, LogRule, LogCustomFieldRule, ManagedChallengeRule, RedirectRule, RewriteRule, RouteRule, ScoreRule, ServeErrorRule, RuleEditResponseRulesRulesetsSetCacheControlRule, SetCacheSettingsRule, RuleEditResponseRulesRulesetsSetCacheTagsRule, SetConfigRule, SkipRule.

func (*RuleEditResponseRule) UnmarshalJSON 

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

type RuleEditResponseRulesAction 

type RuleEditResponseRulesAction string

The action to perform when the rule matches. 

const (
	RuleEditResponseRulesActionBlock                RuleEditResponseRulesAction = "block"
	RuleEditResponseRulesActionChallenge            RuleEditResponseRulesAction = "challenge"
	RuleEditResponseRulesActionCompressResponse     RuleEditResponseRulesAction = "compress_response"
	RuleEditResponseRulesActionDDoSDynamic          RuleEditResponseRulesAction = "ddos_dynamic"
	RuleEditResponseRulesActionExecute              RuleEditResponseRulesAction = "execute"
	RuleEditResponseRulesActionForceConnectionClose RuleEditResponseRulesAction = "force_connection_close"
	RuleEditResponseRulesActionJSChallenge          RuleEditResponseRulesAction = "js_challenge"
	RuleEditResponseRulesActionLog                  RuleEditResponseRulesAction = "log"
	RuleEditResponseRulesActionLogCustomField       RuleEditResponseRulesAction = "log_custom_field"
	RuleEditResponseRulesActionManagedChallenge     RuleEditResponseRulesAction = "managed_challenge"
	RuleEditResponseRulesActionRedirect             RuleEditResponseRulesAction = "redirect"
	RuleEditResponseRulesActionRewrite              RuleEditResponseRulesAction = "rewrite"
	RuleEditResponseRulesActionRoute                RuleEditResponseRulesAction = "route"
	RuleEditResponseRulesActionScore                RuleEditResponseRulesAction = "score"
	RuleEditResponseRulesActionServeError           RuleEditResponseRulesAction = "serve_error"
	RuleEditResponseRulesActionSetCacheControl      RuleEditResponseRulesAction = "set_cache_control"
	RuleEditResponseRulesActionSetCacheSettings     RuleEditResponseRulesAction = "set_cache_settings"
	RuleEditResponseRulesActionSetCacheTags         RuleEditResponseRulesAction = "set_cache_tags"
	RuleEditResponseRulesActionSetConfig            RuleEditResponseRulesAction = "set_config"
	RuleEditResponseRulesActionSkip                 RuleEditResponseRulesAction = "skip"
)

func (RuleEditResponseRulesAction) IsKnown 

func (r RuleEditResponseRulesAction) IsKnown() bool

type RuleEditResponseRulesRulesetsChallengeRule 

type RuleEditResponseRulesRulesetsChallengeRule struct {
	// The timestamp of when the rule was last modified.
	LastUpdated time.Time `json:"last_updated" api:"required" format:"date-time"`
	// The version of the rule.
	Version string `json:"version" api:"required"`
	// The unique ID of the rule.
	ID string `json:"id"`
	// The action to perform when the rule matches.
	Action RuleEditResponseRulesRulesetsChallengeRuleAction `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters interface{} `json:"action_parameters"`
	// The categories of the rule.
	Categories []string `json:"categories"`
	// An informative description of the rule.
	Description string `json:"description"`
	// Whether the rule should be executed.
	Enabled bool `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck RuleEditResponseRulesRulesetsChallengeRuleExposedCredentialCheck `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression string `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging Logging `json:"logging"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit RuleEditResponseRulesRulesetsChallengeRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                                         `json:"ref"`
	JSON ruleEditResponseRulesRulesetsChallengeRuleJSON `json:"-"`
}

func (*RuleEditResponseRulesRulesetsChallengeRule) UnmarshalJSON 

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

type RuleEditResponseRulesRulesetsChallengeRuleAction 

type RuleEditResponseRulesRulesetsChallengeRuleAction string

The action to perform when the rule matches. 

const (
	RuleEditResponseRulesRulesetsChallengeRuleActionChallenge RuleEditResponseRulesRulesetsChallengeRuleAction = "challenge"
)

func (RuleEditResponseRulesRulesetsChallengeRuleAction) IsKnown 

func (r RuleEditResponseRulesRulesetsChallengeRuleAction) IsKnown() bool

type RuleEditResponseRulesRulesetsChallengeRuleExposedCredentialCheck 

type RuleEditResponseRulesRulesetsChallengeRuleExposedCredentialCheck struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression string `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression string                                                               `json:"username_expression" api:"required"`
	JSON               ruleEditResponseRulesRulesetsChallengeRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*RuleEditResponseRulesRulesetsChallengeRuleExposedCredentialCheck) UnmarshalJSON 

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

type RuleEditResponseRulesRulesetsChallengeRuleRatelimit 

type RuleEditResponseRulesRulesetsChallengeRuleRatelimit struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics []string `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period int64 `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression string `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout int64 `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod int64 `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin bool `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod int64 `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName string                                                  `json:"score_response_header_name"`
	JSON                    ruleEditResponseRulesRulesetsChallengeRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*RuleEditResponseRulesRulesetsChallengeRuleRatelimit) UnmarshalJSON 

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

type RuleEditResponseRulesRulesetsJSChallengeRule 

type RuleEditResponseRulesRulesetsJSChallengeRule struct {
	// The timestamp of when the rule was last modified.
	LastUpdated time.Time `json:"last_updated" api:"required" format:"date-time"`
	// The version of the rule.
	Version string `json:"version" api:"required"`
	// The unique ID of the rule.
	ID string `json:"id"`
	// The action to perform when the rule matches.
	Action RuleEditResponseRulesRulesetsJSChallengeRuleAction `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters interface{} `json:"action_parameters"`
	// The categories of the rule.
	Categories []string `json:"categories"`
	// An informative description of the rule.
	Description string `json:"description"`
	// Whether the rule should be executed.
	Enabled bool `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck RuleEditResponseRulesRulesetsJSChallengeRuleExposedCredentialCheck `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression string `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging Logging `json:"logging"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit RuleEditResponseRulesRulesetsJSChallengeRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                                           `json:"ref"`
	JSON ruleEditResponseRulesRulesetsJSChallengeRuleJSON `json:"-"`
}

func (*RuleEditResponseRulesRulesetsJSChallengeRule) UnmarshalJSON 

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

type RuleEditResponseRulesRulesetsJSChallengeRuleAction 

type RuleEditResponseRulesRulesetsJSChallengeRuleAction string

The action to perform when the rule matches. 

const (
	RuleEditResponseRulesRulesetsJSChallengeRuleActionJSChallenge RuleEditResponseRulesRulesetsJSChallengeRuleAction = "js_challenge"
)

func (RuleEditResponseRulesRulesetsJSChallengeRuleAction) IsKnown 

func (r RuleEditResponseRulesRulesetsJSChallengeRuleAction) IsKnown() bool

type RuleEditResponseRulesRulesetsJSChallengeRuleExposedCredentialCheck 

type RuleEditResponseRulesRulesetsJSChallengeRuleExposedCredentialCheck struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression string `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression string                                                                 `json:"username_expression" api:"required"`
	JSON               ruleEditResponseRulesRulesetsJSChallengeRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*RuleEditResponseRulesRulesetsJSChallengeRuleExposedCredentialCheck) UnmarshalJSON 

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

type RuleEditResponseRulesRulesetsJSChallengeRuleRatelimit 

type RuleEditResponseRulesRulesetsJSChallengeRuleRatelimit struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics []string `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period int64 `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression string `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout int64 `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod int64 `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin bool `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod int64 `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName string                                                    `json:"score_response_header_name"`
	JSON                    ruleEditResponseRulesRulesetsJSChallengeRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*RuleEditResponseRulesRulesetsJSChallengeRuleRatelimit) UnmarshalJSON 

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

type RuleEditResponseRulesRulesetsSetCacheControlRule added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRule struct {
	// The timestamp of when the rule was last modified.
	LastUpdated time.Time `json:"last_updated" api:"required" format:"date-time"`
	// The version of the rule.
	Version string `json:"version" api:"required"`
	// The unique ID of the rule.
	ID string `json:"id"`
	// The action to perform when the rule matches.
	Action RuleEditResponseRulesRulesetsSetCacheControlRuleAction `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters RuleEditResponseRulesRulesetsSetCacheControlRuleActionParameters `json:"action_parameters"`
	// The categories of the rule.
	Categories []string `json:"categories"`
	// An informative description of the rule.
	Description string `json:"description"`
	// Whether the rule should be executed.
	Enabled bool `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck RuleEditResponseRulesRulesetsSetCacheControlRuleExposedCredentialCheck `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression string `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging Logging `json:"logging"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit RuleEditResponseRulesRulesetsSetCacheControlRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                                               `json:"ref"`
	JSON ruleEditResponseRulesRulesetsSetCacheControlRuleJSON `json:"-"`
}

func (*RuleEditResponseRulesRulesetsSetCacheControlRule) UnmarshalJSON added in v6.9.0 

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

type RuleEditResponseRulesRulesetsSetCacheControlRuleAction added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleAction string

The action to perform when the rule matches. 

const (
	RuleEditResponseRulesRulesetsSetCacheControlRuleActionSetCacheControl RuleEditResponseRulesRulesetsSetCacheControlRuleAction = "set_cache_control"
)

func (RuleEditResponseRulesRulesetsSetCacheControlRuleAction) IsKnown added in v6.9.0 

func (r RuleEditResponseRulesRulesetsSetCacheControlRuleAction) IsKnown() bool

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParameters added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParameters struct {
	// A cache-control directive configuration.
	Immutable RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersImmutable `json:"immutable"`
	// A cache-control directive configuration that accepts a duration value in
	// seconds.
	MaxAge RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAge `json:"max-age"`
	// A cache-control directive configuration.
	MustRevalidate RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate `json:"must-revalidate"`
	// A cache-control directive configuration.
	MustUnderstand RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand `json:"must-understand"`
	// A cache-control directive configuration that accepts optional qualifiers (header
	// names).
	NoCache RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoCache `json:"no-cache"`
	// A cache-control directive configuration.
	NoStore RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoStore `json:"no-store"`
	// A cache-control directive configuration.
	NoTransform RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransform `json:"no-transform"`
	// A cache-control directive configuration that accepts optional qualifiers (header
	// names).
	Private RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPrivate `json:"private"`
	// A cache-control directive configuration.
	ProxyRevalidate RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate `json:"proxy-revalidate"`
	// A cache-control directive configuration.
	Public RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPublic `json:"public"`
	// A cache-control directive configuration that accepts a duration value in
	// seconds.
	SMaxage RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxage `json:"s-maxage"`
	// A cache-control directive configuration that accepts a duration value in
	// seconds.
	StaleIfError RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfError `json:"stale-if-error"`
	// A cache-control directive configuration that accepts a duration value in
	// seconds.
	StaleWhileRevalidate RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate `json:"stale-while-revalidate"`
	JSON                 ruleEditResponseRulesRulesetsSetCacheControlRuleActionParametersJSON                 `json:"-"`
}

The parameters configuring the rule's action.

func (*RuleEditResponseRulesRulesetsSetCacheControlRuleActionParameters) UnmarshalJSON added in v6.9.0 

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

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersImmutable added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersImmutable struct {
	// The operation to perform on the cache-control directive.
	Operation RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                          `json:"cloudflare_only"`
	JSON           ruleEditResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration.

func (RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersImmutable) AsUnion added in v6.9.0 

func (r RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersImmutable) AsUnion() RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableUnion

AsUnion returns a RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective, RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective.

func (*RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersImmutable) UnmarshalJSON added in v6.9.0 

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

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation string

The operation to perform on the cache-control directive. 

const (
	RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperationSet    RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation = "set"
	RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperationRemove RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation = "remove"
)

func (RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation) IsKnown added in v6.9.0 

func (r RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation) IsKnown() bool

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                         `json:"cloudflare_only"`
	JSON           ruleEditResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective) UnmarshalJSON added in v6.9.0 

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

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperationSet    RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation = "set"
	RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperationRemove RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation = "remove"
)

func (RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation) IsKnown() bool

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                      `json:"cloudflare_only"`
	JSON           ruleEditResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveJSON `json:"-"`
}

Set the directive.

func (*RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective) UnmarshalJSON added in v6.9.0 

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

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperationSet    RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation = "set"
	RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperationRemove RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation = "remove"
)

func (RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation) IsKnown() bool

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableUnion added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Union satisfied by RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective or RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective.

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAge added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAge struct {
	// The operation to perform on the cache-control directive.
	Operation RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool `json:"cloudflare_only"`
	// The duration value in seconds for the directive.
	Value int64                                                                      `json:"value"`
	JSON  ruleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration that accepts a duration value in seconds.

func (RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAge) AsUnion added in v6.9.0 

func (r RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAge) AsUnion() RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeUnion

AsUnion returns a RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective, RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective.

func (*RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAge) UnmarshalJSON added in v6.9.0 

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

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation string

The operation to perform on the cache-control directive. 

const (
	RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperationSet    RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation = "set"
	RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperationRemove RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation = "remove"
)

func (RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation) IsKnown added in v6.9.0 

func (r RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation) IsKnown() bool

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                      `json:"cloudflare_only"`
	JSON           ruleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective) UnmarshalJSON added in v6.9.0 

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

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperationSet    RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation = "set"
	RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperationRemove RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation = "remove"
)

func (RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation) IsKnown() bool

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation `json:"operation" api:"required"`
	// The duration value in seconds for the directive.
	Value int64 `json:"value" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                   `json:"cloudflare_only"`
	JSON           ruleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveJSON `json:"-"`
}

Set the directive with a duration value in seconds.

func (*RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective) UnmarshalJSON added in v6.9.0 

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

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperationSet    RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation = "set"
	RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperationRemove RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation = "remove"
)

func (RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation) IsKnown() bool

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeUnion added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts a duration value in seconds.

Union satisfied by RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective or RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective.

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate struct {
	// The operation to perform on the cache-control directive.
	Operation RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                               `json:"cloudflare_only"`
	JSON           ruleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration.

func (RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate) AsUnion added in v6.9.0 

func (r RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate) AsUnion() RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateUnion

AsUnion returns a RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective, RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective.

func (*RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate) UnmarshalJSON added in v6.9.0 

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

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation string

The operation to perform on the cache-control directive. 

const (
	RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperationSet    RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation = "set"
	RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperationRemove RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation = "remove"
)

func (RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation) IsKnown added in v6.9.0 

func (r RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation) IsKnown() bool

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                              `json:"cloudflare_only"`
	JSON           ruleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective) UnmarshalJSON added in v6.9.0 

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

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperationSet    RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation = "set"
	RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperationRemove RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation = "remove"
)

func (RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation) IsKnown() bool

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                           `json:"cloudflare_only"`
	JSON           ruleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveJSON `json:"-"`
}

Set the directive.

func (*RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective) UnmarshalJSON added in v6.9.0 

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

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperationSet    RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation = "set"
	RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperationRemove RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation = "remove"
)

func (RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation) IsKnown() bool

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateUnion added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Union satisfied by RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective or RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective.

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand struct {
	// The operation to perform on the cache-control directive.
	Operation RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                               `json:"cloudflare_only"`
	JSON           ruleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration.

func (RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand) AsUnion added in v6.9.0 

func (r RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand) AsUnion() RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandUnion

AsUnion returns a RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective, RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective.

func (*RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand) UnmarshalJSON added in v6.9.0 

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

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation string

The operation to perform on the cache-control directive. 

const (
	RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperationSet    RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation = "set"
	RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperationRemove RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation = "remove"
)

func (RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation) IsKnown added in v6.9.0 

func (r RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation) IsKnown() bool

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                              `json:"cloudflare_only"`
	JSON           ruleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective) UnmarshalJSON added in v6.9.0 

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

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperationSet    RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation = "set"
	RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperationRemove RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation = "remove"
)

func (RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation) IsKnown() bool

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                           `json:"cloudflare_only"`
	JSON           ruleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveJSON `json:"-"`
}

Set the directive.

func (*RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective) UnmarshalJSON added in v6.9.0 

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

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperationSet    RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation = "set"
	RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperationRemove RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation = "remove"
)

func (RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation) IsKnown() bool

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandUnion added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Union satisfied by RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective or RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective.

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoCache added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoCache struct {
	// The operation to perform on the cache-control directive.
	Operation RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool `json:"cloudflare_only"`
	// This field can have the runtime type of [[]string].
	Qualifiers interface{}                                                                 `json:"qualifiers"`
	JSON       ruleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration that accepts optional qualifiers (header names).

func (RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoCache) AsUnion added in v6.9.0 

func (r RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoCache) AsUnion() RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheUnion

AsUnion returns a RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective, RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective.

func (*RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoCache) UnmarshalJSON added in v6.9.0 

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

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation string

The operation to perform on the cache-control directive. 

const (
	RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperationSet    RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation = "set"
	RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperationRemove RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation = "remove"
)

func (RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation) IsKnown added in v6.9.0 

func (r RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation) IsKnown() bool

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                       `json:"cloudflare_only"`
	JSON           ruleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective) UnmarshalJSON added in v6.9.0 

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

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperationSet    RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation = "set"
	RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperationRemove RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation = "remove"
)

func (RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation) IsKnown() bool

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool `json:"cloudflare_only"`
	// Optional list of header names to qualify the directive (e.g., for "private" or
	// "no-cache" directives).
	Qualifiers []string                                                                                `json:"qualifiers"`
	JSON       ruleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveJSON `json:"-"`
}

Set the directive with optional qualifiers.

func (*RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective) UnmarshalJSON added in v6.9.0 

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

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperationSet    RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation = "set"
	RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperationRemove RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation = "remove"
)

func (RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation) IsKnown() bool

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheUnion added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts optional qualifiers (header names).

Union satisfied by RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective or RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective.

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoStore added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoStore struct {
	// The operation to perform on the cache-control directive.
	Operation RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                        `json:"cloudflare_only"`
	JSON           ruleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration.

func (RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoStore) AsUnion added in v6.9.0 

func (r RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoStore) AsUnion() RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreUnion

AsUnion returns a RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective, RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective.

func (*RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoStore) UnmarshalJSON added in v6.9.0 

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

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation string

The operation to perform on the cache-control directive. 

const (
	RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperationSet    RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation = "set"
	RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperationRemove RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation = "remove"
)

func (RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation) IsKnown added in v6.9.0 

func (r RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation) IsKnown() bool

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                       `json:"cloudflare_only"`
	JSON           ruleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective) UnmarshalJSON added in v6.9.0 

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

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperationSet    RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation = "set"
	RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperationRemove RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation = "remove"
)

func (RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation) IsKnown() bool

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                    `json:"cloudflare_only"`
	JSON           ruleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveJSON `json:"-"`
}

Set the directive.

func (*RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective) UnmarshalJSON added in v6.9.0 

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

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperationSet    RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation = "set"
	RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperationRemove RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation = "remove"
)

func (RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation) IsKnown() bool

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreUnion added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Union satisfied by RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective or RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective.

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransform added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransform struct {
	// The operation to perform on the cache-control directive.
	Operation RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                            `json:"cloudflare_only"`
	JSON           ruleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration.

func (RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransform) AsUnion added in v6.9.0 

func (r RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransform) AsUnion() RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformUnion

AsUnion returns a RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective, RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective.

func (*RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransform) UnmarshalJSON added in v6.9.0 

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

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation string

The operation to perform on the cache-control directive. 

const (
	RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperationSet    RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation = "set"
	RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperationRemove RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation = "remove"
)

func (RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation) IsKnown added in v6.9.0 

func (r RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation) IsKnown() bool

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                           `json:"cloudflare_only"`
	JSON           ruleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective) UnmarshalJSON added in v6.9.0 

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

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperationSet    RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation = "set"
	RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperationRemove RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation = "remove"
)

func (RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation) IsKnown() bool

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                        `json:"cloudflare_only"`
	JSON           ruleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveJSON `json:"-"`
}

Set the directive.

func (*RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective) UnmarshalJSON added in v6.9.0 

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

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperationSet    RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation = "set"
	RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperationRemove RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation = "remove"
)

func (RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation) IsKnown() bool

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformUnion added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Union satisfied by RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective or RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective.

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPrivate added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPrivate struct {
	// The operation to perform on the cache-control directive.
	Operation RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool `json:"cloudflare_only"`
	// This field can have the runtime type of [[]string].
	Qualifiers interface{}                                                                 `json:"qualifiers"`
	JSON       ruleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration that accepts optional qualifiers (header names).

func (RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPrivate) AsUnion added in v6.9.0 

func (r RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPrivate) AsUnion() RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateUnion

AsUnion returns a RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective, RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective.

func (*RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPrivate) UnmarshalJSON added in v6.9.0 

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

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation string

The operation to perform on the cache-control directive. 

const (
	RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperationSet    RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation = "set"
	RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperationRemove RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation = "remove"
)

func (RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation) IsKnown added in v6.9.0 

func (r RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation) IsKnown() bool

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                       `json:"cloudflare_only"`
	JSON           ruleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective) UnmarshalJSON added in v6.9.0 

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

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperationSet    RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation = "set"
	RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperationRemove RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation = "remove"
)

func (RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation) IsKnown() bool

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool `json:"cloudflare_only"`
	// Optional list of header names to qualify the directive (e.g., for "private" or
	// "no-cache" directives).
	Qualifiers []string                                                                                `json:"qualifiers"`
	JSON       ruleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveJSON `json:"-"`
}

Set the directive with optional qualifiers.

func (*RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective) UnmarshalJSON added in v6.9.0 

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

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperationSet    RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation = "set"
	RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperationRemove RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation = "remove"
)

func (RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation) IsKnown() bool

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateUnion added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts optional qualifiers (header names).

Union satisfied by RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective or RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective.

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate struct {
	// The operation to perform on the cache-control directive.
	Operation RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                `json:"cloudflare_only"`
	JSON           ruleEditResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration.

func (RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate) AsUnion added in v6.9.0 

func (r RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate) AsUnion() RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateUnion

AsUnion returns a RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective, RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective.

func (*RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate) UnmarshalJSON added in v6.9.0 

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

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation string

The operation to perform on the cache-control directive. 

const (
	RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperationSet    RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation = "set"
	RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperationRemove RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation = "remove"
)

func (RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation) IsKnown added in v6.9.0 

func (r RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation) IsKnown() bool

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                               `json:"cloudflare_only"`
	JSON           ruleEditResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective) UnmarshalJSON added in v6.9.0 

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

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperationSet    RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation = "set"
	RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperationRemove RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation = "remove"
)

func (RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation) IsKnown() bool

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                            `json:"cloudflare_only"`
	JSON           ruleEditResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveJSON `json:"-"`
}

Set the directive.

func (*RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective) UnmarshalJSON added in v6.9.0 

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

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperationSet    RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation = "set"
	RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperationRemove RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation = "remove"
)

func (RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation) IsKnown() bool

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateUnion added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Union satisfied by RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective or RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective.

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPublic added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPublic struct {
	// The operation to perform on the cache-control directive.
	Operation RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                       `json:"cloudflare_only"`
	JSON           ruleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPublicJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration.

func (RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPublic) AsUnion added in v6.9.0 

func (r RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPublic) AsUnion() RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPublicUnion

AsUnion returns a RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPublicUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective, RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective.

func (*RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPublic) UnmarshalJSON added in v6.9.0 

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

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation string

The operation to perform on the cache-control directive. 

const (
	RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperationSet    RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation = "set"
	RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperationRemove RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation = "remove"
)

func (RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation) IsKnown added in v6.9.0 

func (r RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation) IsKnown() bool

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                      `json:"cloudflare_only"`
	JSON           ruleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective) UnmarshalJSON added in v6.9.0 

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

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperationSet    RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation = "set"
	RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperationRemove RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation = "remove"
)

func (RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation) IsKnown() bool

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                   `json:"cloudflare_only"`
	JSON           ruleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveJSON `json:"-"`
}

Set the directive.

func (*RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective) UnmarshalJSON added in v6.9.0 

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

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperationSet    RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation = "set"
	RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperationRemove RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation = "remove"
)

func (RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation) IsKnown() bool

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPublicUnion added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPublicUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Union satisfied by RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective or RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective.

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxage added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxage struct {
	// The operation to perform on the cache-control directive.
	Operation RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool `json:"cloudflare_only"`
	// The duration value in seconds for the directive.
	Value int64                                                                       `json:"value"`
	JSON  ruleEditResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration that accepts a duration value in seconds.

func (RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxage) AsUnion added in v6.9.0 

func (r RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxage) AsUnion() RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageUnion

AsUnion returns a RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective, RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective.

func (*RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxage) UnmarshalJSON added in v6.9.0 

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

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation string

The operation to perform on the cache-control directive. 

const (
	RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperationSet    RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation = "set"
	RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperationRemove RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation = "remove"
)

func (RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation) IsKnown added in v6.9.0 

func (r RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation) IsKnown() bool

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                       `json:"cloudflare_only"`
	JSON           ruleEditResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective) UnmarshalJSON added in v6.9.0 

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

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperationSet    RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation = "set"
	RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperationRemove RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation = "remove"
)

func (RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation) IsKnown() bool

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation `json:"operation" api:"required"`
	// The duration value in seconds for the directive.
	Value int64 `json:"value" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                    `json:"cloudflare_only"`
	JSON           ruleEditResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveJSON `json:"-"`
}

Set the directive with a duration value in seconds.

func (*RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective) UnmarshalJSON added in v6.9.0 

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

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperationSet    RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation = "set"
	RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperationRemove RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation = "remove"
)

func (RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation) IsKnown() bool

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageUnion added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts a duration value in seconds.

Union satisfied by RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective or RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective.

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfError added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfError struct {
	// The operation to perform on the cache-control directive.
	Operation RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool `json:"cloudflare_only"`
	// The duration value in seconds for the directive.
	Value int64                                                                            `json:"value"`
	JSON  ruleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration that accepts a duration value in seconds.

func (RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfError) AsUnion added in v6.9.0 

func (r RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfError) AsUnion() RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorUnion

AsUnion returns a RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective, RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective.

func (*RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfError) UnmarshalJSON added in v6.9.0 

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

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation string

The operation to perform on the cache-control directive. 

const (
	RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperationSet    RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation = "set"
	RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperationRemove RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation = "remove"
)

func (RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation) IsKnown added in v6.9.0 

func (r RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation) IsKnown() bool

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                            `json:"cloudflare_only"`
	JSON           ruleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective) UnmarshalJSON added in v6.9.0 

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

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperationSet    RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation = "set"
	RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperationRemove RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation = "remove"
)

func (RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation) IsKnown() bool

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation `json:"operation" api:"required"`
	// The duration value in seconds for the directive.
	Value int64 `json:"value" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                         `json:"cloudflare_only"`
	JSON           ruleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveJSON `json:"-"`
}

Set the directive with a duration value in seconds.

func (*RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective) UnmarshalJSON added in v6.9.0 

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

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperationSet    RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation = "set"
	RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperationRemove RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation = "remove"
)

func (RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation) IsKnown() bool

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorUnion added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts a duration value in seconds.

Union satisfied by RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective or RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective.

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate struct {
	// The operation to perform on the cache-control directive.
	Operation RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool `json:"cloudflare_only"`
	// The duration value in seconds for the directive.
	Value int64                                                                                    `json:"value"`
	JSON  ruleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration that accepts a duration value in seconds.

func (RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate) AsUnion added in v6.9.0 

func (r RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate) AsUnion() RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateUnion

AsUnion returns a RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective, RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective.

func (*RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate) UnmarshalJSON added in v6.9.0 

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

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation string

The operation to perform on the cache-control directive. 

const (
	RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperationSet    RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation = "set"
	RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperationRemove RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation = "remove"
)

func (RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation) IsKnown added in v6.9.0 

func (r RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation) IsKnown() bool

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                                    `json:"cloudflare_only"`
	JSON           ruleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective) UnmarshalJSON added in v6.9.0 

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

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperationSet    RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation = "set"
	RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperationRemove RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation = "remove"
)

func (RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation) IsKnown() bool

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation `json:"operation" api:"required"`
	// The duration value in seconds for the directive.
	Value int64 `json:"value" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                                 `json:"cloudflare_only"`
	JSON           ruleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveJSON `json:"-"`
}

Set the directive with a duration value in seconds.

func (*RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective) UnmarshalJSON added in v6.9.0 

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

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperationSet    RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation = "set"
	RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperationRemove RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation = "remove"
)

func (RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation) IsKnown() bool

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateUnion added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts a duration value in seconds.

Union satisfied by RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective or RuleEditResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective.

type RuleEditResponseRulesRulesetsSetCacheControlRuleExposedCredentialCheck added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleExposedCredentialCheck struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression string `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression string                                                                     `json:"username_expression" api:"required"`
	JSON               ruleEditResponseRulesRulesetsSetCacheControlRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*RuleEditResponseRulesRulesetsSetCacheControlRuleExposedCredentialCheck) UnmarshalJSON added in v6.9.0 

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

type RuleEditResponseRulesRulesetsSetCacheControlRuleRatelimit added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheControlRuleRatelimit struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics []string `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period int64 `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression string `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout int64 `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod int64 `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin bool `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod int64 `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName string                                                        `json:"score_response_header_name"`
	JSON                    ruleEditResponseRulesRulesetsSetCacheControlRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*RuleEditResponseRulesRulesetsSetCacheControlRuleRatelimit) UnmarshalJSON added in v6.9.0 

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

type RuleEditResponseRulesRulesetsSetCacheTagsRule added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheTagsRule struct {
	// The timestamp of when the rule was last modified.
	LastUpdated time.Time `json:"last_updated" api:"required" format:"date-time"`
	// The version of the rule.
	Version string `json:"version" api:"required"`
	// The unique ID of the rule.
	ID string `json:"id"`
	// The action to perform when the rule matches.
	Action RuleEditResponseRulesRulesetsSetCacheTagsRuleAction `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParameters `json:"action_parameters"`
	// The categories of the rule.
	Categories []string `json:"categories"`
	// An informative description of the rule.
	Description string `json:"description"`
	// Whether the rule should be executed.
	Enabled bool `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck RuleEditResponseRulesRulesetsSetCacheTagsRuleExposedCredentialCheck `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression string `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging Logging `json:"logging"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit RuleEditResponseRulesRulesetsSetCacheTagsRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                                            `json:"ref"`
	JSON ruleEditResponseRulesRulesetsSetCacheTagsRuleJSON `json:"-"`
}

func (*RuleEditResponseRulesRulesetsSetCacheTagsRule) UnmarshalJSON added in v6.9.0 

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

type RuleEditResponseRulesRulesetsSetCacheTagsRuleAction added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheTagsRuleAction string

The action to perform when the rule matches. 

const (
	RuleEditResponseRulesRulesetsSetCacheTagsRuleActionSetCacheTags RuleEditResponseRulesRulesetsSetCacheTagsRuleAction = "set_cache_tags"
)

func (RuleEditResponseRulesRulesetsSetCacheTagsRuleAction) IsKnown added in v6.9.0 

func (r RuleEditResponseRulesRulesetsSetCacheTagsRuleAction) IsKnown() bool

type RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParameters added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParameters struct {
	// The operation to perform on the cache tags.
	Operation RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation `json:"operation" api:"required"`
	// An expression that evaluates to an array of cache tag values.
	Expression string `json:"expression"`
	// This field can have the runtime type of [[]string].
	Values interface{}                                                       `json:"values"`
	JSON   ruleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersJSON `json:"-"`
	// contains filtered or unexported fields
}

The parameters configuring the rule's action.

func (RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParameters) AsUnion added in v6.9.0 

func (r RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParameters) AsUnion() RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersUnion

AsUnion returns a RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues, RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression, RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues, RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression, RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues, RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression.

func (*RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParameters) UnmarshalJSON added in v6.9.0 

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

type RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression struct {
	// An expression that evaluates to an array of cache tag values.
	Expression string `json:"expression" api:"required"`
	// The operation to perform on the cache tags.
	Operation RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation `json:"operation" api:"required"`
	JSON      ruleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionJSON      `json:"-"`
}

Add cache tags using an expression.

func (*RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression) UnmarshalJSON added in v6.9.0 

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

type RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation string

The operation to perform on the cache tags. 

const (
	RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationAdd    RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "add"
	RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationRemove RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "remove"
	RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationSet    RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "set"
)

func (RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation) IsKnown added in v6.9.0 

func (r RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation) IsKnown() bool

type RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues struct {
	// The operation to perform on the cache tags.
	Operation RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation `json:"operation" api:"required"`
	// A list of cache tag values.
	Values []string                                                                            `json:"values" api:"required"`
	JSON   ruleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesJSON `json:"-"`
}

Add cache tags using a list of values.

func (*RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues) UnmarshalJSON added in v6.9.0 

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

type RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation string

The operation to perform on the cache tags. 

const (
	RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationAdd    RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "add"
	RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationRemove RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "remove"
	RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationSet    RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "set"
)

func (RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation) IsKnown added in v6.9.0 

func (r RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation) IsKnown() bool

type RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation string

The operation to perform on the cache tags. 

const (
	RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersOperationAdd    RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation = "add"
	RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersOperationRemove RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation = "remove"
	RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersOperationSet    RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation = "set"
)

func (RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation) IsKnown added in v6.9.0 

func (r RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation) IsKnown() bool

type RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression struct {
	// An expression that evaluates to an array of cache tag values.
	Expression string `json:"expression" api:"required"`
	// The operation to perform on the cache tags.
	Operation RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation `json:"operation" api:"required"`
	JSON      ruleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionJSON      `json:"-"`
}

Remove cache tags using an expression.

func (*RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression) UnmarshalJSON added in v6.9.0 

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

type RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation string

The operation to perform on the cache tags. 

const (
	RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationAdd    RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "add"
	RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationRemove RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "remove"
	RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationSet    RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "set"
)

func (RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation) IsKnown added in v6.9.0 

func (r RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation) IsKnown() bool

type RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues struct {
	// The operation to perform on the cache tags.
	Operation RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation `json:"operation" api:"required"`
	// A list of cache tag values.
	Values []string                                                                               `json:"values" api:"required"`
	JSON   ruleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesJSON `json:"-"`
}

Remove cache tags using a list of values.

func (*RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues) UnmarshalJSON added in v6.9.0 

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

type RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation string

The operation to perform on the cache tags. 

const (
	RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationAdd    RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "add"
	RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationRemove RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "remove"
	RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationSet    RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "set"
)

func (RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation) IsKnown added in v6.9.0 

func (r RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation) IsKnown() bool

type RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression struct {
	// An expression that evaluates to an array of cache tag values.
	Expression string `json:"expression" api:"required"`
	// The operation to perform on the cache tags.
	Operation RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation `json:"operation" api:"required"`
	JSON      ruleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionJSON      `json:"-"`
}

Set cache tags using an expression.

func (*RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression) UnmarshalJSON added in v6.9.0 

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

type RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation string

The operation to perform on the cache tags. 

const (
	RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationAdd    RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "add"
	RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationRemove RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "remove"
	RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationSet    RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "set"
)

func (RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation) IsKnown added in v6.9.0 

func (r RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation) IsKnown() bool

type RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues struct {
	// The operation to perform on the cache tags.
	Operation RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation `json:"operation" api:"required"`
	// A list of cache tag values.
	Values []string                                                                            `json:"values" api:"required"`
	JSON   ruleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesJSON `json:"-"`
}

Set cache tags using a list of values.

func (*RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues) UnmarshalJSON added in v6.9.0 

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

type RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation string

The operation to perform on the cache tags. 

const (
	RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationAdd    RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "add"
	RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationRemove RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "remove"
	RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationSet    RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "set"
)

func (RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation) IsKnown added in v6.9.0 

func (r RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation) IsKnown() bool

type RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersUnion added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersUnion interface {
	// contains filtered or unexported methods
}

The parameters configuring the rule's action.

Union satisfied by RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues, RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression, RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues, RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression, RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues or RuleEditResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression.

type RuleEditResponseRulesRulesetsSetCacheTagsRuleExposedCredentialCheck added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheTagsRuleExposedCredentialCheck struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression string `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression string                                                                  `json:"username_expression" api:"required"`
	JSON               ruleEditResponseRulesRulesetsSetCacheTagsRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*RuleEditResponseRulesRulesetsSetCacheTagsRuleExposedCredentialCheck) UnmarshalJSON added in v6.9.0 

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

type RuleEditResponseRulesRulesetsSetCacheTagsRuleRatelimit added in v6.9.0 

type RuleEditResponseRulesRulesetsSetCacheTagsRuleRatelimit struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics []string `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period int64 `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression string `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout int64 `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod int64 `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin bool `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod int64 `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName string                                                     `json:"score_response_header_name"`
	JSON                    ruleEditResponseRulesRulesetsSetCacheTagsRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*RuleEditResponseRulesRulesetsSetCacheTagsRuleRatelimit) UnmarshalJSON added in v6.9.0 

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

type RuleEditResponseRulesUnion 

type RuleEditResponseRulesUnion interface {
	// contains filtered or unexported methods
}

Union satisfied by BlockRule, RuleEditResponseRulesRulesetsChallengeRule, CompressResponseRule, DDoSDynamicRule, ExecuteRule, ForceConnectionCloseRule, RuleEditResponseRulesRulesetsJSChallengeRule, LogRule, LogCustomFieldRule, ManagedChallengeRule, RedirectRule, RewriteRule, RouteRule, ScoreRule, ServeErrorRule, RuleEditResponseRulesRulesetsSetCacheControlRule, SetCacheSettingsRule, RuleEditResponseRulesRulesetsSetCacheTagsRule, SetConfigRule or SkipRule.

type RuleNewParams 

type RuleNewParams struct {
	Body RuleNewParamsBodyUnion `json:"body" api:"required"`
	// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
	AccountID param.Field[string] `path:"account_id"`
	// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
	ZoneID param.Field[string] `path:"zone_id"`
}

func (RuleNewParams) MarshalJSON 

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

type RuleNewParamsBody 

type RuleNewParamsBody struct {
	// The unique ID of the rule.
	ID param.Field[string] `json:"id"`
	// The action to perform when the rule matches.
	Action           param.Field[RuleNewParamsBodyAction] `json:"action"`
	ActionParameters param.Field[interface{}]             `json:"action_parameters"`
	Categories       param.Field[interface{}]             `json:"categories"`
	// An informative description of the rule.
	Description param.Field[string] `json:"description"`
	// Whether the rule should be executed.
	Enabled                param.Field[bool]        `json:"enabled"`
	ExposedCredentialCheck param.Field[interface{}] `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression param.Field[string] `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging   param.Field[LoggingParam] `json:"logging"`
	Position  param.Field[interface{}]  `json:"position"`
	Ratelimit param.Field[interface{}]  `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref param.Field[string] `json:"ref"`
}

func (RuleNewParamsBody) MarshalJSON 

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

type RuleNewParamsBodyAction 

type RuleNewParamsBodyAction string

The action to perform when the rule matches. 

const (
	RuleNewParamsBodyActionBlock                RuleNewParamsBodyAction = "block"
	RuleNewParamsBodyActionChallenge            RuleNewParamsBodyAction = "challenge"
	RuleNewParamsBodyActionCompressResponse     RuleNewParamsBodyAction = "compress_response"
	RuleNewParamsBodyActionDDoSDynamic          RuleNewParamsBodyAction = "ddos_dynamic"
	RuleNewParamsBodyActionExecute              RuleNewParamsBodyAction = "execute"
	RuleNewParamsBodyActionForceConnectionClose RuleNewParamsBodyAction = "force_connection_close"
	RuleNewParamsBodyActionJSChallenge          RuleNewParamsBodyAction = "js_challenge"
	RuleNewParamsBodyActionLog                  RuleNewParamsBodyAction = "log"
	RuleNewParamsBodyActionLogCustomField       RuleNewParamsBodyAction = "log_custom_field"
	RuleNewParamsBodyActionManagedChallenge     RuleNewParamsBodyAction = "managed_challenge"
	RuleNewParamsBodyActionRedirect             RuleNewParamsBodyAction = "redirect"
	RuleNewParamsBodyActionRewrite              RuleNewParamsBodyAction = "rewrite"
	RuleNewParamsBodyActionRoute                RuleNewParamsBodyAction = "route"
	RuleNewParamsBodyActionScore                RuleNewParamsBodyAction = "score"
	RuleNewParamsBodyActionServeError           RuleNewParamsBodyAction = "serve_error"
	RuleNewParamsBodyActionSetCacheControl      RuleNewParamsBodyAction = "set_cache_control"
	RuleNewParamsBodyActionSetCacheSettings     RuleNewParamsBodyAction = "set_cache_settings"
	RuleNewParamsBodyActionSetCacheTags         RuleNewParamsBodyAction = "set_cache_tags"
	RuleNewParamsBodyActionSetConfig            RuleNewParamsBodyAction = "set_config"
	RuleNewParamsBodyActionSkip                 RuleNewParamsBodyAction = "skip"
)

func (RuleNewParamsBodyAction) IsKnown 

func (r RuleNewParamsBodyAction) IsKnown() bool

type RuleNewParamsBodyBlockRule 

type RuleNewParamsBodyBlockRule struct {
	// An object configuring where the rule will be placed.
	Position param.Field[RuleNewParamsBodyBlockRulePositionUnion] `json:"position"`
	BlockRuleParam
}

func (RuleNewParamsBodyBlockRule) MarshalJSON 

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

type RuleNewParamsBodyBlockRulePosition 

type RuleNewParamsBodyBlockRulePosition struct {
	// The ID of another rule to place the rule after. An empty value causes the rule
	// to be placed at the bottom.
	After param.Field[string] `json:"after"`
	// The ID of another rule to place the rule before. An empty value causes the rule
	// to be placed at the top.
	Before param.Field[string] `json:"before"`
	// An index at which to place the rule, where index 1 is the first rule.
	Index param.Field[int64] `json:"index"`
}

An object configuring where the rule will be placed.

func (RuleNewParamsBodyBlockRulePosition) MarshalJSON 

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

type RuleNewParamsBodyBlockRulePositionAfterPosition 

type RuleNewParamsBodyBlockRulePositionAfterPosition struct {
	// The ID of another rule to place the rule after. An empty value causes the rule
	// to be placed at the bottom.
	After param.Field[string] `json:"after"`
}

An object configuring where the rule will be placed.

func (RuleNewParamsBodyBlockRulePositionAfterPosition) MarshalJSON 

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

type RuleNewParamsBodyBlockRulePositionBeforePosition 

type RuleNewParamsBodyBlockRulePositionBeforePosition struct {
	// The ID of another rule to place the rule before. An empty value causes the rule
	// to be placed at the top.
	Before param.Field[string] `json:"before"`
}

An object configuring where the rule will be placed.

func (RuleNewParamsBodyBlockRulePositionBeforePosition) MarshalJSON 

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

type RuleNewParamsBodyBlockRulePositionIndexPosition 

type RuleNewParamsBodyBlockRulePositionIndexPosition struct {
	// An index at which to place the rule, where index 1 is the first rule.
	Index param.Field[int64] `json:"index"`
}

An object configuring where the rule will be placed.

func (RuleNewParamsBodyBlockRulePositionIndexPosition) MarshalJSON 

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

type RuleNewParamsBodyBlockRulePositionUnion 

type RuleNewParamsBodyBlockRulePositionUnion interface {
	// contains filtered or unexported methods
}

An object configuring where the rule will be placed.

Satisfied by rulesets.RuleNewParamsBodyBlockRulePositionBeforePosition, rulesets.RuleNewParamsBodyBlockRulePositionAfterPosition, rulesets.RuleNewParamsBodyBlockRulePositionIndexPosition, RuleNewParamsBodyBlockRulePosition.

type RuleNewParamsBodyChallengeRule 

type RuleNewParamsBodyChallengeRule struct {
	// The unique ID of the rule.
	ID param.Field[string] `json:"id"`
	// The action to perform when the rule matches.
	Action param.Field[RuleNewParamsBodyChallengeRuleAction] `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters param.Field[interface{}] `json:"action_parameters"`
	// An informative description of the rule.
	Description param.Field[string] `json:"description"`
	// Whether the rule should be executed.
	Enabled param.Field[bool] `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck param.Field[RuleNewParamsBodyChallengeRuleExposedCredentialCheck] `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression param.Field[string] `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging param.Field[LoggingParam] `json:"logging"`
	// An object configuring where the rule will be placed.
	Position param.Field[RuleNewParamsBodyChallengeRulePositionUnion] `json:"position"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit param.Field[RuleNewParamsBodyChallengeRuleRatelimit] `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref param.Field[string] `json:"ref"`
}

func (RuleNewParamsBodyChallengeRule) MarshalJSON 

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

type RuleNewParamsBodyChallengeRuleAction 

type RuleNewParamsBodyChallengeRuleAction string

The action to perform when the rule matches. 

const (
	RuleNewParamsBodyChallengeRuleActionChallenge RuleNewParamsBodyChallengeRuleAction = "challenge"
)

func (RuleNewParamsBodyChallengeRuleAction) IsKnown 

func (r RuleNewParamsBodyChallengeRuleAction) IsKnown() bool

type RuleNewParamsBodyChallengeRuleExposedCredentialCheck 

type RuleNewParamsBodyChallengeRuleExposedCredentialCheck struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression param.Field[string] `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression param.Field[string] `json:"username_expression" api:"required"`
}

Configuration for exposed credential checking.

func (RuleNewParamsBodyChallengeRuleExposedCredentialCheck) MarshalJSON 

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

type RuleNewParamsBodyChallengeRulePosition 

type RuleNewParamsBodyChallengeRulePosition struct {
	// The ID of another rule to place the rule after. An empty value causes the rule
	// to be placed at the bottom.
	After param.Field[string] `json:"after"`
	// The ID of another rule to place the rule before. An empty value causes the rule
	// to be placed at the top.
	Before param.Field[string] `json:"before"`
	// An index at which to place the rule, where index 1 is the first rule.
	Index param.Field[int64] `json:"index"`
}

An object configuring where the rule will be placed.

func (RuleNewParamsBodyChallengeRulePosition) MarshalJSON 

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

type RuleNewParamsBodyChallengeRulePositionAfterPosition 

type RuleNewParamsBodyChallengeRulePositionAfterPosition struct {
	// The ID of another rule to place the rule after. An empty value causes the rule
	// to be placed at the bottom.
	After param.Field[string] `json:"after"`
}

An object configuring where the rule will be placed.

func (RuleNewParamsBodyChallengeRulePositionAfterPosition) MarshalJSON 

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

type RuleNewParamsBodyChallengeRulePositionBeforePosition 

type RuleNewParamsBodyChallengeRulePositionBeforePosition struct {
	// The ID of another rule to place the rule before. An empty value causes the rule
	// to be placed at the top.
	Before param.Field[string] `json:"before"`
}

An object configuring where the rule will be placed.

func (RuleNewParamsBodyChallengeRulePositionBeforePosition) MarshalJSON 

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

type RuleNewParamsBodyChallengeRulePositionIndexPosition 

type RuleNewParamsBodyChallengeRulePositionIndexPosition struct {
	// An index at which to place the rule, where index 1 is the first rule.
	Index param.Field[int64] `json:"index"`
}

An object configuring where the rule will be placed.

func (RuleNewParamsBodyChallengeRulePositionIndexPosition) MarshalJSON 

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

type RuleNewParamsBodyChallengeRulePositionUnion 

type RuleNewParamsBodyChallengeRulePositionUnion interface {
	// contains filtered or unexported methods
}

An object configuring where the rule will be placed.

Satisfied by rulesets.RuleNewParamsBodyChallengeRulePositionBeforePosition, rulesets.RuleNewParamsBodyChallengeRulePositionAfterPosition, rulesets.RuleNewParamsBodyChallengeRulePositionIndexPosition, RuleNewParamsBodyChallengeRulePosition.

type RuleNewParamsBodyChallengeRuleRatelimit 

type RuleNewParamsBodyChallengeRuleRatelimit struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics param.Field[[]string] `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period param.Field[int64] `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression param.Field[string] `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout param.Field[int64] `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod param.Field[int64] `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin param.Field[bool] `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod param.Field[int64] `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName param.Field[string] `json:"score_response_header_name"`
}

An object configuring the rule's rate limit behavior.

func (RuleNewParamsBodyChallengeRuleRatelimit) MarshalJSON 

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

type RuleNewParamsBodyDDoSDynamicRule 

type RuleNewParamsBodyDDoSDynamicRule struct {
	// An object configuring where the rule will be placed.
	Position param.Field[RuleNewParamsBodyDDoSDynamicRulePositionUnion] `json:"position"`
	DDoSDynamicRuleParam
}

func (RuleNewParamsBodyDDoSDynamicRule) MarshalJSON 

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

type RuleNewParamsBodyDDoSDynamicRulePosition 

type RuleNewParamsBodyDDoSDynamicRulePosition struct {
	// The ID of another rule to place the rule after. An empty value causes the rule
	// to be placed at the bottom.
	After param.Field[string] `json:"after"`
	// The ID of another rule to place the rule before. An empty value causes the rule
	// to be placed at the top.
	Before param.Field[string] `json:"before"`
	// An index at which to place the rule, where index 1 is the first rule.
	Index param.Field[int64] `json:"index"`
}

An object configuring where the rule will be placed.

func (RuleNewParamsBodyDDoSDynamicRulePosition) MarshalJSON 

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

type RuleNewParamsBodyDDoSDynamicRulePositionAfterPosition 

type RuleNewParamsBodyDDoSDynamicRulePositionAfterPosition struct {
	// The ID of another rule to place the rule after. An empty value causes the rule
	// to be placed at the bottom.
	After param.Field[string] `json:"after"`
}

An object configuring where the rule will be placed.

func (RuleNewParamsBodyDDoSDynamicRulePositionAfterPosition) MarshalJSON 

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

type RuleNewParamsBodyDDoSDynamicRulePositionBeforePosition 

type RuleNewParamsBodyDDoSDynamicRulePositionBeforePosition struct {
	// The ID of another rule to place the rule before. An empty value causes the rule
	// to be placed at the top.
	Before param.Field[string] `json:"before"`
}

An object configuring where the rule will be placed.

func (RuleNewParamsBodyDDoSDynamicRulePositionBeforePosition) MarshalJSON 

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

type RuleNewParamsBodyDDoSDynamicRulePositionIndexPosition 

type RuleNewParamsBodyDDoSDynamicRulePositionIndexPosition struct {
	// An index at which to place the rule, where index 1 is the first rule.
	Index param.Field[int64] `json:"index"`
}

An object configuring where the rule will be placed.

func (RuleNewParamsBodyDDoSDynamicRulePositionIndexPosition) MarshalJSON 

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

type RuleNewParamsBodyDDoSDynamicRulePositionUnion 

type RuleNewParamsBodyDDoSDynamicRulePositionUnion interface {
	// contains filtered or unexported methods
}

An object configuring where the rule will be placed.

Satisfied by rulesets.RuleNewParamsBodyDDoSDynamicRulePositionBeforePosition, rulesets.RuleNewParamsBodyDDoSDynamicRulePositionAfterPosition, rulesets.RuleNewParamsBodyDDoSDynamicRulePositionIndexPosition, RuleNewParamsBodyDDoSDynamicRulePosition.

type RuleNewParamsBodyExecuteRule 

type RuleNewParamsBodyExecuteRule struct {
	// An object configuring where the rule will be placed.
	Position param.Field[RuleNewParamsBodyExecuteRulePositionUnion] `json:"position"`
	ExecuteRuleParam
}

func (RuleNewParamsBodyExecuteRule) MarshalJSON 

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

type RuleNewParamsBodyExecuteRulePosition 

type RuleNewParamsBodyExecuteRulePosition struct {
	// The ID of another rule to place the rule after. An empty value causes the rule
	// to be placed at the bottom.
	After param.Field[string] `json:"after"`
	// The ID of another rule to place the rule before. An empty value causes the rule
	// to be placed at the top.
	Before param.Field[string] `json:"before"`
	// An index at which to place the rule, where index 1 is the first rule.
	Index param.Field[int64] `json:"index"`
}

An object configuring where the rule will be placed.

func (RuleNewParamsBodyExecuteRulePosition) MarshalJSON 

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

type RuleNewParamsBodyExecuteRulePositionAfterPosition 

type RuleNewParamsBodyExecuteRulePositionAfterPosition struct {
	// The ID of another rule to place the rule after. An empty value causes the rule
	// to be placed at the bottom.
	After param.Field[string] `json:"after"`
}

An object configuring where the rule will be placed.

func (RuleNewParamsBodyExecuteRulePositionAfterPosition) MarshalJSON 

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

type RuleNewParamsBodyExecuteRulePositionBeforePosition 

type RuleNewParamsBodyExecuteRulePositionBeforePosition struct {
	// The ID of another rule to place the rule before. An empty value causes the rule
	// to be placed at the top.
	Before param.Field[string] `json:"before"`
}

An object configuring where the rule will be placed.

func (RuleNewParamsBodyExecuteRulePositionBeforePosition) MarshalJSON 

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

type RuleNewParamsBodyExecuteRulePositionIndexPosition 

type RuleNewParamsBodyExecuteRulePositionIndexPosition struct {
	// An index at which to place the rule, where index 1 is the first rule.
	Index param.Field[int64] `json:"index"`
}

An object configuring where the rule will be placed.

func (RuleNewParamsBodyExecuteRulePositionIndexPosition) MarshalJSON 

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

type RuleNewParamsBodyExecuteRulePositionUnion 

type RuleNewParamsBodyExecuteRulePositionUnion interface {
	// contains filtered or unexported methods
}

An object configuring where the rule will be placed.

Satisfied by rulesets.RuleNewParamsBodyExecuteRulePositionBeforePosition, rulesets.RuleNewParamsBodyExecuteRulePositionAfterPosition, rulesets.RuleNewParamsBodyExecuteRulePositionIndexPosition, RuleNewParamsBodyExecuteRulePosition.

type RuleNewParamsBodyForceConnectionCloseRule 

type RuleNewParamsBodyForceConnectionCloseRule struct {
	// An object configuring where the rule will be placed.
	Position param.Field[RuleNewParamsBodyForceConnectionCloseRulePositionUnion] `json:"position"`
	ForceConnectionCloseRuleParam
}

func (RuleNewParamsBodyForceConnectionCloseRule) MarshalJSON 

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

type RuleNewParamsBodyForceConnectionCloseRulePosition 

type RuleNewParamsBodyForceConnectionCloseRulePosition struct {
	// The ID of another rule to place the rule after. An empty value causes the rule
	// to be placed at the bottom.
	After param.Field[string] `json:"after"`
	// The ID of another rule to place the rule before. An empty value causes the rule
	// to be placed at the top.
	Before param.Field[string] `json:"before"`
	// An index at which to place the rule, where index 1 is the first rule.
	Index param.Field[int64] `json:"index"`
}

An object configuring where the rule will be placed.

func (RuleNewParamsBodyForceConnectionCloseRulePosition) MarshalJSON 

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

type RuleNewParamsBodyForceConnectionCloseRulePositionAfterPosition 

type RuleNewParamsBodyForceConnectionCloseRulePositionAfterPosition struct {
	// The ID of another rule to place the rule after. An empty value causes the rule
	// to be placed at the bottom.
	After param.Field[string] `json:"after"`
}

An object configuring where the rule will be placed.

func (RuleNewParamsBodyForceConnectionCloseRulePositionAfterPosition) MarshalJSON 

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

type RuleNewParamsBodyForceConnectionCloseRulePositionBeforePosition 

type RuleNewParamsBodyForceConnectionCloseRulePositionBeforePosition struct {
	// The ID of another rule to place the rule before. An empty value causes the rule
	// to be placed at the top.
	Before param.Field[string] `json:"before"`
}

An object configuring where the rule will be placed.

func (RuleNewParamsBodyForceConnectionCloseRulePositionBeforePosition) MarshalJSON 

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

type RuleNewParamsBodyForceConnectionCloseRulePositionIndexPosition 

type RuleNewParamsBodyForceConnectionCloseRulePositionIndexPosition struct {
	// An index at which to place the rule, where index 1 is the first rule.
	Index param.Field[int64] `json:"index"`
}

An object configuring where the rule will be placed.

func (RuleNewParamsBodyForceConnectionCloseRulePositionIndexPosition) MarshalJSON 

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

type RuleNewParamsBodyForceConnectionCloseRulePositionUnion 

type RuleNewParamsBodyForceConnectionCloseRulePositionUnion interface {
	// contains filtered or unexported methods
}

An object configuring where the rule will be placed.

Satisfied by rulesets.RuleNewParamsBodyForceConnectionCloseRulePositionBeforePosition, rulesets.RuleNewParamsBodyForceConnectionCloseRulePositionAfterPosition, rulesets.RuleNewParamsBodyForceConnectionCloseRulePositionIndexPosition, RuleNewParamsBodyForceConnectionCloseRulePosition.

type RuleNewParamsBodyJavaScriptChallengeRule 

type RuleNewParamsBodyJavaScriptChallengeRule struct {
	// The unique ID of the rule.
	ID param.Field[string] `json:"id"`
	// The action to perform when the rule matches.
	Action param.Field[RuleNewParamsBodyJavaScriptChallengeRuleAction] `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters param.Field[interface{}] `json:"action_parameters"`
	// An informative description of the rule.
	Description param.Field[string] `json:"description"`
	// Whether the rule should be executed.
	Enabled param.Field[bool] `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck param.Field[RuleNewParamsBodyJavaScriptChallengeRuleExposedCredentialCheck] `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression param.Field[string] `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging param.Field[LoggingParam] `json:"logging"`
	// An object configuring where the rule will be placed.
	Position param.Field[RuleNewParamsBodyJavaScriptChallengeRulePositionUnion] `json:"position"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit param.Field[RuleNewParamsBodyJavaScriptChallengeRuleRatelimit] `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref param.Field[string] `json:"ref"`
}

func (RuleNewParamsBodyJavaScriptChallengeRule) MarshalJSON 

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

type RuleNewParamsBodyJavaScriptChallengeRuleAction 

type RuleNewParamsBodyJavaScriptChallengeRuleAction string

The action to perform when the rule matches. 

const (
	RuleNewParamsBodyJavaScriptChallengeRuleActionJSChallenge RuleNewParamsBodyJavaScriptChallengeRuleAction = "js_challenge"
)

func (RuleNewParamsBodyJavaScriptChallengeRuleAction) IsKnown 

func (r RuleNewParamsBodyJavaScriptChallengeRuleAction) IsKnown() bool

type RuleNewParamsBodyJavaScriptChallengeRuleExposedCredentialCheck 

type RuleNewParamsBodyJavaScriptChallengeRuleExposedCredentialCheck struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression param.Field[string] `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression param.Field[string] `json:"username_expression" api:"required"`
}

Configuration for exposed credential checking.

func (RuleNewParamsBodyJavaScriptChallengeRuleExposedCredentialCheck) MarshalJSON 

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

type RuleNewParamsBodyJavaScriptChallengeRulePosition 

type RuleNewParamsBodyJavaScriptChallengeRulePosition struct {
	// The ID of another rule to place the rule after. An empty value causes the rule
	// to be placed at the bottom.
	After param.Field[string] `json:"after"`
	// The ID of another rule to place the rule before. An empty value causes the rule
	// to be placed at the top.
	Before param.Field[string] `json:"before"`
	// An index at which to place the rule, where index 1 is the first rule.
	Index param.Field[int64] `json:"index"`
}

An object configuring where the rule will be placed.

func (RuleNewParamsBodyJavaScriptChallengeRulePosition) MarshalJSON 

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

type RuleNewParamsBodyJavaScriptChallengeRulePositionAfterPosition 

type RuleNewParamsBodyJavaScriptChallengeRulePositionAfterPosition struct {
	// The ID of another rule to place the rule after. An empty value causes the rule
	// to be placed at the bottom.
	After param.Field[string] `json:"after"`
}

An object configuring where the rule will be placed.

func (RuleNewParamsBodyJavaScriptChallengeRulePositionAfterPosition) MarshalJSON 

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

type RuleNewParamsBodyJavaScriptChallengeRulePositionBeforePosition 

type RuleNewParamsBodyJavaScriptChallengeRulePositionBeforePosition struct {
	// The ID of another rule to place the rule before. An empty value causes the rule
	// to be placed at the top.
	Before param.Field[string] `json:"before"`
}

An object configuring where the rule will be placed.

func (RuleNewParamsBodyJavaScriptChallengeRulePositionBeforePosition) MarshalJSON 

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

type RuleNewParamsBodyJavaScriptChallengeRulePositionIndexPosition 

type RuleNewParamsBodyJavaScriptChallengeRulePositionIndexPosition struct {
	// An index at which to place the rule, where index 1 is the first rule.
	Index param.Field[int64] `json:"index"`
}

An object configuring where the rule will be placed.

func (RuleNewParamsBodyJavaScriptChallengeRulePositionIndexPosition) MarshalJSON 

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

type RuleNewParamsBodyJavaScriptChallengeRulePositionUnion 

type RuleNewParamsBodyJavaScriptChallengeRulePositionUnion interface {
	// contains filtered or unexported methods
}

An object configuring where the rule will be placed.

Satisfied by rulesets.RuleNewParamsBodyJavaScriptChallengeRulePositionBeforePosition, rulesets.RuleNewParamsBodyJavaScriptChallengeRulePositionAfterPosition, rulesets.RuleNewParamsBodyJavaScriptChallengeRulePositionIndexPosition, RuleNewParamsBodyJavaScriptChallengeRulePosition.

type RuleNewParamsBodyJavaScriptChallengeRuleRatelimit 

type RuleNewParamsBodyJavaScriptChallengeRuleRatelimit struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics param.Field[[]string] `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period param.Field[int64] `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression param.Field[string] `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout param.Field[int64] `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod param.Field[int64] `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin param.Field[bool] `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod param.Field[int64] `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName param.Field[string] `json:"score_response_header_name"`
}

An object configuring the rule's rate limit behavior.

func (RuleNewParamsBodyJavaScriptChallengeRuleRatelimit) MarshalJSON 

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

type RuleNewParamsBodyLogCustomFieldRule 

type RuleNewParamsBodyLogCustomFieldRule struct {
	// An object configuring where the rule will be placed.
	Position param.Field[RuleNewParamsBodyLogCustomFieldRulePositionUnion] `json:"position"`
	LogCustomFieldRuleParam
}

func (RuleNewParamsBodyLogCustomFieldRule) MarshalJSON 

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

type RuleNewParamsBodyLogCustomFieldRulePosition 

type RuleNewParamsBodyLogCustomFieldRulePosition struct {
	// The ID of another rule to place the rule after. An empty value causes the rule
	// to be placed at the bottom.
	After param.Field[string] `json:"after"`
	// The ID of another rule to place the rule before. An empty value causes the rule
	// to be placed at the top.
	Before param.Field[string] `json:"before"`
	// An index at which to place the rule, where index 1 is the first rule.
	Index param.Field[int64] `json:"index"`
}

An object configuring where the rule will be placed.

func (RuleNewParamsBodyLogCustomFieldRulePosition) MarshalJSON 

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

type RuleNewParamsBodyLogCustomFieldRulePositionAfterPosition 

type RuleNewParamsBodyLogCustomFieldRulePositionAfterPosition struct {
	// The ID of another rule to place the rule after. An empty value causes the rule
	// to be placed at the bottom.
	After param.Field[string] `json:"after"`
}

An object configuring where the rule will be placed.

func (RuleNewParamsBodyLogCustomFieldRulePositionAfterPosition) MarshalJSON 

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

type RuleNewParamsBodyLogCustomFieldRulePositionBeforePosition 

type RuleNewParamsBodyLogCustomFieldRulePositionBeforePosition struct {
	// The ID of another rule to place the rule before. An empty value causes the rule
	// to be placed at the top.
	Before param.Field[string] `json:"before"`
}

An object configuring where the rule will be placed.

func (RuleNewParamsBodyLogCustomFieldRulePositionBeforePosition) MarshalJSON 

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

type RuleNewParamsBodyLogCustomFieldRulePositionIndexPosition 

type RuleNewParamsBodyLogCustomFieldRulePositionIndexPosition struct {
	// An index at which to place the rule, where index 1 is the first rule.
	Index param.Field[int64] `json:"index"`
}

An object configuring where the rule will be placed.

func (RuleNewParamsBodyLogCustomFieldRulePositionIndexPosition) MarshalJSON 

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

type RuleNewParamsBodyLogCustomFieldRulePositionUnion 

type RuleNewParamsBodyLogCustomFieldRulePositionUnion interface {
	// contains filtered or unexported methods
}

An object configuring where the rule will be placed.

Satisfied by rulesets.RuleNewParamsBodyLogCustomFieldRulePositionBeforePosition, rulesets.RuleNewParamsBodyLogCustomFieldRulePositionAfterPosition, rulesets.RuleNewParamsBodyLogCustomFieldRulePositionIndexPosition, RuleNewParamsBodyLogCustomFieldRulePosition.

type RuleNewParamsBodyLogRule 

type RuleNewParamsBodyLogRule struct {
	// An object configuring where the rule will be placed.
	Position param.Field[RuleNewParamsBodyLogRulePositionUnion] `json:"position"`
	LogRuleParam
}

func (RuleNewParamsBodyLogRule) MarshalJSON 

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

type RuleNewParamsBodyLogRulePosition 

type RuleNewParamsBodyLogRulePosition struct {
	// The ID of another rule to place the rule after. An empty value causes the rule
	// to be placed at the bottom.
	After param.Field[string] `json:"after"`
	// The ID of another rule to place the rule before. An empty value causes the rule
	// to be placed at the top.
	Before param.Field[string] `json:"before"`
	// An index at which to place the rule, where index 1 is the first rule.
	Index param.Field[int64] `json:"index"`
}

An object configuring where the rule will be placed.

func (RuleNewParamsBodyLogRulePosition) MarshalJSON 

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

type RuleNewParamsBodyLogRulePositionAfterPosition 

type RuleNewParamsBodyLogRulePositionAfterPosition struct {
	// The ID of another rule to place the rule after. An empty value causes the rule
	// to be placed at the bottom.
	After param.Field[string] `json:"after"`
}

An object configuring where the rule will be placed.

func (RuleNewParamsBodyLogRulePositionAfterPosition) MarshalJSON 

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

type RuleNewParamsBodyLogRulePositionBeforePosition 

type RuleNewParamsBodyLogRulePositionBeforePosition struct {
	// The ID of another rule to place the rule before. An empty value causes the rule
	// to be placed at the top.
	Before param.Field[string] `json:"before"`
}

An object configuring where the rule will be placed.

func (RuleNewParamsBodyLogRulePositionBeforePosition) MarshalJSON 

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

type RuleNewParamsBodyLogRulePositionIndexPosition 

type RuleNewParamsBodyLogRulePositionIndexPosition struct {
	// An index at which to place the rule, where index 1 is the first rule.
	Index param.Field[int64] `json:"index"`
}

An object configuring where the rule will be placed.

func (RuleNewParamsBodyLogRulePositionIndexPosition) MarshalJSON 

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

type RuleNewParamsBodyLogRulePositionUnion 

type RuleNewParamsBodyLogRulePositionUnion interface {
	// contains filtered or unexported methods
}

An object configuring where the rule will be placed.

Satisfied by rulesets.RuleNewParamsBodyLogRulePositionBeforePosition, rulesets.RuleNewParamsBodyLogRulePositionAfterPosition, rulesets.RuleNewParamsBodyLogRulePositionIndexPosition, RuleNewParamsBodyLogRulePosition.

type RuleNewParamsBodyManagedChallengeRule 

type RuleNewParamsBodyManagedChallengeRule struct {
	// An object configuring where the rule will be placed.
	Position param.Field[RuleNewParamsBodyManagedChallengeRulePositionUnion] `json:"position"`
	ManagedChallengeRuleParam
}

func (RuleNewParamsBodyManagedChallengeRule) MarshalJSON 

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

type RuleNewParamsBodyManagedChallengeRulePosition 

type RuleNewParamsBodyManagedChallengeRulePosition struct {
	// The ID of another rule to place the rule after. An empty value causes the rule
	// to be placed at the bottom.
	After param.Field[string] `json:"after"`
	// The ID of another rule to place the rule before. An empty value causes the rule
	// to be placed at the top.
	Before param.Field[string] `json:"before"`
	// An index at which to place the rule, where index 1 is the first rule.
	Index param.Field[int64] `json:"index"`
}

An object configuring where the rule will be placed.

func (RuleNewParamsBodyManagedChallengeRulePosition) MarshalJSON 

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

type RuleNewParamsBodyManagedChallengeRulePositionAfterPosition 

type RuleNewParamsBodyManagedChallengeRulePositionAfterPosition struct {
	// The ID of another rule to place the rule after. An empty value causes the rule
	// to be placed at the bottom.
	After param.Field[string] `json:"after"`
}

An object configuring where the rule will be placed.

func (RuleNewParamsBodyManagedChallengeRulePositionAfterPosition) MarshalJSON 

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

type RuleNewParamsBodyManagedChallengeRulePositionBeforePosition 

type RuleNewParamsBodyManagedChallengeRulePositionBeforePosition struct {
	// The ID of another rule to place the rule before. An empty value causes the rule
	// to be placed at the top.
	Before param.Field[string] `json:"before"`
}

An object configuring where the rule will be placed.

func (RuleNewParamsBodyManagedChallengeRulePositionBeforePosition) MarshalJSON 

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

type RuleNewParamsBodyManagedChallengeRulePositionIndexPosition 

type RuleNewParamsBodyManagedChallengeRulePositionIndexPosition struct {
	// An index at which to place the rule, where index 1 is the first rule.
	Index param.Field[int64] `json:"index"`
}

An object configuring where the rule will be placed.

func (RuleNewParamsBodyManagedChallengeRulePositionIndexPosition) MarshalJSON 

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

type RuleNewParamsBodyManagedChallengeRulePositionUnion 

type RuleNewParamsBodyManagedChallengeRulePositionUnion interface {
	// contains filtered or unexported methods
}

An object configuring where the rule will be placed.

Satisfied by rulesets.RuleNewParamsBodyManagedChallengeRulePositionBeforePosition, rulesets.RuleNewParamsBodyManagedChallengeRulePositionAfterPosition, rulesets.RuleNewParamsBodyManagedChallengeRulePositionIndexPosition, RuleNewParamsBodyManagedChallengeRulePosition.

type RuleNewParamsBodyRedirectRule 

type RuleNewParamsBodyRedirectRule struct {
	// An object configuring where the rule will be placed.
	Position param.Field[RuleNewParamsBodyRedirectRulePositionUnion] `json:"position"`
	RedirectRuleParam
}

func (RuleNewParamsBodyRedirectRule) MarshalJSON 

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

type RuleNewParamsBodyRedirectRulePosition 

type RuleNewParamsBodyRedirectRulePosition struct {
	// The ID of another rule to place the rule after. An empty value causes the rule
	// to be placed at the bottom.
	After param.Field[string] `json:"after"`
	// The ID of another rule to place the rule before. An empty value causes the rule
	// to be placed at the top.
	Before param.Field[string] `json:"before"`
	// An index at which to place the rule, where index 1 is the first rule.
	Index param.Field[int64] `json:"index"`
}

An object configuring where the rule will be placed.

func (RuleNewParamsBodyRedirectRulePosition) MarshalJSON 

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

type RuleNewParamsBodyRedirectRulePositionAfterPosition 

type RuleNewParamsBodyRedirectRulePositionAfterPosition struct {
	// The ID of another rule to place the rule after. An empty value causes the rule
	// to be placed at the bottom.
	After param.Field[string] `json:"after"`
}

An object configuring where the rule will be placed.

func (RuleNewParamsBodyRedirectRulePositionAfterPosition) MarshalJSON 

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

type RuleNewParamsBodyRedirectRulePositionBeforePosition 

type RuleNewParamsBodyRedirectRulePositionBeforePosition struct {
	// The ID of another rule to place the rule before. An empty value causes the rule
	// to be placed at the top.
	Before param.Field[string] `json:"before"`
}

An object configuring where the rule will be placed.

func (RuleNewParamsBodyRedirectRulePositionBeforePosition) MarshalJSON 

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

type RuleNewParamsBodyRedirectRulePositionIndexPosition 

type RuleNewParamsBodyRedirectRulePositionIndexPosition struct {
	// An index at which to place the rule, where index 1 is the first rule.
	Index param.Field[int64] `json:"index"`
}

An object configuring where the rule will be placed.

func (RuleNewParamsBodyRedirectRulePositionIndexPosition) MarshalJSON 

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

type RuleNewParamsBodyRedirectRulePositionUnion 

type RuleNewParamsBodyRedirectRulePositionUnion interface {
	// contains filtered or unexported methods
}

An object configuring where the rule will be placed.

Satisfied by rulesets.RuleNewParamsBodyRedirectRulePositionBeforePosition, rulesets.RuleNewParamsBodyRedirectRulePositionAfterPosition, rulesets.RuleNewParamsBodyRedirectRulePositionIndexPosition, RuleNewParamsBodyRedirectRulePosition.

type RuleNewParamsBodyResponseCompressionRule 

type RuleNewParamsBodyResponseCompressionRule struct {
	// An object configuring where the rule will be placed.
	Position param.Field[RuleNewParamsBodyResponseCompressionRulePositionUnion] `json:"position"`
	CompressResponseRuleParam
}

func (RuleNewParamsBodyResponseCompressionRule) MarshalJSON 

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

type RuleNewParamsBodyResponseCompressionRulePosition 

type RuleNewParamsBodyResponseCompressionRulePosition struct {
	// The ID of another rule to place the rule after. An empty value causes the rule
	// to be placed at the bottom.
	After param.Field[string] `json:"after"`
	// The ID of another rule to place the rule before. An empty value causes the rule
	// to be placed at the top.
	Before param.Field[string] `json:"before"`
	// An index at which to place the rule, where index 1 is the first rule.
	Index param.Field[int64] `json:"index"`
}

An object configuring where the rule will be placed.

func (RuleNewParamsBodyResponseCompressionRulePosition) MarshalJSON 

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

type RuleNewParamsBodyResponseCompressionRulePositionAfterPosition 

type RuleNewParamsBodyResponseCompressionRulePositionAfterPosition struct {
	// The ID of another rule to place the rule after. An empty value causes the rule
	// to be placed at the bottom.
	After param.Field[string] `json:"after"`
}

An object configuring where the rule will be placed.

func (RuleNewParamsBodyResponseCompressionRulePositionAfterPosition) MarshalJSON 

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

type RuleNewParamsBodyResponseCompressionRulePositionBeforePosition 

type RuleNewParamsBodyResponseCompressionRulePositionBeforePosition struct {
	// The ID of another rule to place the rule before. An empty value causes the rule
	// to be placed at the top.
	Before param.Field[string] `json:"before"`
}

An object configuring where the rule will be placed.

func (RuleNewParamsBodyResponseCompressionRulePositionBeforePosition) MarshalJSON 

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

type RuleNewParamsBodyResponseCompressionRulePositionIndexPosition 

type RuleNewParamsBodyResponseCompressionRulePositionIndexPosition struct {
	// An index at which to place the rule, where index 1 is the first rule.
	Index param.Field[int64] `json:"index"`
}

An object configuring where the rule will be placed.

func (RuleNewParamsBodyResponseCompressionRulePositionIndexPosition) MarshalJSON 

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

type RuleNewParamsBodyResponseCompressionRulePositionUnion 

type RuleNewParamsBodyResponseCompressionRulePositionUnion interface {
	// contains filtered or unexported methods
}

An object configuring where the rule will be placed.

Satisfied by rulesets.RuleNewParamsBodyResponseCompressionRulePositionBeforePosition, rulesets.RuleNewParamsBodyResponseCompressionRulePositionAfterPosition, rulesets.RuleNewParamsBodyResponseCompressionRulePositionIndexPosition, RuleNewParamsBodyResponseCompressionRulePosition.

type RuleNewParamsBodyRewriteRule 

type RuleNewParamsBodyRewriteRule struct {
	// An object configuring where the rule will be placed.
	Position param.Field[RuleNewParamsBodyRewriteRulePositionUnion] `json:"position"`
	RewriteRuleParam
}

func (RuleNewParamsBodyRewriteRule) MarshalJSON 

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

type RuleNewParamsBodyRewriteRulePosition 

type RuleNewParamsBodyRewriteRulePosition struct {
	// The ID of another rule to place the rule after. An empty value causes the rule
	// to be placed at the bottom.
	After param.Field[string] `json:"after"`
	// The ID of another rule to place the rule before. An empty value causes the rule
	// to be placed at the top.
	Before param.Field[string] `json:"before"`
	// An index at which to place the rule, where index 1 is the first rule.
	Index param.Field[int64] `json:"index"`
}

An object configuring where the rule will be placed.

func (RuleNewParamsBodyRewriteRulePosition) MarshalJSON 

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

type RuleNewParamsBodyRewriteRulePositionAfterPosition 

type RuleNewParamsBodyRewriteRulePositionAfterPosition struct {
	// The ID of another rule to place the rule after. An empty value causes the rule
	// to be placed at the bottom.
	After param.Field[string] `json:"after"`
}

An object configuring where the rule will be placed.

func (RuleNewParamsBodyRewriteRulePositionAfterPosition) MarshalJSON 

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

type RuleNewParamsBodyRewriteRulePositionBeforePosition 

type RuleNewParamsBodyRewriteRulePositionBeforePosition struct {
	// The ID of another rule to place the rule before. An empty value causes the rule
	// to be placed at the top.
	Before param.Field[string] `json:"before"`
}

An object configuring where the rule will be placed.

func (RuleNewParamsBodyRewriteRulePositionBeforePosition) MarshalJSON 

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

type RuleNewParamsBodyRewriteRulePositionIndexPosition 

type RuleNewParamsBodyRewriteRulePositionIndexPosition struct {
	// An index at which to place the rule, where index 1 is the first rule.
	Index param.Field[int64] `json:"index"`
}

An object configuring where the rule will be placed.

func (RuleNewParamsBodyRewriteRulePositionIndexPosition) MarshalJSON 

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

type RuleNewParamsBodyRewriteRulePositionUnion 

type RuleNewParamsBodyRewriteRulePositionUnion interface {
	// contains filtered or unexported methods
}

An object configuring where the rule will be placed.

Satisfied by rulesets.RuleNewParamsBodyRewriteRulePositionBeforePosition, rulesets.RuleNewParamsBodyRewriteRulePositionAfterPosition, rulesets.RuleNewParamsBodyRewriteRulePositionIndexPosition, RuleNewParamsBodyRewriteRulePosition.

type RuleNewParamsBodyRouteRule 

type RuleNewParamsBodyRouteRule struct {
	// An object configuring where the rule will be placed.
	Position param.Field[RuleNewParamsBodyRouteRulePositionUnion] `json:"position"`
	RouteRuleParam
}

func (RuleNewParamsBodyRouteRule) MarshalJSON 

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

type RuleNewParamsBodyRouteRulePosition 

type RuleNewParamsBodyRouteRulePosition struct {
	// The ID of another rule to place the rule after. An empty value causes the rule
	// to be placed at the bottom.
	After param.Field[string] `json:"after"`
	// The ID of another rule to place the rule before. An empty value causes the rule
	// to be placed at the top.
	Before param.Field[string] `json:"before"`
	// An index at which to place the rule, where index 1 is the first rule.
	Index param.Field[int64] `json:"index"`
}

An object configuring where the rule will be placed.

func (RuleNewParamsBodyRouteRulePosition) MarshalJSON 

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

type RuleNewParamsBodyRouteRulePositionAfterPosition 

type RuleNewParamsBodyRouteRulePositionAfterPosition struct {
	// The ID of another rule to place the rule after. An empty value causes the rule
	// to be placed at the bottom.
	After param.Field[string] `json:"after"`
}

An object configuring where the rule will be placed.

func (RuleNewParamsBodyRouteRulePositionAfterPosition) MarshalJSON 

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

type RuleNewParamsBodyRouteRulePositionBeforePosition 

type RuleNewParamsBodyRouteRulePositionBeforePosition struct {
	// The ID of another rule to place the rule before. An empty value causes the rule
	// to be placed at the top.
	Before param.Field[string] `json:"before"`
}

An object configuring where the rule will be placed.

func (RuleNewParamsBodyRouteRulePositionBeforePosition) MarshalJSON 

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

type RuleNewParamsBodyRouteRulePositionIndexPosition 

type RuleNewParamsBodyRouteRulePositionIndexPosition struct {
	// An index at which to place the rule, where index 1 is the first rule.
	Index param.Field[int64] `json:"index"`
}

An object configuring where the rule will be placed.

func (RuleNewParamsBodyRouteRulePositionIndexPosition) MarshalJSON 

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

type RuleNewParamsBodyRouteRulePositionUnion 

type RuleNewParamsBodyRouteRulePositionUnion interface {
	// contains filtered or unexported methods
}

An object configuring where the rule will be placed.

Satisfied by rulesets.RuleNewParamsBodyRouteRulePositionBeforePosition, rulesets.RuleNewParamsBodyRouteRulePositionAfterPosition, rulesets.RuleNewParamsBodyRouteRulePositionIndexPosition, RuleNewParamsBodyRouteRulePosition.

type RuleNewParamsBodyScoreRule 

type RuleNewParamsBodyScoreRule struct {
	// An object configuring where the rule will be placed.
	Position param.Field[RuleNewParamsBodyScoreRulePositionUnion] `json:"position"`
	ScoreRuleParam
}

func (RuleNewParamsBodyScoreRule) MarshalJSON 

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

type RuleNewParamsBodyScoreRulePosition 

type RuleNewParamsBodyScoreRulePosition struct {
	// The ID of another rule to place the rule after. An empty value causes the rule
	// to be placed at the bottom.
	After param.Field[string] `json:"after"`
	// The ID of another rule to place the rule before. An empty value causes the rule
	// to be placed at the top.
	Before param.Field[string] `json:"before"`
	// An index at which to place the rule, where index 1 is the first rule.
	Index param.Field[int64] `json:"index"`
}

An object configuring where the rule will be placed.

func (RuleNewParamsBodyScoreRulePosition) MarshalJSON 

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

type RuleNewParamsBodyScoreRulePositionAfterPosition 

type RuleNewParamsBodyScoreRulePositionAfterPosition struct {
	// The ID of another rule to place the rule after. An empty value causes the rule
	// to be placed at the bottom.
	After param.Field[string] `json:"after"`
}

An object configuring where the rule will be placed.

func (RuleNewParamsBodyScoreRulePositionAfterPosition) MarshalJSON 

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

type RuleNewParamsBodyScoreRulePositionBeforePosition 

type RuleNewParamsBodyScoreRulePositionBeforePosition struct {
	// The ID of another rule to place the rule before. An empty value causes the rule
	// to be placed at the top.
	Before param.Field[string] `json:"before"`
}

An object configuring where the rule will be placed.

func (RuleNewParamsBodyScoreRulePositionBeforePosition) MarshalJSON 

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

type RuleNewParamsBodyScoreRulePositionIndexPosition 

type RuleNewParamsBodyScoreRulePositionIndexPosition struct {
	// An index at which to place the rule, where index 1 is the first rule.
	Index param.Field[int64] `json:"index"`
}

An object configuring where the rule will be placed.

func (RuleNewParamsBodyScoreRulePositionIndexPosition) MarshalJSON 

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

type RuleNewParamsBodyScoreRulePositionUnion 

type RuleNewParamsBodyScoreRulePositionUnion interface {
	// contains filtered or unexported methods
}

An object configuring where the rule will be placed.

Satisfied by rulesets.RuleNewParamsBodyScoreRulePositionBeforePosition, rulesets.RuleNewParamsBodyScoreRulePositionAfterPosition, rulesets.RuleNewParamsBodyScoreRulePositionIndexPosition, RuleNewParamsBodyScoreRulePosition.

type RuleNewParamsBodyServeErrorRule 

type RuleNewParamsBodyServeErrorRule struct {
	// An object configuring where the rule will be placed.
	Position param.Field[RuleNewParamsBodyServeErrorRulePositionUnion] `json:"position"`
	ServeErrorRuleParam
}

func (RuleNewParamsBodyServeErrorRule) MarshalJSON 

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

type RuleNewParamsBodyServeErrorRulePosition 

type RuleNewParamsBodyServeErrorRulePosition struct {
	// The ID of another rule to place the rule after. An empty value causes the rule
	// to be placed at the bottom.
	After param.Field[string] `json:"after"`
	// The ID of another rule to place the rule before. An empty value causes the rule
	// to be placed at the top.
	Before param.Field[string] `json:"before"`
	// An index at which to place the rule, where index 1 is the first rule.
	Index param.Field[int64] `json:"index"`
}

An object configuring where the rule will be placed.

func (RuleNewParamsBodyServeErrorRulePosition) MarshalJSON 

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

type RuleNewParamsBodyServeErrorRulePositionAfterPosition 

type RuleNewParamsBodyServeErrorRulePositionAfterPosition struct {
	// The ID of another rule to place the rule after. An empty value causes the rule
	// to be placed at the bottom.
	After param.Field[string] `json:"after"`
}

An object configuring where the rule will be placed.

func (RuleNewParamsBodyServeErrorRulePositionAfterPosition) MarshalJSON 

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

type RuleNewParamsBodyServeErrorRulePositionBeforePosition 

type RuleNewParamsBodyServeErrorRulePositionBeforePosition struct {
	// The ID of another rule to place the rule before. An empty value causes the rule
	// to be placed at the top.
	Before param.Field[string] `json:"before"`
}

An object configuring where the rule will be placed.

func (RuleNewParamsBodyServeErrorRulePositionBeforePosition) MarshalJSON 

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

type RuleNewParamsBodyServeErrorRulePositionIndexPosition 

type RuleNewParamsBodyServeErrorRulePositionIndexPosition struct {
	// An index at which to place the rule, where index 1 is the first rule.
	Index param.Field[int64] `json:"index"`
}

An object configuring where the rule will be placed.

func (RuleNewParamsBodyServeErrorRulePositionIndexPosition) MarshalJSON 

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

type RuleNewParamsBodyServeErrorRulePositionUnion 

type RuleNewParamsBodyServeErrorRulePositionUnion interface {
	// contains filtered or unexported methods
}

An object configuring where the rule will be placed.

Satisfied by rulesets.RuleNewParamsBodyServeErrorRulePositionBeforePosition, rulesets.RuleNewParamsBodyServeErrorRulePositionAfterPosition, rulesets.RuleNewParamsBodyServeErrorRulePositionIndexPosition, RuleNewParamsBodyServeErrorRulePosition.

type RuleNewParamsBodySetCacheControlRule added in v6.9.0 

type RuleNewParamsBodySetCacheControlRule struct {
	// The unique ID of the rule.
	ID param.Field[string] `json:"id"`
	// The action to perform when the rule matches.
	Action param.Field[RuleNewParamsBodySetCacheControlRuleAction] `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters param.Field[RuleNewParamsBodySetCacheControlRuleActionParameters] `json:"action_parameters"`
	// An informative description of the rule.
	Description param.Field[string] `json:"description"`
	// Whether the rule should be executed.
	Enabled param.Field[bool] `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck param.Field[RuleNewParamsBodySetCacheControlRuleExposedCredentialCheck] `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression param.Field[string] `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging param.Field[LoggingParam] `json:"logging"`
	// An object configuring where the rule will be placed.
	Position param.Field[RuleNewParamsBodySetCacheControlRulePositionUnion] `json:"position"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit param.Field[RuleNewParamsBodySetCacheControlRuleRatelimit] `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref param.Field[string] `json:"ref"`
}

func (RuleNewParamsBodySetCacheControlRule) MarshalJSON added in v6.9.0 

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

type RuleNewParamsBodySetCacheControlRuleAction added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleAction string

The action to perform when the rule matches. 

const (
	RuleNewParamsBodySetCacheControlRuleActionSetCacheControl RuleNewParamsBodySetCacheControlRuleAction = "set_cache_control"
)

func (RuleNewParamsBodySetCacheControlRuleAction) IsKnown added in v6.9.0 

func (r RuleNewParamsBodySetCacheControlRuleAction) IsKnown() bool

type RuleNewParamsBodySetCacheControlRuleActionParameters added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParameters struct {
	// A cache-control directive configuration.
	Immutable param.Field[RuleNewParamsBodySetCacheControlRuleActionParametersImmutableUnion] `json:"immutable"`
	// A cache-control directive configuration that accepts a duration value in
	// seconds.
	MaxAge param.Field[RuleNewParamsBodySetCacheControlRuleActionParametersMaxAgeUnion] `json:"max-age"`
	// A cache-control directive configuration.
	MustRevalidate param.Field[RuleNewParamsBodySetCacheControlRuleActionParametersMustRevalidateUnion] `json:"must-revalidate"`
	// A cache-control directive configuration.
	MustUnderstand param.Field[RuleNewParamsBodySetCacheControlRuleActionParametersMustUnderstandUnion] `json:"must-understand"`
	// A cache-control directive configuration that accepts optional qualifiers (header
	// names).
	NoCache param.Field[RuleNewParamsBodySetCacheControlRuleActionParametersNoCacheUnion] `json:"no-cache"`
	// A cache-control directive configuration.
	NoStore param.Field[RuleNewParamsBodySetCacheControlRuleActionParametersNoStoreUnion] `json:"no-store"`
	// A cache-control directive configuration.
	NoTransform param.Field[RuleNewParamsBodySetCacheControlRuleActionParametersNoTransformUnion] `json:"no-transform"`
	// A cache-control directive configuration that accepts optional qualifiers (header
	// names).
	Private param.Field[RuleNewParamsBodySetCacheControlRuleActionParametersPrivateUnion] `json:"private"`
	// A cache-control directive configuration.
	ProxyRevalidate param.Field[RuleNewParamsBodySetCacheControlRuleActionParametersProxyRevalidateUnion] `json:"proxy-revalidate"`
	// A cache-control directive configuration.
	Public param.Field[RuleNewParamsBodySetCacheControlRuleActionParametersPublicUnion] `json:"public"`
	// A cache-control directive configuration that accepts a duration value in
	// seconds.
	SMaxage param.Field[RuleNewParamsBodySetCacheControlRuleActionParametersSMaxageUnion] `json:"s-maxage"`
	// A cache-control directive configuration that accepts a duration value in
	// seconds.
	StaleIfError param.Field[RuleNewParamsBodySetCacheControlRuleActionParametersStaleIfErrorUnion] `json:"stale-if-error"`
	// A cache-control directive configuration that accepts a duration value in
	// seconds.
	StaleWhileRevalidate param.Field[RuleNewParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateUnion] `json:"stale-while-revalidate"`
}

The parameters configuring the rule's action.

func (RuleNewParamsBodySetCacheControlRuleActionParameters) MarshalJSON added in v6.9.0 

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

type RuleNewParamsBodySetCacheControlRuleActionParametersImmutable added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersImmutable struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RuleNewParamsBodySetCacheControlRuleActionParametersImmutableOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

A cache-control directive configuration.

func (RuleNewParamsBodySetCacheControlRuleActionParametersImmutable) MarshalJSON added in v6.9.0 

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

type RuleNewParamsBodySetCacheControlRuleActionParametersImmutableOperation added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersImmutableOperation string

The operation to perform on the cache-control directive. 

const (
	RuleNewParamsBodySetCacheControlRuleActionParametersImmutableOperationSet    RuleNewParamsBodySetCacheControlRuleActionParametersImmutableOperation = "set"
	RuleNewParamsBodySetCacheControlRuleActionParametersImmutableOperationRemove RuleNewParamsBodySetCacheControlRuleActionParametersImmutableOperation = "remove"
)

func (RuleNewParamsBodySetCacheControlRuleActionParametersImmutableOperation) IsKnown added in v6.9.0 

func (r RuleNewParamsBodySetCacheControlRuleActionParametersImmutableOperation) IsKnown() bool

type RuleNewParamsBodySetCacheControlRuleActionParametersImmutableRemoveDirective added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersImmutableRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RuleNewParamsBodySetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Remove the directive.

func (RuleNewParamsBodySetCacheControlRuleActionParametersImmutableRemoveDirective) MarshalJSON added in v6.9.0 

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

type RuleNewParamsBodySetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleNewParamsBodySetCacheControlRuleActionParametersImmutableRemoveDirectiveOperationSet    RuleNewParamsBodySetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation = "set"
	RuleNewParamsBodySetCacheControlRuleActionParametersImmutableRemoveDirectiveOperationRemove RuleNewParamsBodySetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation = "remove"
)

func (RuleNewParamsBodySetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleNewParamsBodySetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation) IsKnown() bool

type RuleNewParamsBodySetCacheControlRuleActionParametersImmutableSetDirective added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersImmutableSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RuleNewParamsBodySetCacheControlRuleActionParametersImmutableSetDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Set the directive.

func (RuleNewParamsBodySetCacheControlRuleActionParametersImmutableSetDirective) MarshalJSON added in v6.9.0 

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

type RuleNewParamsBodySetCacheControlRuleActionParametersImmutableSetDirectiveOperation added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersImmutableSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleNewParamsBodySetCacheControlRuleActionParametersImmutableSetDirectiveOperationSet    RuleNewParamsBodySetCacheControlRuleActionParametersImmutableSetDirectiveOperation = "set"
	RuleNewParamsBodySetCacheControlRuleActionParametersImmutableSetDirectiveOperationRemove RuleNewParamsBodySetCacheControlRuleActionParametersImmutableSetDirectiveOperation = "remove"
)

func (RuleNewParamsBodySetCacheControlRuleActionParametersImmutableSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleNewParamsBodySetCacheControlRuleActionParametersImmutableSetDirectiveOperation) IsKnown() bool

type RuleNewParamsBodySetCacheControlRuleActionParametersImmutableUnion added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersImmutableUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Satisfied by rulesets.RuleNewParamsBodySetCacheControlRuleActionParametersImmutableSetDirective, rulesets.RuleNewParamsBodySetCacheControlRuleActionParametersImmutableRemoveDirective, RuleNewParamsBodySetCacheControlRuleActionParametersImmutable.

type RuleNewParamsBodySetCacheControlRuleActionParametersMaxAge added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersMaxAge struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RuleNewParamsBodySetCacheControlRuleActionParametersMaxAgeOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
	// The duration value in seconds for the directive.
	Value param.Field[int64] `json:"value"`
}

A cache-control directive configuration that accepts a duration value in seconds.

func (RuleNewParamsBodySetCacheControlRuleActionParametersMaxAge) MarshalJSON added in v6.9.0 

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

type RuleNewParamsBodySetCacheControlRuleActionParametersMaxAgeOperation added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersMaxAgeOperation string

The operation to perform on the cache-control directive. 

const (
	RuleNewParamsBodySetCacheControlRuleActionParametersMaxAgeOperationSet    RuleNewParamsBodySetCacheControlRuleActionParametersMaxAgeOperation = "set"
	RuleNewParamsBodySetCacheControlRuleActionParametersMaxAgeOperationRemove RuleNewParamsBodySetCacheControlRuleActionParametersMaxAgeOperation = "remove"
)

func (RuleNewParamsBodySetCacheControlRuleActionParametersMaxAgeOperation) IsKnown added in v6.9.0 

func (r RuleNewParamsBodySetCacheControlRuleActionParametersMaxAgeOperation) IsKnown() bool

type RuleNewParamsBodySetCacheControlRuleActionParametersMaxAgeRemoveDirective added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersMaxAgeRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RuleNewParamsBodySetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Remove the directive.

func (RuleNewParamsBodySetCacheControlRuleActionParametersMaxAgeRemoveDirective) MarshalJSON added in v6.9.0 

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

type RuleNewParamsBodySetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleNewParamsBodySetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperationSet    RuleNewParamsBodySetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation = "set"
	RuleNewParamsBodySetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperationRemove RuleNewParamsBodySetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation = "remove"
)

func (RuleNewParamsBodySetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleNewParamsBodySetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation) IsKnown() bool

type RuleNewParamsBodySetCacheControlRuleActionParametersMaxAgeSetDirective added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersMaxAgeSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RuleNewParamsBodySetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation] `json:"operation" api:"required"`
	// The duration value in seconds for the directive.
	Value param.Field[int64] `json:"value" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Set the directive with a duration value in seconds.

func (RuleNewParamsBodySetCacheControlRuleActionParametersMaxAgeSetDirective) MarshalJSON added in v6.9.0 

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

type RuleNewParamsBodySetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleNewParamsBodySetCacheControlRuleActionParametersMaxAgeSetDirectiveOperationSet    RuleNewParamsBodySetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation = "set"
	RuleNewParamsBodySetCacheControlRuleActionParametersMaxAgeSetDirectiveOperationRemove RuleNewParamsBodySetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation = "remove"
)

func (RuleNewParamsBodySetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleNewParamsBodySetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation) IsKnown() bool

type RuleNewParamsBodySetCacheControlRuleActionParametersMaxAgeUnion added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersMaxAgeUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts a duration value in seconds.

Satisfied by rulesets.RuleNewParamsBodySetCacheControlRuleActionParametersMaxAgeSetDirective, rulesets.RuleNewParamsBodySetCacheControlRuleActionParametersMaxAgeRemoveDirective, RuleNewParamsBodySetCacheControlRuleActionParametersMaxAge.

type RuleNewParamsBodySetCacheControlRuleActionParametersMustRevalidate added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersMustRevalidate struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RuleNewParamsBodySetCacheControlRuleActionParametersMustRevalidateOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

A cache-control directive configuration.

func (RuleNewParamsBodySetCacheControlRuleActionParametersMustRevalidate) MarshalJSON added in v6.9.0 

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

type RuleNewParamsBodySetCacheControlRuleActionParametersMustRevalidateOperation added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersMustRevalidateOperation string

The operation to perform on the cache-control directive. 

const (
	RuleNewParamsBodySetCacheControlRuleActionParametersMustRevalidateOperationSet    RuleNewParamsBodySetCacheControlRuleActionParametersMustRevalidateOperation = "set"
	RuleNewParamsBodySetCacheControlRuleActionParametersMustRevalidateOperationRemove RuleNewParamsBodySetCacheControlRuleActionParametersMustRevalidateOperation = "remove"
)

func (RuleNewParamsBodySetCacheControlRuleActionParametersMustRevalidateOperation) IsKnown added in v6.9.0 

func (r RuleNewParamsBodySetCacheControlRuleActionParametersMustRevalidateOperation) IsKnown() bool

type RuleNewParamsBodySetCacheControlRuleActionParametersMustRevalidateRemoveDirective added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersMustRevalidateRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RuleNewParamsBodySetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Remove the directive.

func (RuleNewParamsBodySetCacheControlRuleActionParametersMustRevalidateRemoveDirective) MarshalJSON added in v6.9.0 

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

type RuleNewParamsBodySetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleNewParamsBodySetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperationSet    RuleNewParamsBodySetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation = "set"
	RuleNewParamsBodySetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperationRemove RuleNewParamsBodySetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation = "remove"
)

func (RuleNewParamsBodySetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleNewParamsBodySetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation) IsKnown() bool

type RuleNewParamsBodySetCacheControlRuleActionParametersMustRevalidateSetDirective added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersMustRevalidateSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RuleNewParamsBodySetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Set the directive.

func (RuleNewParamsBodySetCacheControlRuleActionParametersMustRevalidateSetDirective) MarshalJSON added in v6.9.0 

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

type RuleNewParamsBodySetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleNewParamsBodySetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperationSet    RuleNewParamsBodySetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation = "set"
	RuleNewParamsBodySetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperationRemove RuleNewParamsBodySetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation = "remove"
)

func (RuleNewParamsBodySetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleNewParamsBodySetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation) IsKnown() bool

type RuleNewParamsBodySetCacheControlRuleActionParametersMustRevalidateUnion added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersMustRevalidateUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Satisfied by rulesets.RuleNewParamsBodySetCacheControlRuleActionParametersMustRevalidateSetDirective, rulesets.RuleNewParamsBodySetCacheControlRuleActionParametersMustRevalidateRemoveDirective, RuleNewParamsBodySetCacheControlRuleActionParametersMustRevalidate.

type RuleNewParamsBodySetCacheControlRuleActionParametersMustUnderstand added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersMustUnderstand struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RuleNewParamsBodySetCacheControlRuleActionParametersMustUnderstandOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

A cache-control directive configuration.

func (RuleNewParamsBodySetCacheControlRuleActionParametersMustUnderstand) MarshalJSON added in v6.9.0 

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

type RuleNewParamsBodySetCacheControlRuleActionParametersMustUnderstandOperation added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersMustUnderstandOperation string

The operation to perform on the cache-control directive. 

const (
	RuleNewParamsBodySetCacheControlRuleActionParametersMustUnderstandOperationSet    RuleNewParamsBodySetCacheControlRuleActionParametersMustUnderstandOperation = "set"
	RuleNewParamsBodySetCacheControlRuleActionParametersMustUnderstandOperationRemove RuleNewParamsBodySetCacheControlRuleActionParametersMustUnderstandOperation = "remove"
)

func (RuleNewParamsBodySetCacheControlRuleActionParametersMustUnderstandOperation) IsKnown added in v6.9.0 

func (r RuleNewParamsBodySetCacheControlRuleActionParametersMustUnderstandOperation) IsKnown() bool

type RuleNewParamsBodySetCacheControlRuleActionParametersMustUnderstandRemoveDirective added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersMustUnderstandRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RuleNewParamsBodySetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Remove the directive.

func (RuleNewParamsBodySetCacheControlRuleActionParametersMustUnderstandRemoveDirective) MarshalJSON added in v6.9.0 

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

type RuleNewParamsBodySetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleNewParamsBodySetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperationSet    RuleNewParamsBodySetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation = "set"
	RuleNewParamsBodySetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperationRemove RuleNewParamsBodySetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation = "remove"
)

func (RuleNewParamsBodySetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleNewParamsBodySetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation) IsKnown() bool

type RuleNewParamsBodySetCacheControlRuleActionParametersMustUnderstandSetDirective added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersMustUnderstandSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RuleNewParamsBodySetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Set the directive.

func (RuleNewParamsBodySetCacheControlRuleActionParametersMustUnderstandSetDirective) MarshalJSON added in v6.9.0 

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

type RuleNewParamsBodySetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleNewParamsBodySetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperationSet    RuleNewParamsBodySetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation = "set"
	RuleNewParamsBodySetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperationRemove RuleNewParamsBodySetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation = "remove"
)

func (RuleNewParamsBodySetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleNewParamsBodySetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation) IsKnown() bool

type RuleNewParamsBodySetCacheControlRuleActionParametersMustUnderstandUnion added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersMustUnderstandUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Satisfied by rulesets.RuleNewParamsBodySetCacheControlRuleActionParametersMustUnderstandSetDirective, rulesets.RuleNewParamsBodySetCacheControlRuleActionParametersMustUnderstandRemoveDirective, RuleNewParamsBodySetCacheControlRuleActionParametersMustUnderstand.

type RuleNewParamsBodySetCacheControlRuleActionParametersNoCache added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersNoCache struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RuleNewParamsBodySetCacheControlRuleActionParametersNoCacheOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool]        `json:"cloudflare_only"`
	Qualifiers     param.Field[interface{}] `json:"qualifiers"`
}

A cache-control directive configuration that accepts optional qualifiers (header names).

func (RuleNewParamsBodySetCacheControlRuleActionParametersNoCache) MarshalJSON added in v6.9.0 

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

type RuleNewParamsBodySetCacheControlRuleActionParametersNoCacheOperation added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersNoCacheOperation string

The operation to perform on the cache-control directive. 

const (
	RuleNewParamsBodySetCacheControlRuleActionParametersNoCacheOperationSet    RuleNewParamsBodySetCacheControlRuleActionParametersNoCacheOperation = "set"
	RuleNewParamsBodySetCacheControlRuleActionParametersNoCacheOperationRemove RuleNewParamsBodySetCacheControlRuleActionParametersNoCacheOperation = "remove"
)

func (RuleNewParamsBodySetCacheControlRuleActionParametersNoCacheOperation) IsKnown added in v6.9.0 

func (r RuleNewParamsBodySetCacheControlRuleActionParametersNoCacheOperation) IsKnown() bool

type RuleNewParamsBodySetCacheControlRuleActionParametersNoCacheRemoveDirective added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersNoCacheRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RuleNewParamsBodySetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Remove the directive.

func (RuleNewParamsBodySetCacheControlRuleActionParametersNoCacheRemoveDirective) MarshalJSON added in v6.9.0 

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

type RuleNewParamsBodySetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleNewParamsBodySetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperationSet    RuleNewParamsBodySetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation = "set"
	RuleNewParamsBodySetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperationRemove RuleNewParamsBodySetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation = "remove"
)

func (RuleNewParamsBodySetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleNewParamsBodySetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation) IsKnown() bool

type RuleNewParamsBodySetCacheControlRuleActionParametersNoCacheSetDirective added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersNoCacheSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RuleNewParamsBodySetCacheControlRuleActionParametersNoCacheSetDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
	// Optional list of header names to qualify the directive (e.g., for "private" or
	// "no-cache" directives).
	Qualifiers param.Field[[]string] `json:"qualifiers"`
}

Set the directive with optional qualifiers.

func (RuleNewParamsBodySetCacheControlRuleActionParametersNoCacheSetDirective) MarshalJSON added in v6.9.0 

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

type RuleNewParamsBodySetCacheControlRuleActionParametersNoCacheSetDirectiveOperation added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersNoCacheSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleNewParamsBodySetCacheControlRuleActionParametersNoCacheSetDirectiveOperationSet    RuleNewParamsBodySetCacheControlRuleActionParametersNoCacheSetDirectiveOperation = "set"
	RuleNewParamsBodySetCacheControlRuleActionParametersNoCacheSetDirectiveOperationRemove RuleNewParamsBodySetCacheControlRuleActionParametersNoCacheSetDirectiveOperation = "remove"
)

func (RuleNewParamsBodySetCacheControlRuleActionParametersNoCacheSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleNewParamsBodySetCacheControlRuleActionParametersNoCacheSetDirectiveOperation) IsKnown() bool

type RuleNewParamsBodySetCacheControlRuleActionParametersNoCacheUnion added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersNoCacheUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts optional qualifiers (header names).

Satisfied by rulesets.RuleNewParamsBodySetCacheControlRuleActionParametersNoCacheSetDirective, rulesets.RuleNewParamsBodySetCacheControlRuleActionParametersNoCacheRemoveDirective, RuleNewParamsBodySetCacheControlRuleActionParametersNoCache.

type RuleNewParamsBodySetCacheControlRuleActionParametersNoStore added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersNoStore struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RuleNewParamsBodySetCacheControlRuleActionParametersNoStoreOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

A cache-control directive configuration.

func (RuleNewParamsBodySetCacheControlRuleActionParametersNoStore) MarshalJSON added in v6.9.0 

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

type RuleNewParamsBodySetCacheControlRuleActionParametersNoStoreOperation added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersNoStoreOperation string

The operation to perform on the cache-control directive. 

const (
	RuleNewParamsBodySetCacheControlRuleActionParametersNoStoreOperationSet    RuleNewParamsBodySetCacheControlRuleActionParametersNoStoreOperation = "set"
	RuleNewParamsBodySetCacheControlRuleActionParametersNoStoreOperationRemove RuleNewParamsBodySetCacheControlRuleActionParametersNoStoreOperation = "remove"
)

func (RuleNewParamsBodySetCacheControlRuleActionParametersNoStoreOperation) IsKnown added in v6.9.0 

func (r RuleNewParamsBodySetCacheControlRuleActionParametersNoStoreOperation) IsKnown() bool

type RuleNewParamsBodySetCacheControlRuleActionParametersNoStoreRemoveDirective added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersNoStoreRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RuleNewParamsBodySetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Remove the directive.

func (RuleNewParamsBodySetCacheControlRuleActionParametersNoStoreRemoveDirective) MarshalJSON added in v6.9.0 

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

type RuleNewParamsBodySetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleNewParamsBodySetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperationSet    RuleNewParamsBodySetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation = "set"
	RuleNewParamsBodySetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperationRemove RuleNewParamsBodySetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation = "remove"
)

func (RuleNewParamsBodySetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleNewParamsBodySetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation) IsKnown() bool

type RuleNewParamsBodySetCacheControlRuleActionParametersNoStoreSetDirective added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersNoStoreSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RuleNewParamsBodySetCacheControlRuleActionParametersNoStoreSetDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Set the directive.

func (RuleNewParamsBodySetCacheControlRuleActionParametersNoStoreSetDirective) MarshalJSON added in v6.9.0 

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

type RuleNewParamsBodySetCacheControlRuleActionParametersNoStoreSetDirectiveOperation added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersNoStoreSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleNewParamsBodySetCacheControlRuleActionParametersNoStoreSetDirectiveOperationSet    RuleNewParamsBodySetCacheControlRuleActionParametersNoStoreSetDirectiveOperation = "set"
	RuleNewParamsBodySetCacheControlRuleActionParametersNoStoreSetDirectiveOperationRemove RuleNewParamsBodySetCacheControlRuleActionParametersNoStoreSetDirectiveOperation = "remove"
)

func (RuleNewParamsBodySetCacheControlRuleActionParametersNoStoreSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleNewParamsBodySetCacheControlRuleActionParametersNoStoreSetDirectiveOperation) IsKnown() bool

type RuleNewParamsBodySetCacheControlRuleActionParametersNoStoreUnion added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersNoStoreUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Satisfied by rulesets.RuleNewParamsBodySetCacheControlRuleActionParametersNoStoreSetDirective, rulesets.RuleNewParamsBodySetCacheControlRuleActionParametersNoStoreRemoveDirective, RuleNewParamsBodySetCacheControlRuleActionParametersNoStore.

type RuleNewParamsBodySetCacheControlRuleActionParametersNoTransform added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersNoTransform struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RuleNewParamsBodySetCacheControlRuleActionParametersNoTransformOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

A cache-control directive configuration.

func (RuleNewParamsBodySetCacheControlRuleActionParametersNoTransform) MarshalJSON added in v6.9.0 

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

type RuleNewParamsBodySetCacheControlRuleActionParametersNoTransformOperation added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersNoTransformOperation string

The operation to perform on the cache-control directive. 

const (
	RuleNewParamsBodySetCacheControlRuleActionParametersNoTransformOperationSet    RuleNewParamsBodySetCacheControlRuleActionParametersNoTransformOperation = "set"
	RuleNewParamsBodySetCacheControlRuleActionParametersNoTransformOperationRemove RuleNewParamsBodySetCacheControlRuleActionParametersNoTransformOperation = "remove"
)

func (RuleNewParamsBodySetCacheControlRuleActionParametersNoTransformOperation) IsKnown added in v6.9.0 

func (r RuleNewParamsBodySetCacheControlRuleActionParametersNoTransformOperation) IsKnown() bool

type RuleNewParamsBodySetCacheControlRuleActionParametersNoTransformRemoveDirective added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersNoTransformRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RuleNewParamsBodySetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Remove the directive.

func (RuleNewParamsBodySetCacheControlRuleActionParametersNoTransformRemoveDirective) MarshalJSON added in v6.9.0 

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

type RuleNewParamsBodySetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleNewParamsBodySetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperationSet    RuleNewParamsBodySetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation = "set"
	RuleNewParamsBodySetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperationRemove RuleNewParamsBodySetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation = "remove"
)

func (RuleNewParamsBodySetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleNewParamsBodySetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation) IsKnown() bool

type RuleNewParamsBodySetCacheControlRuleActionParametersNoTransformSetDirective added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersNoTransformSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RuleNewParamsBodySetCacheControlRuleActionParametersNoTransformSetDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Set the directive.

func (RuleNewParamsBodySetCacheControlRuleActionParametersNoTransformSetDirective) MarshalJSON added in v6.9.0 

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

type RuleNewParamsBodySetCacheControlRuleActionParametersNoTransformSetDirectiveOperation added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersNoTransformSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleNewParamsBodySetCacheControlRuleActionParametersNoTransformSetDirectiveOperationSet    RuleNewParamsBodySetCacheControlRuleActionParametersNoTransformSetDirectiveOperation = "set"
	RuleNewParamsBodySetCacheControlRuleActionParametersNoTransformSetDirectiveOperationRemove RuleNewParamsBodySetCacheControlRuleActionParametersNoTransformSetDirectiveOperation = "remove"
)

func (RuleNewParamsBodySetCacheControlRuleActionParametersNoTransformSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleNewParamsBodySetCacheControlRuleActionParametersNoTransformSetDirectiveOperation) IsKnown() bool

type RuleNewParamsBodySetCacheControlRuleActionParametersNoTransformUnion added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersNoTransformUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Satisfied by rulesets.RuleNewParamsBodySetCacheControlRuleActionParametersNoTransformSetDirective, rulesets.RuleNewParamsBodySetCacheControlRuleActionParametersNoTransformRemoveDirective, RuleNewParamsBodySetCacheControlRuleActionParametersNoTransform.

type RuleNewParamsBodySetCacheControlRuleActionParametersPrivate added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersPrivate struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RuleNewParamsBodySetCacheControlRuleActionParametersPrivateOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool]        `json:"cloudflare_only"`
	Qualifiers     param.Field[interface{}] `json:"qualifiers"`
}

A cache-control directive configuration that accepts optional qualifiers (header names).

func (RuleNewParamsBodySetCacheControlRuleActionParametersPrivate) MarshalJSON added in v6.9.0 

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

type RuleNewParamsBodySetCacheControlRuleActionParametersPrivateOperation added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersPrivateOperation string

The operation to perform on the cache-control directive. 

const (
	RuleNewParamsBodySetCacheControlRuleActionParametersPrivateOperationSet    RuleNewParamsBodySetCacheControlRuleActionParametersPrivateOperation = "set"
	RuleNewParamsBodySetCacheControlRuleActionParametersPrivateOperationRemove RuleNewParamsBodySetCacheControlRuleActionParametersPrivateOperation = "remove"
)

func (RuleNewParamsBodySetCacheControlRuleActionParametersPrivateOperation) IsKnown added in v6.9.0 

func (r RuleNewParamsBodySetCacheControlRuleActionParametersPrivateOperation) IsKnown() bool

type RuleNewParamsBodySetCacheControlRuleActionParametersPrivateRemoveDirective added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersPrivateRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RuleNewParamsBodySetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Remove the directive.

func (RuleNewParamsBodySetCacheControlRuleActionParametersPrivateRemoveDirective) MarshalJSON added in v6.9.0 

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

type RuleNewParamsBodySetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleNewParamsBodySetCacheControlRuleActionParametersPrivateRemoveDirectiveOperationSet    RuleNewParamsBodySetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation = "set"
	RuleNewParamsBodySetCacheControlRuleActionParametersPrivateRemoveDirectiveOperationRemove RuleNewParamsBodySetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation = "remove"
)

func (RuleNewParamsBodySetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleNewParamsBodySetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation) IsKnown() bool

type RuleNewParamsBodySetCacheControlRuleActionParametersPrivateSetDirective added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersPrivateSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RuleNewParamsBodySetCacheControlRuleActionParametersPrivateSetDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
	// Optional list of header names to qualify the directive (e.g., for "private" or
	// "no-cache" directives).
	Qualifiers param.Field[[]string] `json:"qualifiers"`
}

Set the directive with optional qualifiers.

func (RuleNewParamsBodySetCacheControlRuleActionParametersPrivateSetDirective) MarshalJSON added in v6.9.0 

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

type RuleNewParamsBodySetCacheControlRuleActionParametersPrivateSetDirectiveOperation added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersPrivateSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleNewParamsBodySetCacheControlRuleActionParametersPrivateSetDirectiveOperationSet    RuleNewParamsBodySetCacheControlRuleActionParametersPrivateSetDirectiveOperation = "set"
	RuleNewParamsBodySetCacheControlRuleActionParametersPrivateSetDirectiveOperationRemove RuleNewParamsBodySetCacheControlRuleActionParametersPrivateSetDirectiveOperation = "remove"
)

func (RuleNewParamsBodySetCacheControlRuleActionParametersPrivateSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleNewParamsBodySetCacheControlRuleActionParametersPrivateSetDirectiveOperation) IsKnown() bool

type RuleNewParamsBodySetCacheControlRuleActionParametersPrivateUnion added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersPrivateUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts optional qualifiers (header names).

Satisfied by rulesets.RuleNewParamsBodySetCacheControlRuleActionParametersPrivateSetDirective, rulesets.RuleNewParamsBodySetCacheControlRuleActionParametersPrivateRemoveDirective, RuleNewParamsBodySetCacheControlRuleActionParametersPrivate.

type RuleNewParamsBodySetCacheControlRuleActionParametersProxyRevalidate added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersProxyRevalidate struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RuleNewParamsBodySetCacheControlRuleActionParametersProxyRevalidateOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

A cache-control directive configuration.

func (RuleNewParamsBodySetCacheControlRuleActionParametersProxyRevalidate) MarshalJSON added in v6.9.0 

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

type RuleNewParamsBodySetCacheControlRuleActionParametersProxyRevalidateOperation added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersProxyRevalidateOperation string

The operation to perform on the cache-control directive. 

const (
	RuleNewParamsBodySetCacheControlRuleActionParametersProxyRevalidateOperationSet    RuleNewParamsBodySetCacheControlRuleActionParametersProxyRevalidateOperation = "set"
	RuleNewParamsBodySetCacheControlRuleActionParametersProxyRevalidateOperationRemove RuleNewParamsBodySetCacheControlRuleActionParametersProxyRevalidateOperation = "remove"
)

func (RuleNewParamsBodySetCacheControlRuleActionParametersProxyRevalidateOperation) IsKnown added in v6.9.0 

func (r RuleNewParamsBodySetCacheControlRuleActionParametersProxyRevalidateOperation) IsKnown() bool

type RuleNewParamsBodySetCacheControlRuleActionParametersProxyRevalidateRemoveDirective added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersProxyRevalidateRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RuleNewParamsBodySetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Remove the directive.

func (RuleNewParamsBodySetCacheControlRuleActionParametersProxyRevalidateRemoveDirective) MarshalJSON added in v6.9.0 

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

type RuleNewParamsBodySetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleNewParamsBodySetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperationSet    RuleNewParamsBodySetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation = "set"
	RuleNewParamsBodySetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperationRemove RuleNewParamsBodySetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation = "remove"
)

func (RuleNewParamsBodySetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleNewParamsBodySetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation) IsKnown() bool

type RuleNewParamsBodySetCacheControlRuleActionParametersProxyRevalidateSetDirective added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersProxyRevalidateSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RuleNewParamsBodySetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Set the directive.

func (RuleNewParamsBodySetCacheControlRuleActionParametersProxyRevalidateSetDirective) MarshalJSON added in v6.9.0 

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

type RuleNewParamsBodySetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleNewParamsBodySetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperationSet    RuleNewParamsBodySetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation = "set"
	RuleNewParamsBodySetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperationRemove RuleNewParamsBodySetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation = "remove"
)

func (RuleNewParamsBodySetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleNewParamsBodySetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation) IsKnown() bool

type RuleNewParamsBodySetCacheControlRuleActionParametersProxyRevalidateUnion added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersProxyRevalidateUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Satisfied by rulesets.RuleNewParamsBodySetCacheControlRuleActionParametersProxyRevalidateSetDirective, rulesets.RuleNewParamsBodySetCacheControlRuleActionParametersProxyRevalidateRemoveDirective, RuleNewParamsBodySetCacheControlRuleActionParametersProxyRevalidate.

type RuleNewParamsBodySetCacheControlRuleActionParametersPublic added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersPublic struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RuleNewParamsBodySetCacheControlRuleActionParametersPublicOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

A cache-control directive configuration.

func (RuleNewParamsBodySetCacheControlRuleActionParametersPublic) MarshalJSON added in v6.9.0 

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

type RuleNewParamsBodySetCacheControlRuleActionParametersPublicOperation added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersPublicOperation string

The operation to perform on the cache-control directive. 

const (
	RuleNewParamsBodySetCacheControlRuleActionParametersPublicOperationSet    RuleNewParamsBodySetCacheControlRuleActionParametersPublicOperation = "set"
	RuleNewParamsBodySetCacheControlRuleActionParametersPublicOperationRemove RuleNewParamsBodySetCacheControlRuleActionParametersPublicOperation = "remove"
)

func (RuleNewParamsBodySetCacheControlRuleActionParametersPublicOperation) IsKnown added in v6.9.0 

func (r RuleNewParamsBodySetCacheControlRuleActionParametersPublicOperation) IsKnown() bool

type RuleNewParamsBodySetCacheControlRuleActionParametersPublicRemoveDirective added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersPublicRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RuleNewParamsBodySetCacheControlRuleActionParametersPublicRemoveDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Remove the directive.

func (RuleNewParamsBodySetCacheControlRuleActionParametersPublicRemoveDirective) MarshalJSON added in v6.9.0 

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

type RuleNewParamsBodySetCacheControlRuleActionParametersPublicRemoveDirectiveOperation added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersPublicRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleNewParamsBodySetCacheControlRuleActionParametersPublicRemoveDirectiveOperationSet    RuleNewParamsBodySetCacheControlRuleActionParametersPublicRemoveDirectiveOperation = "set"
	RuleNewParamsBodySetCacheControlRuleActionParametersPublicRemoveDirectiveOperationRemove RuleNewParamsBodySetCacheControlRuleActionParametersPublicRemoveDirectiveOperation = "remove"
)

func (RuleNewParamsBodySetCacheControlRuleActionParametersPublicRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleNewParamsBodySetCacheControlRuleActionParametersPublicRemoveDirectiveOperation) IsKnown() bool

type RuleNewParamsBodySetCacheControlRuleActionParametersPublicSetDirective added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersPublicSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RuleNewParamsBodySetCacheControlRuleActionParametersPublicSetDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Set the directive.

func (RuleNewParamsBodySetCacheControlRuleActionParametersPublicSetDirective) MarshalJSON added in v6.9.0 

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

type RuleNewParamsBodySetCacheControlRuleActionParametersPublicSetDirectiveOperation added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersPublicSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleNewParamsBodySetCacheControlRuleActionParametersPublicSetDirectiveOperationSet    RuleNewParamsBodySetCacheControlRuleActionParametersPublicSetDirectiveOperation = "set"
	RuleNewParamsBodySetCacheControlRuleActionParametersPublicSetDirectiveOperationRemove RuleNewParamsBodySetCacheControlRuleActionParametersPublicSetDirectiveOperation = "remove"
)

func (RuleNewParamsBodySetCacheControlRuleActionParametersPublicSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleNewParamsBodySetCacheControlRuleActionParametersPublicSetDirectiveOperation) IsKnown() bool

type RuleNewParamsBodySetCacheControlRuleActionParametersPublicUnion added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersPublicUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Satisfied by rulesets.RuleNewParamsBodySetCacheControlRuleActionParametersPublicSetDirective, rulesets.RuleNewParamsBodySetCacheControlRuleActionParametersPublicRemoveDirective, RuleNewParamsBodySetCacheControlRuleActionParametersPublic.

type RuleNewParamsBodySetCacheControlRuleActionParametersSMaxage added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersSMaxage struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RuleNewParamsBodySetCacheControlRuleActionParametersSMaxageOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
	// The duration value in seconds for the directive.
	Value param.Field[int64] `json:"value"`
}

A cache-control directive configuration that accepts a duration value in seconds.

func (RuleNewParamsBodySetCacheControlRuleActionParametersSMaxage) MarshalJSON added in v6.9.0 

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

type RuleNewParamsBodySetCacheControlRuleActionParametersSMaxageOperation added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersSMaxageOperation string

The operation to perform on the cache-control directive. 

const (
	RuleNewParamsBodySetCacheControlRuleActionParametersSMaxageOperationSet    RuleNewParamsBodySetCacheControlRuleActionParametersSMaxageOperation = "set"
	RuleNewParamsBodySetCacheControlRuleActionParametersSMaxageOperationRemove RuleNewParamsBodySetCacheControlRuleActionParametersSMaxageOperation = "remove"
)

func (RuleNewParamsBodySetCacheControlRuleActionParametersSMaxageOperation) IsKnown added in v6.9.0 

func (r RuleNewParamsBodySetCacheControlRuleActionParametersSMaxageOperation) IsKnown() bool

type RuleNewParamsBodySetCacheControlRuleActionParametersSMaxageRemoveDirective added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersSMaxageRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RuleNewParamsBodySetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Remove the directive.

func (RuleNewParamsBodySetCacheControlRuleActionParametersSMaxageRemoveDirective) MarshalJSON added in v6.9.0 

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

type RuleNewParamsBodySetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleNewParamsBodySetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperationSet    RuleNewParamsBodySetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation = "set"
	RuleNewParamsBodySetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperationRemove RuleNewParamsBodySetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation = "remove"
)

func (RuleNewParamsBodySetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleNewParamsBodySetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation) IsKnown() bool

type RuleNewParamsBodySetCacheControlRuleActionParametersSMaxageSetDirective added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersSMaxageSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RuleNewParamsBodySetCacheControlRuleActionParametersSMaxageSetDirectiveOperation] `json:"operation" api:"required"`
	// The duration value in seconds for the directive.
	Value param.Field[int64] `json:"value" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Set the directive with a duration value in seconds.

func (RuleNewParamsBodySetCacheControlRuleActionParametersSMaxageSetDirective) MarshalJSON added in v6.9.0 

func (r RuleNewParamsBodySetCacheControlRuleActionParametersSMaxageSetDirective) MarshalJSON() (data []byte, err error)

type RuleNewParamsBodySetCacheControlRuleActionParametersSMaxageSetDirectiveOperation added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersSMaxageSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleNewParamsBodySetCacheControlRuleActionParametersSMaxageSetDirectiveOperationSet    RuleNewParamsBodySetCacheControlRuleActionParametersSMaxageSetDirectiveOperation = "set"
	RuleNewParamsBodySetCacheControlRuleActionParametersSMaxageSetDirectiveOperationRemove RuleNewParamsBodySetCacheControlRuleActionParametersSMaxageSetDirectiveOperation = "remove"
)

func (RuleNewParamsBodySetCacheControlRuleActionParametersSMaxageSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleNewParamsBodySetCacheControlRuleActionParametersSMaxageSetDirectiveOperation) IsKnown() bool

type RuleNewParamsBodySetCacheControlRuleActionParametersSMaxageUnion added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersSMaxageUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts a duration value in seconds.

Satisfied by rulesets.RuleNewParamsBodySetCacheControlRuleActionParametersSMaxageSetDirective, rulesets.RuleNewParamsBodySetCacheControlRuleActionParametersSMaxageRemoveDirective, RuleNewParamsBodySetCacheControlRuleActionParametersSMaxage.

type RuleNewParamsBodySetCacheControlRuleActionParametersStaleIfError added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersStaleIfError struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RuleNewParamsBodySetCacheControlRuleActionParametersStaleIfErrorOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
	// The duration value in seconds for the directive.
	Value param.Field[int64] `json:"value"`
}

A cache-control directive configuration that accepts a duration value in seconds.

func (RuleNewParamsBodySetCacheControlRuleActionParametersStaleIfError) MarshalJSON added in v6.9.0 

func (r RuleNewParamsBodySetCacheControlRuleActionParametersStaleIfError) MarshalJSON() (data []byte, err error)

type RuleNewParamsBodySetCacheControlRuleActionParametersStaleIfErrorOperation added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersStaleIfErrorOperation string

The operation to perform on the cache-control directive. 

const (
	RuleNewParamsBodySetCacheControlRuleActionParametersStaleIfErrorOperationSet    RuleNewParamsBodySetCacheControlRuleActionParametersStaleIfErrorOperation = "set"
	RuleNewParamsBodySetCacheControlRuleActionParametersStaleIfErrorOperationRemove RuleNewParamsBodySetCacheControlRuleActionParametersStaleIfErrorOperation = "remove"
)

func (RuleNewParamsBodySetCacheControlRuleActionParametersStaleIfErrorOperation) IsKnown added in v6.9.0 

func (r RuleNewParamsBodySetCacheControlRuleActionParametersStaleIfErrorOperation) IsKnown() bool

type RuleNewParamsBodySetCacheControlRuleActionParametersStaleIfErrorRemoveDirective added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersStaleIfErrorRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RuleNewParamsBodySetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Remove the directive.

func (RuleNewParamsBodySetCacheControlRuleActionParametersStaleIfErrorRemoveDirective) MarshalJSON added in v6.9.0 

func (r RuleNewParamsBodySetCacheControlRuleActionParametersStaleIfErrorRemoveDirective) MarshalJSON() (data []byte, err error)

type RuleNewParamsBodySetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleNewParamsBodySetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperationSet    RuleNewParamsBodySetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation = "set"
	RuleNewParamsBodySetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperationRemove RuleNewParamsBodySetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation = "remove"
)

func (RuleNewParamsBodySetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleNewParamsBodySetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation) IsKnown() bool

type RuleNewParamsBodySetCacheControlRuleActionParametersStaleIfErrorSetDirective added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersStaleIfErrorSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RuleNewParamsBodySetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation] `json:"operation" api:"required"`
	// The duration value in seconds for the directive.
	Value param.Field[int64] `json:"value" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Set the directive with a duration value in seconds.

func (RuleNewParamsBodySetCacheControlRuleActionParametersStaleIfErrorSetDirective) MarshalJSON added in v6.9.0 

func (r RuleNewParamsBodySetCacheControlRuleActionParametersStaleIfErrorSetDirective) MarshalJSON() (data []byte, err error)

type RuleNewParamsBodySetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleNewParamsBodySetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperationSet    RuleNewParamsBodySetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation = "set"
	RuleNewParamsBodySetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperationRemove RuleNewParamsBodySetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation = "remove"
)

func (RuleNewParamsBodySetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleNewParamsBodySetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation) IsKnown() bool

type RuleNewParamsBodySetCacheControlRuleActionParametersStaleIfErrorUnion added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersStaleIfErrorUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts a duration value in seconds.

Satisfied by rulesets.RuleNewParamsBodySetCacheControlRuleActionParametersStaleIfErrorSetDirective, rulesets.RuleNewParamsBodySetCacheControlRuleActionParametersStaleIfErrorRemoveDirective, RuleNewParamsBodySetCacheControlRuleActionParametersStaleIfError.

type RuleNewParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidate added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidate struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RuleNewParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
	// The duration value in seconds for the directive.
	Value param.Field[int64] `json:"value"`
}

A cache-control directive configuration that accepts a duration value in seconds.

func (RuleNewParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidate) MarshalJSON added in v6.9.0 

func (r RuleNewParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidate) MarshalJSON() (data []byte, err error)

type RuleNewParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateOperation added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateOperation string

The operation to perform on the cache-control directive. 

const (
	RuleNewParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateOperationSet    RuleNewParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateOperation = "set"
	RuleNewParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateOperationRemove RuleNewParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateOperation = "remove"
)

func (RuleNewParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateOperation) IsKnown added in v6.9.0 

func (r RuleNewParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateOperation) IsKnown() bool

type RuleNewParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RuleNewParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Remove the directive.

func (RuleNewParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective) MarshalJSON added in v6.9.0 

func (r RuleNewParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective) MarshalJSON() (data []byte, err error)

type RuleNewParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleNewParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperationSet    RuleNewParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation = "set"
	RuleNewParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperationRemove RuleNewParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation = "remove"
)

func (RuleNewParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleNewParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation) IsKnown() bool

type RuleNewParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RuleNewParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation] `json:"operation" api:"required"`
	// The duration value in seconds for the directive.
	Value param.Field[int64] `json:"value" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Set the directive with a duration value in seconds.

func (RuleNewParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective) MarshalJSON added in v6.9.0 

func (r RuleNewParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective) MarshalJSON() (data []byte, err error)

type RuleNewParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleNewParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperationSet    RuleNewParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation = "set"
	RuleNewParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperationRemove RuleNewParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation = "remove"
)

func (RuleNewParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleNewParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation) IsKnown() bool

type RuleNewParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateUnion added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts a duration value in seconds.

Satisfied by rulesets.RuleNewParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective, rulesets.RuleNewParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective, RuleNewParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidate.

type RuleNewParamsBodySetCacheControlRuleExposedCredentialCheck added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleExposedCredentialCheck struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression param.Field[string] `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression param.Field[string] `json:"username_expression" api:"required"`
}

Configuration for exposed credential checking.

func (RuleNewParamsBodySetCacheControlRuleExposedCredentialCheck) MarshalJSON added in v6.9.0 

func (r RuleNewParamsBodySetCacheControlRuleExposedCredentialCheck) MarshalJSON() (data []byte, err error)

type RuleNewParamsBodySetCacheControlRulePosition added in v6.9.0 

type RuleNewParamsBodySetCacheControlRulePosition struct {
	// The ID of another rule to place the rule after. An empty value causes the rule
	// to be placed at the bottom.
	After param.Field[string] `json:"after"`
	// The ID of another rule to place the rule before. An empty value causes the rule
	// to be placed at the top.
	Before param.Field[string] `json:"before"`
	// An index at which to place the rule, where index 1 is the first rule.
	Index param.Field[int64] `json:"index"`
}

An object configuring where the rule will be placed.

func (RuleNewParamsBodySetCacheControlRulePosition) MarshalJSON added in v6.9.0 

func (r RuleNewParamsBodySetCacheControlRulePosition) MarshalJSON() (data []byte, err error)

type RuleNewParamsBodySetCacheControlRulePositionAfterPosition added in v6.9.0 

type RuleNewParamsBodySetCacheControlRulePositionAfterPosition struct {
	// The ID of another rule to place the rule after. An empty value causes the rule
	// to be placed at the bottom.
	After param.Field[string] `json:"after"`
}

An object configuring where the rule will be placed.

func (RuleNewParamsBodySetCacheControlRulePositionAfterPosition) MarshalJSON added in v6.9.0 

func (r RuleNewParamsBodySetCacheControlRulePositionAfterPosition) MarshalJSON() (data []byte, err error)

type RuleNewParamsBodySetCacheControlRulePositionBeforePosition added in v6.9.0 

type RuleNewParamsBodySetCacheControlRulePositionBeforePosition struct {
	// The ID of another rule to place the rule before. An empty value causes the rule
	// to be placed at the top.
	Before param.Field[string] `json:"before"`
}

An object configuring where the rule will be placed.

func (RuleNewParamsBodySetCacheControlRulePositionBeforePosition) MarshalJSON added in v6.9.0 

func (r RuleNewParamsBodySetCacheControlRulePositionBeforePosition) MarshalJSON() (data []byte, err error)

type RuleNewParamsBodySetCacheControlRulePositionIndexPosition added in v6.9.0 

type RuleNewParamsBodySetCacheControlRulePositionIndexPosition struct {
	// An index at which to place the rule, where index 1 is the first rule.
	Index param.Field[int64] `json:"index"`
}

An object configuring where the rule will be placed.

func (RuleNewParamsBodySetCacheControlRulePositionIndexPosition) MarshalJSON added in v6.9.0 

func (r RuleNewParamsBodySetCacheControlRulePositionIndexPosition) MarshalJSON() (data []byte, err error)

type RuleNewParamsBodySetCacheControlRulePositionUnion added in v6.9.0 

type RuleNewParamsBodySetCacheControlRulePositionUnion interface {
	// contains filtered or unexported methods
}

An object configuring where the rule will be placed.

Satisfied by rulesets.RuleNewParamsBodySetCacheControlRulePositionBeforePosition, rulesets.RuleNewParamsBodySetCacheControlRulePositionAfterPosition, rulesets.RuleNewParamsBodySetCacheControlRulePositionIndexPosition, RuleNewParamsBodySetCacheControlRulePosition.

type RuleNewParamsBodySetCacheControlRuleRatelimit added in v6.9.0 

type RuleNewParamsBodySetCacheControlRuleRatelimit struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics param.Field[[]string] `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period param.Field[int64] `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression param.Field[string] `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout param.Field[int64] `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod param.Field[int64] `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin param.Field[bool] `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod param.Field[int64] `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName param.Field[string] `json:"score_response_header_name"`
}

An object configuring the rule's rate limit behavior.

func (RuleNewParamsBodySetCacheControlRuleRatelimit) MarshalJSON added in v6.9.0 

func (r RuleNewParamsBodySetCacheControlRuleRatelimit) MarshalJSON() (data []byte, err error)

type RuleNewParamsBodySetCacheSettingsRule 

type RuleNewParamsBodySetCacheSettingsRule struct {
	// An object configuring where the rule will be placed.
	Position param.Field[RuleNewParamsBodySetCacheSettingsRulePositionUnion] `json:"position"`
	SetCacheSettingsRuleParam
}

func (RuleNewParamsBodySetCacheSettingsRule) MarshalJSON 

func (r RuleNewParamsBodySetCacheSettingsRule) MarshalJSON() (data []byte, err error)

type RuleNewParamsBodySetCacheSettingsRulePosition 

type RuleNewParamsBodySetCacheSettingsRulePosition struct {
	// The ID of another rule to place the rule after. An empty value causes the rule
	// to be placed at the bottom.
	After param.Field[string] `json:"after"`
	// The ID of another rule to place the rule before. An empty value causes the rule
	// to be placed at the top.
	Before param.Field[string] `json:"before"`
	// An index at which to place the rule, where index 1 is the first rule.
	Index param.Field[int64] `json:"index"`
}

An object configuring where the rule will be placed.

func (RuleNewParamsBodySetCacheSettingsRulePosition) MarshalJSON 

func (r RuleNewParamsBodySetCacheSettingsRulePosition) MarshalJSON() (data []byte, err error)

type RuleNewParamsBodySetCacheSettingsRulePositionAfterPosition 

type RuleNewParamsBodySetCacheSettingsRulePositionAfterPosition struct {
	// The ID of another rule to place the rule after. An empty value causes the rule
	// to be placed at the bottom.
	After param.Field[string] `json:"after"`
}

An object configuring where the rule will be placed.

func (RuleNewParamsBodySetCacheSettingsRulePositionAfterPosition) MarshalJSON 

func (r RuleNewParamsBodySetCacheSettingsRulePositionAfterPosition) MarshalJSON() (data []byte, err error)

type RuleNewParamsBodySetCacheSettingsRulePositionBeforePosition 

type RuleNewParamsBodySetCacheSettingsRulePositionBeforePosition struct {
	// The ID of another rule to place the rule before. An empty value causes the rule
	// to be placed at the top.
	Before param.Field[string] `json:"before"`
}

An object configuring where the rule will be placed.

func (RuleNewParamsBodySetCacheSettingsRulePositionBeforePosition) MarshalJSON 

func (r RuleNewParamsBodySetCacheSettingsRulePositionBeforePosition) MarshalJSON() (data []byte, err error)

type RuleNewParamsBodySetCacheSettingsRulePositionIndexPosition 

type RuleNewParamsBodySetCacheSettingsRulePositionIndexPosition struct {
	// An index at which to place the rule, where index 1 is the first rule.
	Index param.Field[int64] `json:"index"`
}

An object configuring where the rule will be placed.

func (RuleNewParamsBodySetCacheSettingsRulePositionIndexPosition) MarshalJSON 

func (r RuleNewParamsBodySetCacheSettingsRulePositionIndexPosition) MarshalJSON() (data []byte, err error)

type RuleNewParamsBodySetCacheSettingsRulePositionUnion 

type RuleNewParamsBodySetCacheSettingsRulePositionUnion interface {
	// contains filtered or unexported methods
}

An object configuring where the rule will be placed.

Satisfied by rulesets.RuleNewParamsBodySetCacheSettingsRulePositionBeforePosition, rulesets.RuleNewParamsBodySetCacheSettingsRulePositionAfterPosition, rulesets.RuleNewParamsBodySetCacheSettingsRulePositionIndexPosition, RuleNewParamsBodySetCacheSettingsRulePosition.

type RuleNewParamsBodySetCacheTagsRule added in v6.9.0 

type RuleNewParamsBodySetCacheTagsRule struct {
	// The unique ID of the rule.
	ID param.Field[string] `json:"id"`
	// The action to perform when the rule matches.
	Action param.Field[RuleNewParamsBodySetCacheTagsRuleAction] `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters param.Field[RuleNewParamsBodySetCacheTagsRuleActionParametersUnion] `json:"action_parameters"`
	// An informative description of the rule.
	Description param.Field[string] `json:"description"`
	// Whether the rule should be executed.
	Enabled param.Field[bool] `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck param.Field[RuleNewParamsBodySetCacheTagsRuleExposedCredentialCheck] `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression param.Field[string] `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging param.Field[LoggingParam] `json:"logging"`
	// An object configuring where the rule will be placed.
	Position param.Field[RuleNewParamsBodySetCacheTagsRulePositionUnion] `json:"position"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit param.Field[RuleNewParamsBodySetCacheTagsRuleRatelimit] `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref param.Field[string] `json:"ref"`
}

func (RuleNewParamsBodySetCacheTagsRule) MarshalJSON added in v6.9.0 

func (r RuleNewParamsBodySetCacheTagsRule) MarshalJSON() (data []byte, err error)

type RuleNewParamsBodySetCacheTagsRuleAction added in v6.9.0 

type RuleNewParamsBodySetCacheTagsRuleAction string

The action to perform when the rule matches. 

const (
	RuleNewParamsBodySetCacheTagsRuleActionSetCacheTags RuleNewParamsBodySetCacheTagsRuleAction = "set_cache_tags"
)

func (RuleNewParamsBodySetCacheTagsRuleAction) IsKnown added in v6.9.0 

func (r RuleNewParamsBodySetCacheTagsRuleAction) IsKnown() bool

type RuleNewParamsBodySetCacheTagsRuleActionParameters added in v6.9.0 

type RuleNewParamsBodySetCacheTagsRuleActionParameters struct {
	// The operation to perform on the cache tags.
	Operation param.Field[RuleNewParamsBodySetCacheTagsRuleActionParametersOperation] `json:"operation" api:"required"`
	// An expression that evaluates to an array of cache tag values.
	Expression param.Field[string]      `json:"expression"`
	Values     param.Field[interface{}] `json:"values"`
}

The parameters configuring the rule's action.

func (RuleNewParamsBodySetCacheTagsRuleActionParameters) MarshalJSON added in v6.9.0 

func (r RuleNewParamsBodySetCacheTagsRuleActionParameters) MarshalJSON() (data []byte, err error)

type RuleNewParamsBodySetCacheTagsRuleActionParametersAddCacheTagsExpression added in v6.9.0 

type RuleNewParamsBodySetCacheTagsRuleActionParametersAddCacheTagsExpression struct {
	// An expression that evaluates to an array of cache tag values.
	Expression param.Field[string] `json:"expression" api:"required"`
	// The operation to perform on the cache tags.
	Operation param.Field[RuleNewParamsBodySetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation] `json:"operation" api:"required"`
}

Add cache tags using an expression.

func (RuleNewParamsBodySetCacheTagsRuleActionParametersAddCacheTagsExpression) MarshalJSON added in v6.9.0 

func (r RuleNewParamsBodySetCacheTagsRuleActionParametersAddCacheTagsExpression) MarshalJSON() (data []byte, err error)

type RuleNewParamsBodySetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation added in v6.9.0 

type RuleNewParamsBodySetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation string

The operation to perform on the cache tags. 

const (
	RuleNewParamsBodySetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationAdd    RuleNewParamsBodySetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "add"
	RuleNewParamsBodySetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationRemove RuleNewParamsBodySetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "remove"
	RuleNewParamsBodySetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationSet    RuleNewParamsBodySetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "set"
)

func (RuleNewParamsBodySetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation) IsKnown added in v6.9.0 

func (r RuleNewParamsBodySetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation) IsKnown() bool

type RuleNewParamsBodySetCacheTagsRuleActionParametersAddCacheTagsValues added in v6.9.0 

type RuleNewParamsBodySetCacheTagsRuleActionParametersAddCacheTagsValues struct {
	// The operation to perform on the cache tags.
	Operation param.Field[RuleNewParamsBodySetCacheTagsRuleActionParametersAddCacheTagsValuesOperation] `json:"operation" api:"required"`
	// A list of cache tag values.
	Values param.Field[[]string] `json:"values" api:"required"`
}

Add cache tags using a list of values.

func (RuleNewParamsBodySetCacheTagsRuleActionParametersAddCacheTagsValues) MarshalJSON added in v6.9.0 

func (r RuleNewParamsBodySetCacheTagsRuleActionParametersAddCacheTagsValues) MarshalJSON() (data []byte, err error)

type RuleNewParamsBodySetCacheTagsRuleActionParametersAddCacheTagsValuesOperation added in v6.9.0 

type RuleNewParamsBodySetCacheTagsRuleActionParametersAddCacheTagsValuesOperation string

The operation to perform on the cache tags. 

const (
	RuleNewParamsBodySetCacheTagsRuleActionParametersAddCacheTagsValuesOperationAdd    RuleNewParamsBodySetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "add"
	RuleNewParamsBodySetCacheTagsRuleActionParametersAddCacheTagsValuesOperationRemove RuleNewParamsBodySetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "remove"
	RuleNewParamsBodySetCacheTagsRuleActionParametersAddCacheTagsValuesOperationSet    RuleNewParamsBodySetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "set"
)

func (RuleNewParamsBodySetCacheTagsRuleActionParametersAddCacheTagsValuesOperation) IsKnown added in v6.9.0 

func (r RuleNewParamsBodySetCacheTagsRuleActionParametersAddCacheTagsValuesOperation) IsKnown() bool

type RuleNewParamsBodySetCacheTagsRuleActionParametersOperation added in v6.9.0 

type RuleNewParamsBodySetCacheTagsRuleActionParametersOperation string

The operation to perform on the cache tags. 

const (
	RuleNewParamsBodySetCacheTagsRuleActionParametersOperationAdd    RuleNewParamsBodySetCacheTagsRuleActionParametersOperation = "add"
	RuleNewParamsBodySetCacheTagsRuleActionParametersOperationRemove RuleNewParamsBodySetCacheTagsRuleActionParametersOperation = "remove"
	RuleNewParamsBodySetCacheTagsRuleActionParametersOperationSet    RuleNewParamsBodySetCacheTagsRuleActionParametersOperation = "set"
)

func (RuleNewParamsBodySetCacheTagsRuleActionParametersOperation) IsKnown added in v6.9.0 

func (r RuleNewParamsBodySetCacheTagsRuleActionParametersOperation) IsKnown() bool

type RuleNewParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsExpression added in v6.9.0 

type RuleNewParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsExpression struct {
	// An expression that evaluates to an array of cache tag values.
	Expression param.Field[string] `json:"expression" api:"required"`
	// The operation to perform on the cache tags.
	Operation param.Field[RuleNewParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation] `json:"operation" api:"required"`
}

Remove cache tags using an expression.

func (RuleNewParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsExpression) MarshalJSON added in v6.9.0 

func (r RuleNewParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsExpression) MarshalJSON() (data []byte, err error)

type RuleNewParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation added in v6.9.0 

type RuleNewParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation string

The operation to perform on the cache tags. 

const (
	RuleNewParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationAdd    RuleNewParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "add"
	RuleNewParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationRemove RuleNewParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "remove"
	RuleNewParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationSet    RuleNewParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "set"
)

func (RuleNewParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation) IsKnown added in v6.9.0 

func (r RuleNewParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation) IsKnown() bool

type RuleNewParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsValues added in v6.9.0 

type RuleNewParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsValues struct {
	// The operation to perform on the cache tags.
	Operation param.Field[RuleNewParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation] `json:"operation" api:"required"`
	// A list of cache tag values.
	Values param.Field[[]string] `json:"values" api:"required"`
}

Remove cache tags using a list of values.

func (RuleNewParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsValues) MarshalJSON added in v6.9.0 

func (r RuleNewParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsValues) MarshalJSON() (data []byte, err error)

type RuleNewParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation added in v6.9.0 

type RuleNewParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation string

The operation to perform on the cache tags. 

const (
	RuleNewParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationAdd    RuleNewParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "add"
	RuleNewParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationRemove RuleNewParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "remove"
	RuleNewParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationSet    RuleNewParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "set"
)

func (RuleNewParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation) IsKnown added in v6.9.0 

func (r RuleNewParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation) IsKnown() bool

type RuleNewParamsBodySetCacheTagsRuleActionParametersSetCacheTagsExpression added in v6.9.0 

type RuleNewParamsBodySetCacheTagsRuleActionParametersSetCacheTagsExpression struct {
	// An expression that evaluates to an array of cache tag values.
	Expression param.Field[string] `json:"expression" api:"required"`
	// The operation to perform on the cache tags.
	Operation param.Field[RuleNewParamsBodySetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation] `json:"operation" api:"required"`
}

Set cache tags using an expression.

func (RuleNewParamsBodySetCacheTagsRuleActionParametersSetCacheTagsExpression) MarshalJSON added in v6.9.0 

func (r RuleNewParamsBodySetCacheTagsRuleActionParametersSetCacheTagsExpression) MarshalJSON() (data []byte, err error)

type RuleNewParamsBodySetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation added in v6.9.0 

type RuleNewParamsBodySetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation string

The operation to perform on the cache tags. 

const (
	RuleNewParamsBodySetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationAdd    RuleNewParamsBodySetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "add"
	RuleNewParamsBodySetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationRemove RuleNewParamsBodySetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "remove"
	RuleNewParamsBodySetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationSet    RuleNewParamsBodySetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "set"
)

func (RuleNewParamsBodySetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation) IsKnown added in v6.9.0 

func (r RuleNewParamsBodySetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation) IsKnown() bool

type RuleNewParamsBodySetCacheTagsRuleActionParametersSetCacheTagsValues added in v6.9.0 

type RuleNewParamsBodySetCacheTagsRuleActionParametersSetCacheTagsValues struct {
	// The operation to perform on the cache tags.
	Operation param.Field[RuleNewParamsBodySetCacheTagsRuleActionParametersSetCacheTagsValuesOperation] `json:"operation" api:"required"`
	// A list of cache tag values.
	Values param.Field[[]string] `json:"values" api:"required"`
}

Set cache tags using a list of values.

func (RuleNewParamsBodySetCacheTagsRuleActionParametersSetCacheTagsValues) MarshalJSON added in v6.9.0 

func (r RuleNewParamsBodySetCacheTagsRuleActionParametersSetCacheTagsValues) MarshalJSON() (data []byte, err error)

type RuleNewParamsBodySetCacheTagsRuleActionParametersSetCacheTagsValuesOperation added in v6.9.0 

type RuleNewParamsBodySetCacheTagsRuleActionParametersSetCacheTagsValuesOperation string

The operation to perform on the cache tags. 

const (
	RuleNewParamsBodySetCacheTagsRuleActionParametersSetCacheTagsValuesOperationAdd    RuleNewParamsBodySetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "add"
	RuleNewParamsBodySetCacheTagsRuleActionParametersSetCacheTagsValuesOperationRemove RuleNewParamsBodySetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "remove"
	RuleNewParamsBodySetCacheTagsRuleActionParametersSetCacheTagsValuesOperationSet    RuleNewParamsBodySetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "set"
)

func (RuleNewParamsBodySetCacheTagsRuleActionParametersSetCacheTagsValuesOperation) IsKnown added in v6.9.0 

func (r RuleNewParamsBodySetCacheTagsRuleActionParametersSetCacheTagsValuesOperation) IsKnown() bool

type RuleNewParamsBodySetCacheTagsRuleActionParametersUnion added in v6.9.0 

type RuleNewParamsBodySetCacheTagsRuleActionParametersUnion interface {
	// contains filtered or unexported methods
}

The parameters configuring the rule's action.

Satisfied by rulesets.RuleNewParamsBodySetCacheTagsRuleActionParametersAddCacheTagsValues, rulesets.RuleNewParamsBodySetCacheTagsRuleActionParametersAddCacheTagsExpression, rulesets.RuleNewParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsValues, rulesets.RuleNewParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsExpression, rulesets.RuleNewParamsBodySetCacheTagsRuleActionParametersSetCacheTagsValues, rulesets.RuleNewParamsBodySetCacheTagsRuleActionParametersSetCacheTagsExpression, RuleNewParamsBodySetCacheTagsRuleActionParameters.

type RuleNewParamsBodySetCacheTagsRuleExposedCredentialCheck added in v6.9.0 

type RuleNewParamsBodySetCacheTagsRuleExposedCredentialCheck struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression param.Field[string] `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression param.Field[string] `json:"username_expression" api:"required"`
}

Configuration for exposed credential checking.

func (RuleNewParamsBodySetCacheTagsRuleExposedCredentialCheck) MarshalJSON added in v6.9.0 

func (r RuleNewParamsBodySetCacheTagsRuleExposedCredentialCheck) MarshalJSON() (data []byte, err error)

type RuleNewParamsBodySetCacheTagsRulePosition added in v6.9.0 

type RuleNewParamsBodySetCacheTagsRulePosition struct {
	// The ID of another rule to place the rule after. An empty value causes the rule
	// to be placed at the bottom.
	After param.Field[string] `json:"after"`
	// The ID of another rule to place the rule before. An empty value causes the rule
	// to be placed at the top.
	Before param.Field[string] `json:"before"`
	// An index at which to place the rule, where index 1 is the first rule.
	Index param.Field[int64] `json:"index"`
}

An object configuring where the rule will be placed.

func (RuleNewParamsBodySetCacheTagsRulePosition) MarshalJSON added in v6.9.0 

func (r RuleNewParamsBodySetCacheTagsRulePosition) MarshalJSON() (data []byte, err error)

type RuleNewParamsBodySetCacheTagsRulePositionAfterPosition added in v6.9.0 

type RuleNewParamsBodySetCacheTagsRulePositionAfterPosition struct {
	// The ID of another rule to place the rule after. An empty value causes the rule
	// to be placed at the bottom.
	After param.Field[string] `json:"after"`
}

An object configuring where the rule will be placed.

func (RuleNewParamsBodySetCacheTagsRulePositionAfterPosition) MarshalJSON added in v6.9.0 

func (r RuleNewParamsBodySetCacheTagsRulePositionAfterPosition) MarshalJSON() (data []byte, err error)

type RuleNewParamsBodySetCacheTagsRulePositionBeforePosition added in v6.9.0 

type RuleNewParamsBodySetCacheTagsRulePositionBeforePosition struct {
	// The ID of another rule to place the rule before. An empty value causes the rule
	// to be placed at the top.
	Before param.Field[string] `json:"before"`
}

An object configuring where the rule will be placed.

func (RuleNewParamsBodySetCacheTagsRulePositionBeforePosition) MarshalJSON added in v6.9.0 

func (r RuleNewParamsBodySetCacheTagsRulePositionBeforePosition) MarshalJSON() (data []byte, err error)

type RuleNewParamsBodySetCacheTagsRulePositionIndexPosition added in v6.9.0 

type RuleNewParamsBodySetCacheTagsRulePositionIndexPosition struct {
	// An index at which to place the rule, where index 1 is the first rule.
	Index param.Field[int64] `json:"index"`
}

An object configuring where the rule will be placed.

func (RuleNewParamsBodySetCacheTagsRulePositionIndexPosition) MarshalJSON added in v6.9.0 

func (r RuleNewParamsBodySetCacheTagsRulePositionIndexPosition) MarshalJSON() (data []byte, err error)

type RuleNewParamsBodySetCacheTagsRulePositionUnion added in v6.9.0 

type RuleNewParamsBodySetCacheTagsRulePositionUnion interface {
	// contains filtered or unexported methods
}

An object configuring where the rule will be placed.

Satisfied by rulesets.RuleNewParamsBodySetCacheTagsRulePositionBeforePosition, rulesets.RuleNewParamsBodySetCacheTagsRulePositionAfterPosition, rulesets.RuleNewParamsBodySetCacheTagsRulePositionIndexPosition, RuleNewParamsBodySetCacheTagsRulePosition.

type RuleNewParamsBodySetCacheTagsRuleRatelimit added in v6.9.0 

type RuleNewParamsBodySetCacheTagsRuleRatelimit struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics param.Field[[]string] `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period param.Field[int64] `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression param.Field[string] `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout param.Field[int64] `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod param.Field[int64] `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin param.Field[bool] `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod param.Field[int64] `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName param.Field[string] `json:"score_response_header_name"`
}

An object configuring the rule's rate limit behavior.

func (RuleNewParamsBodySetCacheTagsRuleRatelimit) MarshalJSON added in v6.9.0 

func (r RuleNewParamsBodySetCacheTagsRuleRatelimit) MarshalJSON() (data []byte, err error)

type RuleNewParamsBodySetConfigurationRule 

type RuleNewParamsBodySetConfigurationRule struct {
	// An object configuring where the rule will be placed.
	Position param.Field[RuleNewParamsBodySetConfigurationRulePositionUnion] `json:"position"`
	SetConfigRuleParam
}

func (RuleNewParamsBodySetConfigurationRule) MarshalJSON 

func (r RuleNewParamsBodySetConfigurationRule) MarshalJSON() (data []byte, err error)

type RuleNewParamsBodySetConfigurationRulePosition 

type RuleNewParamsBodySetConfigurationRulePosition struct {
	// The ID of another rule to place the rule after. An empty value causes the rule
	// to be placed at the bottom.
	After param.Field[string] `json:"after"`
	// The ID of another rule to place the rule before. An empty value causes the rule
	// to be placed at the top.
	Before param.Field[string] `json:"before"`
	// An index at which to place the rule, where index 1 is the first rule.
	Index param.Field[int64] `json:"index"`
}

An object configuring where the rule will be placed.

func (RuleNewParamsBodySetConfigurationRulePosition) MarshalJSON 

func (r RuleNewParamsBodySetConfigurationRulePosition) MarshalJSON() (data []byte, err error)

type RuleNewParamsBodySetConfigurationRulePositionAfterPosition 

type RuleNewParamsBodySetConfigurationRulePositionAfterPosition struct {
	// The ID of another rule to place the rule after. An empty value causes the rule
	// to be placed at the bottom.
	After param.Field[string] `json:"after"`
}

An object configuring where the rule will be placed.

func (RuleNewParamsBodySetConfigurationRulePositionAfterPosition) MarshalJSON 

func (r RuleNewParamsBodySetConfigurationRulePositionAfterPosition) MarshalJSON() (data []byte, err error)

type RuleNewParamsBodySetConfigurationRulePositionBeforePosition 

type RuleNewParamsBodySetConfigurationRulePositionBeforePosition struct {
	// The ID of another rule to place the rule before. An empty value causes the rule
	// to be placed at the top.
	Before param.Field[string] `json:"before"`
}

An object configuring where the rule will be placed.

func (RuleNewParamsBodySetConfigurationRulePositionBeforePosition) MarshalJSON 

func (r RuleNewParamsBodySetConfigurationRulePositionBeforePosition) MarshalJSON() (data []byte, err error)

type RuleNewParamsBodySetConfigurationRulePositionIndexPosition 

type RuleNewParamsBodySetConfigurationRulePositionIndexPosition struct {
	// An index at which to place the rule, where index 1 is the first rule.
	Index param.Field[int64] `json:"index"`
}

An object configuring where the rule will be placed.

func (RuleNewParamsBodySetConfigurationRulePositionIndexPosition) MarshalJSON 

func (r RuleNewParamsBodySetConfigurationRulePositionIndexPosition) MarshalJSON() (data []byte, err error)

type RuleNewParamsBodySetConfigurationRulePositionUnion 

type RuleNewParamsBodySetConfigurationRulePositionUnion interface {
	// contains filtered or unexported methods
}

An object configuring where the rule will be placed.

Satisfied by rulesets.RuleNewParamsBodySetConfigurationRulePositionBeforePosition, rulesets.RuleNewParamsBodySetConfigurationRulePositionAfterPosition, rulesets.RuleNewParamsBodySetConfigurationRulePositionIndexPosition, RuleNewParamsBodySetConfigurationRulePosition.

type RuleNewParamsBodySkipRule 

type RuleNewParamsBodySkipRule struct {
	// An object configuring where the rule will be placed.
	Position param.Field[RuleNewParamsBodySkipRulePositionUnion] `json:"position"`
	SkipRuleParam
}

func (RuleNewParamsBodySkipRule) MarshalJSON 

func (r RuleNewParamsBodySkipRule) MarshalJSON() (data []byte, err error)

type RuleNewParamsBodySkipRulePosition 

type RuleNewParamsBodySkipRulePosition struct {
	// The ID of another rule to place the rule after. An empty value causes the rule
	// to be placed at the bottom.
	After param.Field[string] `json:"after"`
	// The ID of another rule to place the rule before. An empty value causes the rule
	// to be placed at the top.
	Before param.Field[string] `json:"before"`
	// An index at which to place the rule, where index 1 is the first rule.
	Index param.Field[int64] `json:"index"`
}

An object configuring where the rule will be placed.

func (RuleNewParamsBodySkipRulePosition) MarshalJSON 

func (r RuleNewParamsBodySkipRulePosition) MarshalJSON() (data []byte, err error)

type RuleNewParamsBodySkipRulePositionAfterPosition 

type RuleNewParamsBodySkipRulePositionAfterPosition struct {
	// The ID of another rule to place the rule after. An empty value causes the rule
	// to be placed at the bottom.
	After param.Field[string] `json:"after"`
}

An object configuring where the rule will be placed.

func (RuleNewParamsBodySkipRulePositionAfterPosition) MarshalJSON 

func (r RuleNewParamsBodySkipRulePositionAfterPosition) MarshalJSON() (data []byte, err error)

type RuleNewParamsBodySkipRulePositionBeforePosition 

type RuleNewParamsBodySkipRulePositionBeforePosition struct {
	// The ID of another rule to place the rule before. An empty value causes the rule
	// to be placed at the top.
	Before param.Field[string] `json:"before"`
}

An object configuring where the rule will be placed.

func (RuleNewParamsBodySkipRulePositionBeforePosition) MarshalJSON 

func (r RuleNewParamsBodySkipRulePositionBeforePosition) MarshalJSON() (data []byte, err error)

type RuleNewParamsBodySkipRulePositionIndexPosition 

type RuleNewParamsBodySkipRulePositionIndexPosition struct {
	// An index at which to place the rule, where index 1 is the first rule.
	Index param.Field[int64] `json:"index"`
}

An object configuring where the rule will be placed.

func (RuleNewParamsBodySkipRulePositionIndexPosition) MarshalJSON 

func (r RuleNewParamsBodySkipRulePositionIndexPosition) MarshalJSON() (data []byte, err error)

type RuleNewParamsBodySkipRulePositionUnion 

type RuleNewParamsBodySkipRulePositionUnion interface {
	// contains filtered or unexported methods
}

An object configuring where the rule will be placed.

Satisfied by rulesets.RuleNewParamsBodySkipRulePositionBeforePosition, rulesets.RuleNewParamsBodySkipRulePositionAfterPosition, rulesets.RuleNewParamsBodySkipRulePositionIndexPosition, RuleNewParamsBodySkipRulePosition.

type RuleNewParamsBodyUnion 

type RuleNewParamsBodyUnion interface {
	// contains filtered or unexported methods
}

Satisfied by rulesets.RuleNewParamsBodyBlockRule, rulesets.RuleNewParamsBodyChallengeRule, rulesets.RuleNewParamsBodyResponseCompressionRule, rulesets.RuleNewParamsBodyDDoSDynamicRule, rulesets.RuleNewParamsBodyExecuteRule, rulesets.RuleNewParamsBodyForceConnectionCloseRule, rulesets.RuleNewParamsBodyJavaScriptChallengeRule, rulesets.RuleNewParamsBodyLogRule, rulesets.RuleNewParamsBodyLogCustomFieldRule, rulesets.RuleNewParamsBodyManagedChallengeRule, rulesets.RuleNewParamsBodyRedirectRule, rulesets.RuleNewParamsBodyRewriteRule, rulesets.RuleNewParamsBodyRouteRule, rulesets.RuleNewParamsBodyScoreRule, rulesets.RuleNewParamsBodyServeErrorRule, rulesets.RuleNewParamsBodySetCacheControlRule, rulesets.RuleNewParamsBodySetCacheSettingsRule, rulesets.RuleNewParamsBodySetCacheTagsRule, rulesets.RuleNewParamsBodySetConfigurationRule, rulesets.RuleNewParamsBodySkipRule, RuleNewParamsBody.

type RuleNewResponse 

type RuleNewResponse struct {
	// The unique ID of the ruleset.
	ID string `json:"id" api:"required"`
	// The kind of the ruleset.
	Kind Kind `json:"kind" api:"required"`
	// The timestamp of when the ruleset was last modified.
	LastUpdated time.Time `json:"last_updated" api:"required" format:"date-time"`
	// The human-readable name of the ruleset.
	Name string `json:"name" api:"required"`
	// The phase of the ruleset.
	Phase Phase `json:"phase" api:"required"`
	// The list of rules in the ruleset.
	Rules []RuleNewResponseRule `json:"rules" api:"required"`
	// The version of the ruleset.
	Version string `json:"version" api:"required"`
	// An informative description of the ruleset.
	Description string              `json:"description"`
	JSON        ruleNewResponseJSON `json:"-"`
}

A ruleset object.

func (*RuleNewResponse) UnmarshalJSON 

func (r *RuleNewResponse) UnmarshalJSON(data []byte) (err error)

type RuleNewResponseEnvelope 

type RuleNewResponseEnvelope struct {
	// A list of error messages.
	Errors []RuleNewResponseEnvelopeErrors `json:"errors" api:"required"`
	// A list of warning messages.
	Messages []RuleNewResponseEnvelopeMessages `json:"messages" api:"required"`
	// A ruleset object.
	Result RuleNewResponse `json:"result" api:"required"`
	// Whether the API call was successful.
	Success RuleNewResponseEnvelopeSuccess `json:"success" api:"required"`
	JSON    ruleNewResponseEnvelopeJSON    `json:"-"`
}

A response object.

func (*RuleNewResponseEnvelope) UnmarshalJSON 

func (r *RuleNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type RuleNewResponseEnvelopeErrors 

type RuleNewResponseEnvelopeErrors struct {
	// A text description of this message.
	Message string `json:"message" api:"required"`
	// A unique code for this message.
	Code int64 `json:"code"`
	// The source of this message.
	Source RuleNewResponseEnvelopeErrorsSource `json:"source"`
	JSON   ruleNewResponseEnvelopeErrorsJSON   `json:"-"`
}

A message.

func (*RuleNewResponseEnvelopeErrors) UnmarshalJSON 

func (r *RuleNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type RuleNewResponseEnvelopeErrorsSource 

type RuleNewResponseEnvelopeErrorsSource struct {
	// A JSON pointer to the field that is the source of the message.
	Pointer string                                  `json:"pointer" api:"required"`
	JSON    ruleNewResponseEnvelopeErrorsSourceJSON `json:"-"`
}

The source of this message.

func (*RuleNewResponseEnvelopeErrorsSource) UnmarshalJSON 

func (r *RuleNewResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)

type RuleNewResponseEnvelopeMessages 

type RuleNewResponseEnvelopeMessages struct {
	// A text description of this message.
	Message string `json:"message" api:"required"`
	// A unique code for this message.
	Code int64 `json:"code"`
	// The source of this message.
	Source RuleNewResponseEnvelopeMessagesSource `json:"source"`
	JSON   ruleNewResponseEnvelopeMessagesJSON   `json:"-"`
}

A message.

func (*RuleNewResponseEnvelopeMessages) UnmarshalJSON 

func (r *RuleNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type RuleNewResponseEnvelopeMessagesSource 

type RuleNewResponseEnvelopeMessagesSource struct {
	// A JSON pointer to the field that is the source of the message.
	Pointer string                                    `json:"pointer" api:"required"`
	JSON    ruleNewResponseEnvelopeMessagesSourceJSON `json:"-"`
}

The source of this message.

func (*RuleNewResponseEnvelopeMessagesSource) UnmarshalJSON 

func (r *RuleNewResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)

type RuleNewResponseEnvelopeSuccess 

type RuleNewResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	RuleNewResponseEnvelopeSuccessTrue RuleNewResponseEnvelopeSuccess = true
)

func (RuleNewResponseEnvelopeSuccess) IsKnown 

func (r RuleNewResponseEnvelopeSuccess) IsKnown() bool

type RuleNewResponseRule 

type RuleNewResponseRule struct {
	// The timestamp of when the rule was last modified.
	LastUpdated time.Time `json:"last_updated" api:"required" format:"date-time"`
	// The version of the rule.
	Version string `json:"version" api:"required"`
	// The unique ID of the rule.
	ID string `json:"id"`
	// The action to perform when the rule matches.
	Action RuleNewResponseRulesAction `json:"action"`
	// This field can have the runtime type of [BlockRuleActionParameters],
	// [interface{}], [CompressResponseRuleActionParameters],
	// [ExecuteRuleActionParameters], [LogCustomFieldRuleActionParameters],
	// [RedirectRuleActionParameters], [RewriteRuleActionParameters],
	// [RouteRuleActionParameters], [ScoreRuleActionParameters],
	// [ServeErrorRuleActionParameters],
	// [RuleNewResponseRulesRulesetsSetCacheControlRuleActionParameters],
	// [SetCacheSettingsRuleActionParameters],
	// [RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParameters],
	// [SetConfigRuleActionParameters], [SkipRuleActionParameters].
	ActionParameters interface{} `json:"action_parameters"`
	// This field can have the runtime type of [[]string].
	Categories interface{} `json:"categories"`
	// An informative description of the rule.
	Description string `json:"description"`
	// Whether the rule should be executed.
	Enabled bool `json:"enabled"`
	// This field can have the runtime type of [BlockRuleExposedCredentialCheck],
	// [RuleNewResponseRulesRulesetsChallengeRuleExposedCredentialCheck],
	// [CompressResponseRuleExposedCredentialCheck],
	// [DDoSDynamicRuleExposedCredentialCheck], [ExecuteRuleExposedCredentialCheck],
	// [ForceConnectionCloseRuleExposedCredentialCheck],
	// [RuleNewResponseRulesRulesetsJSChallengeRuleExposedCredentialCheck],
	// [LogRuleExposedCredentialCheck], [LogCustomFieldRuleExposedCredentialCheck],
	// [ManagedChallengeRuleExposedCredentialCheck],
	// [RedirectRuleExposedCredentialCheck], [RewriteRuleExposedCredentialCheck],
	// [RouteRuleExposedCredentialCheck], [ScoreRuleExposedCredentialCheck],
	// [ServeErrorRuleExposedCredentialCheck],
	// [RuleNewResponseRulesRulesetsSetCacheControlRuleExposedCredentialCheck],
	// [SetCacheSettingsRuleExposedCredentialCheck],
	// [RuleNewResponseRulesRulesetsSetCacheTagsRuleExposedCredentialCheck],
	// [SetConfigRuleExposedCredentialCheck], [SkipRuleExposedCredentialCheck].
	ExposedCredentialCheck interface{} `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression string `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging Logging `json:"logging"`
	// This field can have the runtime type of [BlockRuleRatelimit],
	// [RuleNewResponseRulesRulesetsChallengeRuleRatelimit],
	// [CompressResponseRuleRatelimit], [DDoSDynamicRuleRatelimit],
	// [ExecuteRuleRatelimit], [ForceConnectionCloseRuleRatelimit],
	// [RuleNewResponseRulesRulesetsJSChallengeRuleRatelimit], [LogRuleRatelimit],
	// [LogCustomFieldRuleRatelimit], [ManagedChallengeRuleRatelimit],
	// [RedirectRuleRatelimit], [RewriteRuleRatelimit], [RouteRuleRatelimit],
	// [ScoreRuleRatelimit], [ServeErrorRuleRatelimit],
	// [RuleNewResponseRulesRulesetsSetCacheControlRuleRatelimit],
	// [SetCacheSettingsRuleRatelimit],
	// [RuleNewResponseRulesRulesetsSetCacheTagsRuleRatelimit],
	// [SetConfigRuleRatelimit], [SkipRuleRatelimit].
	Ratelimit interface{} `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                  `json:"ref"`
	JSON ruleNewResponseRuleJSON `json:"-"`
	// contains filtered or unexported fields
}

func (RuleNewResponseRule) AsUnion 

func (r RuleNewResponseRule) AsUnion() RuleNewResponseRulesUnion

AsUnion returns a RuleNewResponseRulesUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are BlockRule, RuleNewResponseRulesRulesetsChallengeRule, CompressResponseRule, DDoSDynamicRule, ExecuteRule, ForceConnectionCloseRule, RuleNewResponseRulesRulesetsJSChallengeRule, LogRule, LogCustomFieldRule, ManagedChallengeRule, RedirectRule, RewriteRule, RouteRule, ScoreRule, ServeErrorRule, RuleNewResponseRulesRulesetsSetCacheControlRule, SetCacheSettingsRule, RuleNewResponseRulesRulesetsSetCacheTagsRule, SetConfigRule, SkipRule.

func (*RuleNewResponseRule) UnmarshalJSON 

func (r *RuleNewResponseRule) UnmarshalJSON(data []byte) (err error)

type RuleNewResponseRulesAction 

type RuleNewResponseRulesAction string

The action to perform when the rule matches. 

const (
	RuleNewResponseRulesActionBlock                RuleNewResponseRulesAction = "block"
	RuleNewResponseRulesActionChallenge            RuleNewResponseRulesAction = "challenge"
	RuleNewResponseRulesActionCompressResponse     RuleNewResponseRulesAction = "compress_response"
	RuleNewResponseRulesActionDDoSDynamic          RuleNewResponseRulesAction = "ddos_dynamic"
	RuleNewResponseRulesActionExecute              RuleNewResponseRulesAction = "execute"
	RuleNewResponseRulesActionForceConnectionClose RuleNewResponseRulesAction = "force_connection_close"
	RuleNewResponseRulesActionJSChallenge          RuleNewResponseRulesAction = "js_challenge"
	RuleNewResponseRulesActionLog                  RuleNewResponseRulesAction = "log"
	RuleNewResponseRulesActionLogCustomField       RuleNewResponseRulesAction = "log_custom_field"
	RuleNewResponseRulesActionManagedChallenge     RuleNewResponseRulesAction = "managed_challenge"
	RuleNewResponseRulesActionRedirect             RuleNewResponseRulesAction = "redirect"
	RuleNewResponseRulesActionRewrite              RuleNewResponseRulesAction = "rewrite"
	RuleNewResponseRulesActionRoute                RuleNewResponseRulesAction = "route"
	RuleNewResponseRulesActionScore                RuleNewResponseRulesAction = "score"
	RuleNewResponseRulesActionServeError           RuleNewResponseRulesAction = "serve_error"
	RuleNewResponseRulesActionSetCacheControl      RuleNewResponseRulesAction = "set_cache_control"
	RuleNewResponseRulesActionSetCacheSettings     RuleNewResponseRulesAction = "set_cache_settings"
	RuleNewResponseRulesActionSetCacheTags         RuleNewResponseRulesAction = "set_cache_tags"
	RuleNewResponseRulesActionSetConfig            RuleNewResponseRulesAction = "set_config"
	RuleNewResponseRulesActionSkip                 RuleNewResponseRulesAction = "skip"
)

func (RuleNewResponseRulesAction) IsKnown 

func (r RuleNewResponseRulesAction) IsKnown() bool

type RuleNewResponseRulesRulesetsChallengeRule 

type RuleNewResponseRulesRulesetsChallengeRule struct {
	// The timestamp of when the rule was last modified.
	LastUpdated time.Time `json:"last_updated" api:"required" format:"date-time"`
	// The version of the rule.
	Version string `json:"version" api:"required"`
	// The unique ID of the rule.
	ID string `json:"id"`
	// The action to perform when the rule matches.
	Action RuleNewResponseRulesRulesetsChallengeRuleAction `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters interface{} `json:"action_parameters"`
	// The categories of the rule.
	Categories []string `json:"categories"`
	// An informative description of the rule.
	Description string `json:"description"`
	// Whether the rule should be executed.
	Enabled bool `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck RuleNewResponseRulesRulesetsChallengeRuleExposedCredentialCheck `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression string `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging Logging `json:"logging"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit RuleNewResponseRulesRulesetsChallengeRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                                        `json:"ref"`
	JSON ruleNewResponseRulesRulesetsChallengeRuleJSON `json:"-"`
}

func (*RuleNewResponseRulesRulesetsChallengeRule) UnmarshalJSON 

func (r *RuleNewResponseRulesRulesetsChallengeRule) UnmarshalJSON(data []byte) (err error)

type RuleNewResponseRulesRulesetsChallengeRuleAction 

type RuleNewResponseRulesRulesetsChallengeRuleAction string

The action to perform when the rule matches. 

const (
	RuleNewResponseRulesRulesetsChallengeRuleActionChallenge RuleNewResponseRulesRulesetsChallengeRuleAction = "challenge"
)

func (RuleNewResponseRulesRulesetsChallengeRuleAction) IsKnown 

func (r RuleNewResponseRulesRulesetsChallengeRuleAction) IsKnown() bool

type RuleNewResponseRulesRulesetsChallengeRuleExposedCredentialCheck 

type RuleNewResponseRulesRulesetsChallengeRuleExposedCredentialCheck struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression string `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression string                                                              `json:"username_expression" api:"required"`
	JSON               ruleNewResponseRulesRulesetsChallengeRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*RuleNewResponseRulesRulesetsChallengeRuleExposedCredentialCheck) UnmarshalJSON 

func (r *RuleNewResponseRulesRulesetsChallengeRuleExposedCredentialCheck) UnmarshalJSON(data []byte) (err error)

type RuleNewResponseRulesRulesetsChallengeRuleRatelimit 

type RuleNewResponseRulesRulesetsChallengeRuleRatelimit struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics []string `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period int64 `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression string `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout int64 `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod int64 `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin bool `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod int64 `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName string                                                 `json:"score_response_header_name"`
	JSON                    ruleNewResponseRulesRulesetsChallengeRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*RuleNewResponseRulesRulesetsChallengeRuleRatelimit) UnmarshalJSON 

func (r *RuleNewResponseRulesRulesetsChallengeRuleRatelimit) UnmarshalJSON(data []byte) (err error)

type RuleNewResponseRulesRulesetsJSChallengeRule 

type RuleNewResponseRulesRulesetsJSChallengeRule struct {
	// The timestamp of when the rule was last modified.
	LastUpdated time.Time `json:"last_updated" api:"required" format:"date-time"`
	// The version of the rule.
	Version string `json:"version" api:"required"`
	// The unique ID of the rule.
	ID string `json:"id"`
	// The action to perform when the rule matches.
	Action RuleNewResponseRulesRulesetsJSChallengeRuleAction `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters interface{} `json:"action_parameters"`
	// The categories of the rule.
	Categories []string `json:"categories"`
	// An informative description of the rule.
	Description string `json:"description"`
	// Whether the rule should be executed.
	Enabled bool `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck RuleNewResponseRulesRulesetsJSChallengeRuleExposedCredentialCheck `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression string `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging Logging `json:"logging"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit RuleNewResponseRulesRulesetsJSChallengeRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                                          `json:"ref"`
	JSON ruleNewResponseRulesRulesetsJSChallengeRuleJSON `json:"-"`
}

func (*RuleNewResponseRulesRulesetsJSChallengeRule) UnmarshalJSON 

func (r *RuleNewResponseRulesRulesetsJSChallengeRule) UnmarshalJSON(data []byte) (err error)

type RuleNewResponseRulesRulesetsJSChallengeRuleAction 

type RuleNewResponseRulesRulesetsJSChallengeRuleAction string

The action to perform when the rule matches. 

const (
	RuleNewResponseRulesRulesetsJSChallengeRuleActionJSChallenge RuleNewResponseRulesRulesetsJSChallengeRuleAction = "js_challenge"
)

func (RuleNewResponseRulesRulesetsJSChallengeRuleAction) IsKnown 

func (r RuleNewResponseRulesRulesetsJSChallengeRuleAction) IsKnown() bool

type RuleNewResponseRulesRulesetsJSChallengeRuleExposedCredentialCheck 

type RuleNewResponseRulesRulesetsJSChallengeRuleExposedCredentialCheck struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression string `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression string                                                                `json:"username_expression" api:"required"`
	JSON               ruleNewResponseRulesRulesetsJSChallengeRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*RuleNewResponseRulesRulesetsJSChallengeRuleExposedCredentialCheck) UnmarshalJSON 

func (r *RuleNewResponseRulesRulesetsJSChallengeRuleExposedCredentialCheck) UnmarshalJSON(data []byte) (err error)

type RuleNewResponseRulesRulesetsJSChallengeRuleRatelimit 

type RuleNewResponseRulesRulesetsJSChallengeRuleRatelimit struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics []string `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period int64 `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression string `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout int64 `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod int64 `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin bool `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod int64 `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName string                                                   `json:"score_response_header_name"`
	JSON                    ruleNewResponseRulesRulesetsJSChallengeRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*RuleNewResponseRulesRulesetsJSChallengeRuleRatelimit) UnmarshalJSON 

func (r *RuleNewResponseRulesRulesetsJSChallengeRuleRatelimit) UnmarshalJSON(data []byte) (err error)

type RuleNewResponseRulesRulesetsSetCacheControlRule added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRule struct {
	// The timestamp of when the rule was last modified.
	LastUpdated time.Time `json:"last_updated" api:"required" format:"date-time"`
	// The version of the rule.
	Version string `json:"version" api:"required"`
	// The unique ID of the rule.
	ID string `json:"id"`
	// The action to perform when the rule matches.
	Action RuleNewResponseRulesRulesetsSetCacheControlRuleAction `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters RuleNewResponseRulesRulesetsSetCacheControlRuleActionParameters `json:"action_parameters"`
	// The categories of the rule.
	Categories []string `json:"categories"`
	// An informative description of the rule.
	Description string `json:"description"`
	// Whether the rule should be executed.
	Enabled bool `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck RuleNewResponseRulesRulesetsSetCacheControlRuleExposedCredentialCheck `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression string `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging Logging `json:"logging"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit RuleNewResponseRulesRulesetsSetCacheControlRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                                              `json:"ref"`
	JSON ruleNewResponseRulesRulesetsSetCacheControlRuleJSON `json:"-"`
}

func (*RuleNewResponseRulesRulesetsSetCacheControlRule) UnmarshalJSON added in v6.9.0 

func (r *RuleNewResponseRulesRulesetsSetCacheControlRule) UnmarshalJSON(data []byte) (err error)

type RuleNewResponseRulesRulesetsSetCacheControlRuleAction added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleAction string

The action to perform when the rule matches. 

const (
	RuleNewResponseRulesRulesetsSetCacheControlRuleActionSetCacheControl RuleNewResponseRulesRulesetsSetCacheControlRuleAction = "set_cache_control"
)

func (RuleNewResponseRulesRulesetsSetCacheControlRuleAction) IsKnown added in v6.9.0 

func (r RuleNewResponseRulesRulesetsSetCacheControlRuleAction) IsKnown() bool

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParameters added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParameters struct {
	// A cache-control directive configuration.
	Immutable RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutable `json:"immutable"`
	// A cache-control directive configuration that accepts a duration value in
	// seconds.
	MaxAge RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAge `json:"max-age"`
	// A cache-control directive configuration.
	MustRevalidate RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate `json:"must-revalidate"`
	// A cache-control directive configuration.
	MustUnderstand RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand `json:"must-understand"`
	// A cache-control directive configuration that accepts optional qualifiers (header
	// names).
	NoCache RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCache `json:"no-cache"`
	// A cache-control directive configuration.
	NoStore RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStore `json:"no-store"`
	// A cache-control directive configuration.
	NoTransform RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransform `json:"no-transform"`
	// A cache-control directive configuration that accepts optional qualifiers (header
	// names).
	Private RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivate `json:"private"`
	// A cache-control directive configuration.
	ProxyRevalidate RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate `json:"proxy-revalidate"`
	// A cache-control directive configuration.
	Public RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublic `json:"public"`
	// A cache-control directive configuration that accepts a duration value in
	// seconds.
	SMaxage RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxage `json:"s-maxage"`
	// A cache-control directive configuration that accepts a duration value in
	// seconds.
	StaleIfError RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfError `json:"stale-if-error"`
	// A cache-control directive configuration that accepts a duration value in
	// seconds.
	StaleWhileRevalidate RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate `json:"stale-while-revalidate"`
	JSON                 ruleNewResponseRulesRulesetsSetCacheControlRuleActionParametersJSON                 `json:"-"`
}

The parameters configuring the rule's action.

func (*RuleNewResponseRulesRulesetsSetCacheControlRuleActionParameters) UnmarshalJSON added in v6.9.0 

func (r *RuleNewResponseRulesRulesetsSetCacheControlRuleActionParameters) UnmarshalJSON(data []byte) (err error)

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutable added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutable struct {
	// The operation to perform on the cache-control directive.
	Operation RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                         `json:"cloudflare_only"`
	JSON           ruleNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration.

func (RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutable) AsUnion added in v6.9.0 

func (r RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutable) AsUnion() RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableUnion

AsUnion returns a RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective, RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective.

func (*RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutable) UnmarshalJSON added in v6.9.0 

func (r *RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutable) UnmarshalJSON(data []byte) (err error)

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation string

The operation to perform on the cache-control directive. 

const (
	RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperationSet    RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation = "set"
	RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperationRemove RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation = "remove"
)

func (RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation) IsKnown added in v6.9.0 

func (r RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation) IsKnown() bool

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                        `json:"cloudflare_only"`
	JSON           ruleNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective) UnmarshalJSON added in v6.9.0 

func (r *RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective) UnmarshalJSON(data []byte) (err error)

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperationSet    RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation = "set"
	RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperationRemove RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation = "remove"
)

func (RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation) IsKnown() bool

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                     `json:"cloudflare_only"`
	JSON           ruleNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveJSON `json:"-"`
}

Set the directive.

func (*RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective) UnmarshalJSON added in v6.9.0 

func (r *RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective) UnmarshalJSON(data []byte) (err error)

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperationSet    RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation = "set"
	RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperationRemove RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation = "remove"
)

func (RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation) IsKnown() bool

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableUnion added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Union satisfied by RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective or RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective.

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAge added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAge struct {
	// The operation to perform on the cache-control directive.
	Operation RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool `json:"cloudflare_only"`
	// The duration value in seconds for the directive.
	Value int64                                                                     `json:"value"`
	JSON  ruleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration that accepts a duration value in seconds.

func (RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAge) AsUnion added in v6.9.0 

func (r RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAge) AsUnion() RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeUnion

AsUnion returns a RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective, RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective.

func (*RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAge) UnmarshalJSON added in v6.9.0 

func (r *RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAge) UnmarshalJSON(data []byte) (err error)

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation string

The operation to perform on the cache-control directive. 

const (
	RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperationSet    RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation = "set"
	RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperationRemove RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation = "remove"
)

func (RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation) IsKnown added in v6.9.0 

func (r RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation) IsKnown() bool

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                     `json:"cloudflare_only"`
	JSON           ruleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective) UnmarshalJSON added in v6.9.0 

func (r *RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective) UnmarshalJSON(data []byte) (err error)

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperationSet    RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation = "set"
	RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperationRemove RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation = "remove"
)

func (RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation) IsKnown() bool

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation `json:"operation" api:"required"`
	// The duration value in seconds for the directive.
	Value int64 `json:"value" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                  `json:"cloudflare_only"`
	JSON           ruleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveJSON `json:"-"`
}

Set the directive with a duration value in seconds.

func (*RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective) UnmarshalJSON added in v6.9.0 

func (r *RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective) UnmarshalJSON(data []byte) (err error)

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperationSet    RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation = "set"
	RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperationRemove RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation = "remove"
)

func (RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation) IsKnown() bool

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeUnion added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts a duration value in seconds.

Union satisfied by RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective or RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective.

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate struct {
	// The operation to perform on the cache-control directive.
	Operation RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                              `json:"cloudflare_only"`
	JSON           ruleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration.

func (RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate) AsUnion added in v6.9.0 

func (r RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate) AsUnion() RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateUnion

AsUnion returns a RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective, RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective.

func (*RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate) UnmarshalJSON added in v6.9.0 

func (r *RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate) UnmarshalJSON(data []byte) (err error)

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation string

The operation to perform on the cache-control directive. 

const (
	RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperationSet    RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation = "set"
	RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperationRemove RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation = "remove"
)

func (RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation) IsKnown added in v6.9.0 

func (r RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation) IsKnown() bool

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                             `json:"cloudflare_only"`
	JSON           ruleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective) UnmarshalJSON added in v6.9.0 

func (r *RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective) UnmarshalJSON(data []byte) (err error)

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperationSet    RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation = "set"
	RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperationRemove RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation = "remove"
)

func (RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation) IsKnown() bool

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                          `json:"cloudflare_only"`
	JSON           ruleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveJSON `json:"-"`
}

Set the directive.

func (*RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective) UnmarshalJSON added in v6.9.0 

func (r *RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective) UnmarshalJSON(data []byte) (err error)

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperationSet    RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation = "set"
	RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperationRemove RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation = "remove"
)

func (RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation) IsKnown() bool

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateUnion added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Union satisfied by RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective or RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective.

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand struct {
	// The operation to perform on the cache-control directive.
	Operation RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                              `json:"cloudflare_only"`
	JSON           ruleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration.

func (RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand) AsUnion added in v6.9.0 

func (r RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand) AsUnion() RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandUnion

AsUnion returns a RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective, RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective.

func (*RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand) UnmarshalJSON added in v6.9.0 

func (r *RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand) UnmarshalJSON(data []byte) (err error)

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation string

The operation to perform on the cache-control directive. 

const (
	RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperationSet    RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation = "set"
	RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperationRemove RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation = "remove"
)

func (RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation) IsKnown added in v6.9.0 

func (r RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation) IsKnown() bool

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                             `json:"cloudflare_only"`
	JSON           ruleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective) UnmarshalJSON added in v6.9.0 

func (r *RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective) UnmarshalJSON(data []byte) (err error)

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperationSet    RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation = "set"
	RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperationRemove RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation = "remove"
)

func (RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation) IsKnown() bool

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                          `json:"cloudflare_only"`
	JSON           ruleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveJSON `json:"-"`
}

Set the directive.

func (*RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective) UnmarshalJSON added in v6.9.0 

func (r *RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective) UnmarshalJSON(data []byte) (err error)

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperationSet    RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation = "set"
	RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperationRemove RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation = "remove"
)

func (RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation) IsKnown() bool

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandUnion added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Union satisfied by RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective or RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective.

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCache added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCache struct {
	// The operation to perform on the cache-control directive.
	Operation RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool `json:"cloudflare_only"`
	// This field can have the runtime type of [[]string].
	Qualifiers interface{}                                                                `json:"qualifiers"`
	JSON       ruleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration that accepts optional qualifiers (header names).

func (RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCache) AsUnion added in v6.9.0 

func (r RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCache) AsUnion() RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheUnion

AsUnion returns a RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective, RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective.

func (*RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCache) UnmarshalJSON added in v6.9.0 

func (r *RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCache) UnmarshalJSON(data []byte) (err error)

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation string

The operation to perform on the cache-control directive. 

const (
	RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperationSet    RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation = "set"
	RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperationRemove RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation = "remove"
)

func (RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation) IsKnown added in v6.9.0 

func (r RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation) IsKnown() bool

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                      `json:"cloudflare_only"`
	JSON           ruleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective) UnmarshalJSON added in v6.9.0 

func (r *RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective) UnmarshalJSON(data []byte) (err error)

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperationSet    RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation = "set"
	RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperationRemove RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation = "remove"
)

func (RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation) IsKnown() bool

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool `json:"cloudflare_only"`
	// Optional list of header names to qualify the directive (e.g., for "private" or
	// "no-cache" directives).
	Qualifiers []string                                                                               `json:"qualifiers"`
	JSON       ruleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveJSON `json:"-"`
}

Set the directive with optional qualifiers.

func (*RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective) UnmarshalJSON added in v6.9.0 

func (r *RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective) UnmarshalJSON(data []byte) (err error)

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperationSet    RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation = "set"
	RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperationRemove RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation = "remove"
)

func (RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation) IsKnown() bool

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheUnion added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts optional qualifiers (header names).

Union satisfied by RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective or RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective.

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStore added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStore struct {
	// The operation to perform on the cache-control directive.
	Operation RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                       `json:"cloudflare_only"`
	JSON           ruleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration.

func (RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStore) AsUnion added in v6.9.0 

func (r RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStore) AsUnion() RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreUnion

AsUnion returns a RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective, RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective.

func (*RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStore) UnmarshalJSON added in v6.9.0 

func (r *RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStore) UnmarshalJSON(data []byte) (err error)

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation string

The operation to perform on the cache-control directive. 

const (
	RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperationSet    RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation = "set"
	RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperationRemove RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation = "remove"
)

func (RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation) IsKnown added in v6.9.0 

func (r RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation) IsKnown() bool

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                      `json:"cloudflare_only"`
	JSON           ruleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective) UnmarshalJSON added in v6.9.0 

func (r *RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective) UnmarshalJSON(data []byte) (err error)

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperationSet    RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation = "set"
	RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperationRemove RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation = "remove"
)

func (RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation) IsKnown() bool

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                   `json:"cloudflare_only"`
	JSON           ruleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveJSON `json:"-"`
}

Set the directive.

func (*RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective) UnmarshalJSON added in v6.9.0 

func (r *RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective) UnmarshalJSON(data []byte) (err error)

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperationSet    RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation = "set"
	RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperationRemove RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation = "remove"
)

func (RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation) IsKnown() bool

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreUnion added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Union satisfied by RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective or RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective.

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransform added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransform struct {
	// The operation to perform on the cache-control directive.
	Operation RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                           `json:"cloudflare_only"`
	JSON           ruleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration.

func (RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransform) AsUnion added in v6.9.0 

func (r RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransform) AsUnion() RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformUnion

AsUnion returns a RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective, RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective.

func (*RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransform) UnmarshalJSON added in v6.9.0 

func (r *RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransform) UnmarshalJSON(data []byte) (err error)

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation string

The operation to perform on the cache-control directive. 

const (
	RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperationSet    RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation = "set"
	RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperationRemove RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation = "remove"
)

func (RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation) IsKnown added in v6.9.0 

func (r RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation) IsKnown() bool

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                          `json:"cloudflare_only"`
	JSON           ruleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective) UnmarshalJSON added in v6.9.0 

func (r *RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective) UnmarshalJSON(data []byte) (err error)

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperationSet    RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation = "set"
	RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperationRemove RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation = "remove"
)

func (RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation) IsKnown() bool

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                       `json:"cloudflare_only"`
	JSON           ruleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveJSON `json:"-"`
}

Set the directive.

func (*RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective) UnmarshalJSON added in v6.9.0 

func (r *RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective) UnmarshalJSON(data []byte) (err error)

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperationSet    RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation = "set"
	RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperationRemove RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation = "remove"
)

func (RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation) IsKnown() bool

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformUnion added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Union satisfied by RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective or RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective.

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivate added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivate struct {
	// The operation to perform on the cache-control directive.
	Operation RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool `json:"cloudflare_only"`
	// This field can have the runtime type of [[]string].
	Qualifiers interface{}                                                                `json:"qualifiers"`
	JSON       ruleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration that accepts optional qualifiers (header names).

func (RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivate) AsUnion added in v6.9.0 

func (r RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivate) AsUnion() RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateUnion

AsUnion returns a RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective, RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective.

func (*RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivate) UnmarshalJSON added in v6.9.0 

func (r *RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivate) UnmarshalJSON(data []byte) (err error)

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation string

The operation to perform on the cache-control directive. 

const (
	RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperationSet    RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation = "set"
	RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperationRemove RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation = "remove"
)

func (RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation) IsKnown added in v6.9.0 

func (r RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation) IsKnown() bool

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                      `json:"cloudflare_only"`
	JSON           ruleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective) UnmarshalJSON added in v6.9.0 

func (r *RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective) UnmarshalJSON(data []byte) (err error)

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperationSet    RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation = "set"
	RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperationRemove RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation = "remove"
)

func (RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation) IsKnown() bool

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool `json:"cloudflare_only"`
	// Optional list of header names to qualify the directive (e.g., for "private" or
	// "no-cache" directives).
	Qualifiers []string                                                                               `json:"qualifiers"`
	JSON       ruleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveJSON `json:"-"`
}

Set the directive with optional qualifiers.

func (*RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective) UnmarshalJSON added in v6.9.0 

func (r *RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective) UnmarshalJSON(data []byte) (err error)

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperationSet    RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation = "set"
	RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperationRemove RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation = "remove"
)

func (RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation) IsKnown() bool

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateUnion added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts optional qualifiers (header names).

Union satisfied by RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective or RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective.

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate struct {
	// The operation to perform on the cache-control directive.
	Operation RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                               `json:"cloudflare_only"`
	JSON           ruleNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration.

func (RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate) AsUnion added in v6.9.0 

func (r RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate) AsUnion() RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateUnion

AsUnion returns a RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective, RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective.

func (*RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate) UnmarshalJSON added in v6.9.0 

func (r *RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate) UnmarshalJSON(data []byte) (err error)

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation string

The operation to perform on the cache-control directive. 

const (
	RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperationSet    RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation = "set"
	RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperationRemove RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation = "remove"
)

func (RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation) IsKnown added in v6.9.0 

func (r RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation) IsKnown() bool

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                              `json:"cloudflare_only"`
	JSON           ruleNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective) UnmarshalJSON added in v6.9.0 

func (r *RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective) UnmarshalJSON(data []byte) (err error)

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperationSet    RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation = "set"
	RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperationRemove RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation = "remove"
)

func (RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation) IsKnown() bool

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                           `json:"cloudflare_only"`
	JSON           ruleNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveJSON `json:"-"`
}

Set the directive.

func (*RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective) UnmarshalJSON added in v6.9.0 

func (r *RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective) UnmarshalJSON(data []byte) (err error)

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperationSet    RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation = "set"
	RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperationRemove RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation = "remove"
)

func (RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation) IsKnown() bool

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateUnion added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Union satisfied by RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective or RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective.

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublic added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublic struct {
	// The operation to perform on the cache-control directive.
	Operation RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                      `json:"cloudflare_only"`
	JSON           ruleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration.

func (RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublic) AsUnion added in v6.9.0 

func (r RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublic) AsUnion() RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicUnion

AsUnion returns a RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective, RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective.

func (*RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublic) UnmarshalJSON added in v6.9.0 

func (r *RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublic) UnmarshalJSON(data []byte) (err error)

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation string

The operation to perform on the cache-control directive. 

const (
	RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperationSet    RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation = "set"
	RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperationRemove RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation = "remove"
)

func (RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation) IsKnown added in v6.9.0 

func (r RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation) IsKnown() bool

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                     `json:"cloudflare_only"`
	JSON           ruleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective) UnmarshalJSON added in v6.9.0 

func (r *RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective) UnmarshalJSON(data []byte) (err error)

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperationSet    RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation = "set"
	RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperationRemove RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation = "remove"
)

func (RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation) IsKnown() bool

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                  `json:"cloudflare_only"`
	JSON           ruleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveJSON `json:"-"`
}

Set the directive.

func (*RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective) UnmarshalJSON added in v6.9.0 

func (r *RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective) UnmarshalJSON(data []byte) (err error)

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperationSet    RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation = "set"
	RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperationRemove RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation = "remove"
)

func (RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation) IsKnown() bool

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicUnion added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Union satisfied by RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective or RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective.

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxage added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxage struct {
	// The operation to perform on the cache-control directive.
	Operation RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool `json:"cloudflare_only"`
	// The duration value in seconds for the directive.
	Value int64                                                                      `json:"value"`
	JSON  ruleNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration that accepts a duration value in seconds.

func (RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxage) AsUnion added in v6.9.0 

func (r RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxage) AsUnion() RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageUnion

AsUnion returns a RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective, RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective.

func (*RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxage) UnmarshalJSON added in v6.9.0 

func (r *RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxage) UnmarshalJSON(data []byte) (err error)

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation string

The operation to perform on the cache-control directive. 

const (
	RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperationSet    RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation = "set"
	RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperationRemove RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation = "remove"
)

func (RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation) IsKnown added in v6.9.0 

func (r RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation) IsKnown() bool

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                      `json:"cloudflare_only"`
	JSON           ruleNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective) UnmarshalJSON added in v6.9.0 

func (r *RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective) UnmarshalJSON(data []byte) (err error)

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperationSet    RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation = "set"
	RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperationRemove RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation = "remove"
)

func (RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation) IsKnown() bool

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation `json:"operation" api:"required"`
	// The duration value in seconds for the directive.
	Value int64 `json:"value" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                   `json:"cloudflare_only"`
	JSON           ruleNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveJSON `json:"-"`
}

Set the directive with a duration value in seconds.

func (*RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective) UnmarshalJSON added in v6.9.0 

func (r *RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective) UnmarshalJSON(data []byte) (err error)

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperationSet    RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation = "set"
	RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperationRemove RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation = "remove"
)

func (RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation) IsKnown() bool

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageUnion added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts a duration value in seconds.

Union satisfied by RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective or RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective.

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfError added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfError struct {
	// The operation to perform on the cache-control directive.
	Operation RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool `json:"cloudflare_only"`
	// The duration value in seconds for the directive.
	Value int64                                                                           `json:"value"`
	JSON  ruleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration that accepts a duration value in seconds.

func (RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfError) AsUnion added in v6.9.0 

func (r RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfError) AsUnion() RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorUnion

AsUnion returns a RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective, RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective.

func (*RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfError) UnmarshalJSON added in v6.9.0 

func (r *RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfError) UnmarshalJSON(data []byte) (err error)

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation string

The operation to perform on the cache-control directive. 

const (
	RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperationSet    RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation = "set"
	RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperationRemove RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation = "remove"
)

func (RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation) IsKnown added in v6.9.0 

func (r RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation) IsKnown() bool

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                           `json:"cloudflare_only"`
	JSON           ruleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective) UnmarshalJSON added in v6.9.0 

func (r *RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective) UnmarshalJSON(data []byte) (err error)

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperationSet    RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation = "set"
	RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperationRemove RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation = "remove"
)

func (RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation) IsKnown() bool

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation `json:"operation" api:"required"`
	// The duration value in seconds for the directive.
	Value int64 `json:"value" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                        `json:"cloudflare_only"`
	JSON           ruleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveJSON `json:"-"`
}

Set the directive with a duration value in seconds.

func (*RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective) UnmarshalJSON added in v6.9.0 

func (r *RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective) UnmarshalJSON(data []byte) (err error)

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperationSet    RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation = "set"
	RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperationRemove RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation = "remove"
)

func (RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation) IsKnown() bool

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorUnion added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts a duration value in seconds.

Union satisfied by RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective or RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective.

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate struct {
	// The operation to perform on the cache-control directive.
	Operation RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool `json:"cloudflare_only"`
	// The duration value in seconds for the directive.
	Value int64                                                                                   `json:"value"`
	JSON  ruleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration that accepts a duration value in seconds.

func (RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate) AsUnion added in v6.9.0 

func (r RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate) AsUnion() RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateUnion

AsUnion returns a RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective, RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective.

func (*RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate) UnmarshalJSON added in v6.9.0 

func (r *RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate) UnmarshalJSON(data []byte) (err error)

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation string

The operation to perform on the cache-control directive. 

const (
	RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperationSet    RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation = "set"
	RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperationRemove RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation = "remove"
)

func (RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation) IsKnown added in v6.9.0 

func (r RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation) IsKnown() bool

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                                   `json:"cloudflare_only"`
	JSON           ruleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective) UnmarshalJSON added in v6.9.0 

func (r *RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective) UnmarshalJSON(data []byte) (err error)

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperationSet    RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation = "set"
	RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperationRemove RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation = "remove"
)

func (RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation) IsKnown() bool

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation `json:"operation" api:"required"`
	// The duration value in seconds for the directive.
	Value int64 `json:"value" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                                `json:"cloudflare_only"`
	JSON           ruleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveJSON `json:"-"`
}

Set the directive with a duration value in seconds.

func (*RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective) UnmarshalJSON added in v6.9.0 

func (r *RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective) UnmarshalJSON(data []byte) (err error)

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperationSet    RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation = "set"
	RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperationRemove RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation = "remove"
)

func (RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation) IsKnown() bool

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateUnion added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts a duration value in seconds.

Union satisfied by RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective or RuleNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective.

type RuleNewResponseRulesRulesetsSetCacheControlRuleExposedCredentialCheck added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleExposedCredentialCheck struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression string `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression string                                                                    `json:"username_expression" api:"required"`
	JSON               ruleNewResponseRulesRulesetsSetCacheControlRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*RuleNewResponseRulesRulesetsSetCacheControlRuleExposedCredentialCheck) UnmarshalJSON added in v6.9.0 

func (r *RuleNewResponseRulesRulesetsSetCacheControlRuleExposedCredentialCheck) UnmarshalJSON(data []byte) (err error)

type RuleNewResponseRulesRulesetsSetCacheControlRuleRatelimit added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheControlRuleRatelimit struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics []string `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period int64 `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression string `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout int64 `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod int64 `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin bool `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod int64 `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName string                                                       `json:"score_response_header_name"`
	JSON                    ruleNewResponseRulesRulesetsSetCacheControlRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*RuleNewResponseRulesRulesetsSetCacheControlRuleRatelimit) UnmarshalJSON added in v6.9.0 

func (r *RuleNewResponseRulesRulesetsSetCacheControlRuleRatelimit) UnmarshalJSON(data []byte) (err error)

type RuleNewResponseRulesRulesetsSetCacheTagsRule added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheTagsRule struct {
	// The timestamp of when the rule was last modified.
	LastUpdated time.Time `json:"last_updated" api:"required" format:"date-time"`
	// The version of the rule.
	Version string `json:"version" api:"required"`
	// The unique ID of the rule.
	ID string `json:"id"`
	// The action to perform when the rule matches.
	Action RuleNewResponseRulesRulesetsSetCacheTagsRuleAction `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParameters `json:"action_parameters"`
	// The categories of the rule.
	Categories []string `json:"categories"`
	// An informative description of the rule.
	Description string `json:"description"`
	// Whether the rule should be executed.
	Enabled bool `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck RuleNewResponseRulesRulesetsSetCacheTagsRuleExposedCredentialCheck `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression string `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging Logging `json:"logging"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit RuleNewResponseRulesRulesetsSetCacheTagsRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                                           `json:"ref"`
	JSON ruleNewResponseRulesRulesetsSetCacheTagsRuleJSON `json:"-"`
}

func (*RuleNewResponseRulesRulesetsSetCacheTagsRule) UnmarshalJSON added in v6.9.0 

func (r *RuleNewResponseRulesRulesetsSetCacheTagsRule) UnmarshalJSON(data []byte) (err error)

type RuleNewResponseRulesRulesetsSetCacheTagsRuleAction added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheTagsRuleAction string

The action to perform when the rule matches. 

const (
	RuleNewResponseRulesRulesetsSetCacheTagsRuleActionSetCacheTags RuleNewResponseRulesRulesetsSetCacheTagsRuleAction = "set_cache_tags"
)

func (RuleNewResponseRulesRulesetsSetCacheTagsRuleAction) IsKnown added in v6.9.0 

func (r RuleNewResponseRulesRulesetsSetCacheTagsRuleAction) IsKnown() bool

type RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParameters added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParameters struct {
	// The operation to perform on the cache tags.
	Operation RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation `json:"operation" api:"required"`
	// An expression that evaluates to an array of cache tag values.
	Expression string `json:"expression"`
	// This field can have the runtime type of [[]string].
	Values interface{}                                                      `json:"values"`
	JSON   ruleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersJSON `json:"-"`
	// contains filtered or unexported fields
}

The parameters configuring the rule's action.

func (RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParameters) AsUnion added in v6.9.0 

func (r RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParameters) AsUnion() RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersUnion

AsUnion returns a RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues, RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression, RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues, RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression, RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues, RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression.

func (*RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParameters) UnmarshalJSON added in v6.9.0 

func (r *RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParameters) UnmarshalJSON(data []byte) (err error)

type RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression struct {
	// An expression that evaluates to an array of cache tag values.
	Expression string `json:"expression" api:"required"`
	// The operation to perform on the cache tags.
	Operation RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation `json:"operation" api:"required"`
	JSON      ruleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionJSON      `json:"-"`
}

Add cache tags using an expression.

func (*RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression) UnmarshalJSON added in v6.9.0 

func (r *RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression) UnmarshalJSON(data []byte) (err error)

type RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation string

The operation to perform on the cache tags. 

const (
	RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationAdd    RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "add"
	RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationRemove RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "remove"
	RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationSet    RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "set"
)

func (RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation) IsKnown added in v6.9.0 

func (r RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation) IsKnown() bool

type RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues struct {
	// The operation to perform on the cache tags.
	Operation RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation `json:"operation" api:"required"`
	// A list of cache tag values.
	Values []string                                                                           `json:"values" api:"required"`
	JSON   ruleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesJSON `json:"-"`
}

Add cache tags using a list of values.

func (*RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues) UnmarshalJSON added in v6.9.0 

func (r *RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues) UnmarshalJSON(data []byte) (err error)

type RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation string

The operation to perform on the cache tags. 

const (
	RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationAdd    RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "add"
	RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationRemove RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "remove"
	RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationSet    RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "set"
)

func (RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation) IsKnown added in v6.9.0 

func (r RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation) IsKnown() bool

type RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation string

The operation to perform on the cache tags. 

const (
	RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersOperationAdd    RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation = "add"
	RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersOperationRemove RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation = "remove"
	RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersOperationSet    RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation = "set"
)

func (RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation) IsKnown added in v6.9.0 

func (r RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation) IsKnown() bool

type RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression struct {
	// An expression that evaluates to an array of cache tag values.
	Expression string `json:"expression" api:"required"`
	// The operation to perform on the cache tags.
	Operation RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation `json:"operation" api:"required"`
	JSON      ruleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionJSON      `json:"-"`
}

Remove cache tags using an expression.

func (*RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression) UnmarshalJSON added in v6.9.0 

func (r *RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression) UnmarshalJSON(data []byte) (err error)

type RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation string

The operation to perform on the cache tags. 

const (
	RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationAdd    RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "add"
	RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationRemove RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "remove"
	RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationSet    RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "set"
)

func (RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation) IsKnown added in v6.9.0 

func (r RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation) IsKnown() bool

type RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues struct {
	// The operation to perform on the cache tags.
	Operation RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation `json:"operation" api:"required"`
	// A list of cache tag values.
	Values []string                                                                              `json:"values" api:"required"`
	JSON   ruleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesJSON `json:"-"`
}

Remove cache tags using a list of values.

func (*RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues) UnmarshalJSON added in v6.9.0 

func (r *RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues) UnmarshalJSON(data []byte) (err error)

type RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation string

The operation to perform on the cache tags. 

const (
	RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationAdd    RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "add"
	RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationRemove RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "remove"
	RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationSet    RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "set"
)

func (RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation) IsKnown added in v6.9.0 

func (r RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation) IsKnown() bool

type RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression struct {
	// An expression that evaluates to an array of cache tag values.
	Expression string `json:"expression" api:"required"`
	// The operation to perform on the cache tags.
	Operation RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation `json:"operation" api:"required"`
	JSON      ruleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionJSON      `json:"-"`
}

Set cache tags using an expression.

func (*RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression) UnmarshalJSON added in v6.9.0 

func (r *RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression) UnmarshalJSON(data []byte) (err error)

type RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation string

The operation to perform on the cache tags. 

const (
	RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationAdd    RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "add"
	RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationRemove RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "remove"
	RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationSet    RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "set"
)

func (RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation) IsKnown added in v6.9.0 

func (r RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation) IsKnown() bool

type RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues struct {
	// The operation to perform on the cache tags.
	Operation RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation `json:"operation" api:"required"`
	// A list of cache tag values.
	Values []string                                                                           `json:"values" api:"required"`
	JSON   ruleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesJSON `json:"-"`
}

Set cache tags using a list of values.

func (*RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues) UnmarshalJSON added in v6.9.0 

func (r *RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues) UnmarshalJSON(data []byte) (err error)

type RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation string

The operation to perform on the cache tags. 

const (
	RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationAdd    RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "add"
	RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationRemove RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "remove"
	RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationSet    RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "set"
)

func (RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation) IsKnown added in v6.9.0 

func (r RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation) IsKnown() bool

type RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersUnion added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersUnion interface {
	// contains filtered or unexported methods
}

The parameters configuring the rule's action.

Union satisfied by RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues, RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression, RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues, RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression, RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues or RuleNewResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression.

type RuleNewResponseRulesRulesetsSetCacheTagsRuleExposedCredentialCheck added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheTagsRuleExposedCredentialCheck struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression string `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression string                                                                 `json:"username_expression" api:"required"`
	JSON               ruleNewResponseRulesRulesetsSetCacheTagsRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*RuleNewResponseRulesRulesetsSetCacheTagsRuleExposedCredentialCheck) UnmarshalJSON added in v6.9.0 

func (r *RuleNewResponseRulesRulesetsSetCacheTagsRuleExposedCredentialCheck) UnmarshalJSON(data []byte) (err error)

type RuleNewResponseRulesRulesetsSetCacheTagsRuleRatelimit added in v6.9.0 

type RuleNewResponseRulesRulesetsSetCacheTagsRuleRatelimit struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics []string `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period int64 `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression string `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout int64 `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod int64 `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin bool `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod int64 `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName string                                                    `json:"score_response_header_name"`
	JSON                    ruleNewResponseRulesRulesetsSetCacheTagsRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*RuleNewResponseRulesRulesetsSetCacheTagsRuleRatelimit) UnmarshalJSON added in v6.9.0 

func (r *RuleNewResponseRulesRulesetsSetCacheTagsRuleRatelimit) UnmarshalJSON(data []byte) (err error)

type RuleNewResponseRulesUnion 

type RuleNewResponseRulesUnion interface {
	// contains filtered or unexported methods
}

Union satisfied by BlockRule, RuleNewResponseRulesRulesetsChallengeRule, CompressResponseRule, DDoSDynamicRule, ExecuteRule, ForceConnectionCloseRule, RuleNewResponseRulesRulesetsJSChallengeRule, LogRule, LogCustomFieldRule, ManagedChallengeRule, RedirectRule, RewriteRule, RouteRule, ScoreRule, ServeErrorRule, RuleNewResponseRulesRulesetsSetCacheControlRule, SetCacheSettingsRule, RuleNewResponseRulesRulesetsSetCacheTagsRule, SetConfigRule or SkipRule.

type RuleService 

type RuleService struct {
	Options []option.RequestOption
}

RuleService 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 NewRuleService method instead.

func NewRuleService 

func NewRuleService(opts ...option.RequestOption) (r *RuleService)

NewRuleService 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 (*RuleService) Delete 

func (r *RuleService) Delete(ctx context.Context, rulesetID string, ruleID string, body RuleDeleteParams, opts ...option.RequestOption) (res *RuleDeleteResponse, err error)

Deletes an existing rule from an account or zone ruleset.

func (*RuleService) Edit 

func (r *RuleService) Edit(ctx context.Context, rulesetID string, ruleID string, params RuleEditParams, opts ...option.RequestOption) (res *RuleEditResponse, err error)

Updates an existing rule in an account or zone ruleset.

func (*RuleService) New 

func (r *RuleService) New(ctx context.Context, rulesetID string, params RuleNewParams, opts ...option.RequestOption) (res *RuleNewResponse, err error)

Adds a new rule to an account or zone ruleset. The rule will be added to the end of the existing list of rules in the ruleset by default.

type RulesetDeleteParams 

type RulesetDeleteParams struct {
	// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
	AccountID param.Field[string] `path:"account_id"`
	// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
	ZoneID param.Field[string] `path:"zone_id"`
}

type RulesetGetParams 

type RulesetGetParams struct {
	// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
	AccountID param.Field[string] `path:"account_id"`
	// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
	ZoneID param.Field[string] `path:"zone_id"`
}

type RulesetGetResponse 

type RulesetGetResponse struct {
	// The unique ID of the ruleset.
	ID string `json:"id" api:"required"`
	// The kind of the ruleset.
	Kind Kind `json:"kind" api:"required"`
	// The timestamp of when the ruleset was last modified.
	LastUpdated time.Time `json:"last_updated" api:"required" format:"date-time"`
	// The human-readable name of the ruleset.
	Name string `json:"name" api:"required"`
	// The phase of the ruleset.
	Phase Phase `json:"phase" api:"required"`
	// The list of rules in the ruleset.
	Rules []RulesetGetResponseRule `json:"rules" api:"required"`
	// The version of the ruleset.
	Version string `json:"version" api:"required"`
	// An informative description of the ruleset.
	Description string                 `json:"description"`
	JSON        rulesetGetResponseJSON `json:"-"`
}

A ruleset object.

func (*RulesetGetResponse) UnmarshalJSON 

func (r *RulesetGetResponse) UnmarshalJSON(data []byte) (err error)

type RulesetGetResponseEnvelope 

type RulesetGetResponseEnvelope struct {
	// A list of error messages.
	Errors []RulesetGetResponseEnvelopeErrors `json:"errors" api:"required"`
	// A list of warning messages.
	Messages []RulesetGetResponseEnvelopeMessages `json:"messages" api:"required"`
	// A ruleset object.
	Result RulesetGetResponse `json:"result" api:"required"`
	// Whether the API call was successful.
	Success RulesetGetResponseEnvelopeSuccess `json:"success" api:"required"`
	JSON    rulesetGetResponseEnvelopeJSON    `json:"-"`
}

A response object.

func (*RulesetGetResponseEnvelope) UnmarshalJSON 

func (r *RulesetGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type RulesetGetResponseEnvelopeErrors 

type RulesetGetResponseEnvelopeErrors struct {
	// A text description of this message.
	Message string `json:"message" api:"required"`
	// A unique code for this message.
	Code int64 `json:"code"`
	// The source of this message.
	Source RulesetGetResponseEnvelopeErrorsSource `json:"source"`
	JSON   rulesetGetResponseEnvelopeErrorsJSON   `json:"-"`
}

A message.

func (*RulesetGetResponseEnvelopeErrors) UnmarshalJSON 

func (r *RulesetGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type RulesetGetResponseEnvelopeErrorsSource 

type RulesetGetResponseEnvelopeErrorsSource struct {
	// A JSON pointer to the field that is the source of the message.
	Pointer string                                     `json:"pointer" api:"required"`
	JSON    rulesetGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}

The source of this message.

func (*RulesetGetResponseEnvelopeErrorsSource) UnmarshalJSON 

func (r *RulesetGetResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)

type RulesetGetResponseEnvelopeMessages 

type RulesetGetResponseEnvelopeMessages struct {
	// A text description of this message.
	Message string `json:"message" api:"required"`
	// A unique code for this message.
	Code int64 `json:"code"`
	// The source of this message.
	Source RulesetGetResponseEnvelopeMessagesSource `json:"source"`
	JSON   rulesetGetResponseEnvelopeMessagesJSON   `json:"-"`
}

A message.

func (*RulesetGetResponseEnvelopeMessages) UnmarshalJSON 

func (r *RulesetGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type RulesetGetResponseEnvelopeMessagesSource 

type RulesetGetResponseEnvelopeMessagesSource struct {
	// A JSON pointer to the field that is the source of the message.
	Pointer string                                       `json:"pointer" api:"required"`
	JSON    rulesetGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}

The source of this message.

func (*RulesetGetResponseEnvelopeMessagesSource) UnmarshalJSON 

func (r *RulesetGetResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)

type RulesetGetResponseEnvelopeSuccess 

type RulesetGetResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	RulesetGetResponseEnvelopeSuccessTrue RulesetGetResponseEnvelopeSuccess = true
)

func (RulesetGetResponseEnvelopeSuccess) IsKnown 

func (r RulesetGetResponseEnvelopeSuccess) IsKnown() bool

type RulesetGetResponseRule 

type RulesetGetResponseRule struct {
	// The timestamp of when the rule was last modified.
	LastUpdated time.Time `json:"last_updated" api:"required" format:"date-time"`
	// The version of the rule.
	Version string `json:"version" api:"required"`
	// The unique ID of the rule.
	ID string `json:"id"`
	// The action to perform when the rule matches.
	Action RulesetGetResponseRulesAction `json:"action"`
	// This field can have the runtime type of [BlockRuleActionParameters],
	// [interface{}], [CompressResponseRuleActionParameters],
	// [ExecuteRuleActionParameters], [LogCustomFieldRuleActionParameters],
	// [RedirectRuleActionParameters], [RewriteRuleActionParameters],
	// [RouteRuleActionParameters], [ScoreRuleActionParameters],
	// [ServeErrorRuleActionParameters],
	// [RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParameters],
	// [SetCacheSettingsRuleActionParameters],
	// [RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParameters],
	// [SetConfigRuleActionParameters], [SkipRuleActionParameters].
	ActionParameters interface{} `json:"action_parameters"`
	// This field can have the runtime type of [[]string].
	Categories interface{} `json:"categories"`
	// An informative description of the rule.
	Description string `json:"description"`
	// Whether the rule should be executed.
	Enabled bool `json:"enabled"`
	// This field can have the runtime type of [BlockRuleExposedCredentialCheck],
	// [RulesetGetResponseRulesRulesetsChallengeRuleExposedCredentialCheck],
	// [CompressResponseRuleExposedCredentialCheck],
	// [DDoSDynamicRuleExposedCredentialCheck], [ExecuteRuleExposedCredentialCheck],
	// [ForceConnectionCloseRuleExposedCredentialCheck],
	// [RulesetGetResponseRulesRulesetsJSChallengeRuleExposedCredentialCheck],
	// [LogRuleExposedCredentialCheck], [LogCustomFieldRuleExposedCredentialCheck],
	// [ManagedChallengeRuleExposedCredentialCheck],
	// [RedirectRuleExposedCredentialCheck], [RewriteRuleExposedCredentialCheck],
	// [RouteRuleExposedCredentialCheck], [ScoreRuleExposedCredentialCheck],
	// [ServeErrorRuleExposedCredentialCheck],
	// [RulesetGetResponseRulesRulesetsSetCacheControlRuleExposedCredentialCheck],
	// [SetCacheSettingsRuleExposedCredentialCheck],
	// [RulesetGetResponseRulesRulesetsSetCacheTagsRuleExposedCredentialCheck],
	// [SetConfigRuleExposedCredentialCheck], [SkipRuleExposedCredentialCheck].
	ExposedCredentialCheck interface{} `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression string `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging Logging `json:"logging"`
	// This field can have the runtime type of [BlockRuleRatelimit],
	// [RulesetGetResponseRulesRulesetsChallengeRuleRatelimit],
	// [CompressResponseRuleRatelimit], [DDoSDynamicRuleRatelimit],
	// [ExecuteRuleRatelimit], [ForceConnectionCloseRuleRatelimit],
	// [RulesetGetResponseRulesRulesetsJSChallengeRuleRatelimit], [LogRuleRatelimit],
	// [LogCustomFieldRuleRatelimit], [ManagedChallengeRuleRatelimit],
	// [RedirectRuleRatelimit], [RewriteRuleRatelimit], [RouteRuleRatelimit],
	// [ScoreRuleRatelimit], [ServeErrorRuleRatelimit],
	// [RulesetGetResponseRulesRulesetsSetCacheControlRuleRatelimit],
	// [SetCacheSettingsRuleRatelimit],
	// [RulesetGetResponseRulesRulesetsSetCacheTagsRuleRatelimit],
	// [SetConfigRuleRatelimit], [SkipRuleRatelimit].
	Ratelimit interface{} `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                     `json:"ref"`
	JSON rulesetGetResponseRuleJSON `json:"-"`
	// contains filtered or unexported fields
}

func (RulesetGetResponseRule) AsUnion 

func (r RulesetGetResponseRule) AsUnion() RulesetGetResponseRulesUnion

AsUnion returns a RulesetGetResponseRulesUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are BlockRule, RulesetGetResponseRulesRulesetsChallengeRule, CompressResponseRule, DDoSDynamicRule, ExecuteRule, ForceConnectionCloseRule, RulesetGetResponseRulesRulesetsJSChallengeRule, LogRule, LogCustomFieldRule, ManagedChallengeRule, RedirectRule, RewriteRule, RouteRule, ScoreRule, ServeErrorRule, RulesetGetResponseRulesRulesetsSetCacheControlRule, SetCacheSettingsRule, RulesetGetResponseRulesRulesetsSetCacheTagsRule, SetConfigRule, SkipRule.

func (*RulesetGetResponseRule) UnmarshalJSON 

func (r *RulesetGetResponseRule) UnmarshalJSON(data []byte) (err error)

type RulesetGetResponseRulesAction 

type RulesetGetResponseRulesAction string

The action to perform when the rule matches. 

const (
	RulesetGetResponseRulesActionBlock                RulesetGetResponseRulesAction = "block"
	RulesetGetResponseRulesActionChallenge            RulesetGetResponseRulesAction = "challenge"
	RulesetGetResponseRulesActionCompressResponse     RulesetGetResponseRulesAction = "compress_response"
	RulesetGetResponseRulesActionDDoSDynamic          RulesetGetResponseRulesAction = "ddos_dynamic"
	RulesetGetResponseRulesActionExecute              RulesetGetResponseRulesAction = "execute"
	RulesetGetResponseRulesActionForceConnectionClose RulesetGetResponseRulesAction = "force_connection_close"
	RulesetGetResponseRulesActionJSChallenge          RulesetGetResponseRulesAction = "js_challenge"
	RulesetGetResponseRulesActionLog                  RulesetGetResponseRulesAction = "log"
	RulesetGetResponseRulesActionLogCustomField       RulesetGetResponseRulesAction = "log_custom_field"
	RulesetGetResponseRulesActionManagedChallenge     RulesetGetResponseRulesAction = "managed_challenge"
	RulesetGetResponseRulesActionRedirect             RulesetGetResponseRulesAction = "redirect"
	RulesetGetResponseRulesActionRewrite              RulesetGetResponseRulesAction = "rewrite"
	RulesetGetResponseRulesActionRoute                RulesetGetResponseRulesAction = "route"
	RulesetGetResponseRulesActionScore                RulesetGetResponseRulesAction = "score"
	RulesetGetResponseRulesActionServeError           RulesetGetResponseRulesAction = "serve_error"
	RulesetGetResponseRulesActionSetCacheControl      RulesetGetResponseRulesAction = "set_cache_control"
	RulesetGetResponseRulesActionSetCacheSettings     RulesetGetResponseRulesAction = "set_cache_settings"
	RulesetGetResponseRulesActionSetCacheTags         RulesetGetResponseRulesAction = "set_cache_tags"
	RulesetGetResponseRulesActionSetConfig            RulesetGetResponseRulesAction = "set_config"
	RulesetGetResponseRulesActionSkip                 RulesetGetResponseRulesAction = "skip"
)

func (RulesetGetResponseRulesAction) IsKnown 

func (r RulesetGetResponseRulesAction) IsKnown() bool

type RulesetGetResponseRulesRulesetsChallengeRule 

type RulesetGetResponseRulesRulesetsChallengeRule struct {
	// The timestamp of when the rule was last modified.
	LastUpdated time.Time `json:"last_updated" api:"required" format:"date-time"`
	// The version of the rule.
	Version string `json:"version" api:"required"`
	// The unique ID of the rule.
	ID string `json:"id"`
	// The action to perform when the rule matches.
	Action RulesetGetResponseRulesRulesetsChallengeRuleAction `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters interface{} `json:"action_parameters"`
	// The categories of the rule.
	Categories []string `json:"categories"`
	// An informative description of the rule.
	Description string `json:"description"`
	// Whether the rule should be executed.
	Enabled bool `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck RulesetGetResponseRulesRulesetsChallengeRuleExposedCredentialCheck `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression string `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging Logging `json:"logging"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit RulesetGetResponseRulesRulesetsChallengeRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                                           `json:"ref"`
	JSON rulesetGetResponseRulesRulesetsChallengeRuleJSON `json:"-"`
}

func (*RulesetGetResponseRulesRulesetsChallengeRule) UnmarshalJSON 

func (r *RulesetGetResponseRulesRulesetsChallengeRule) UnmarshalJSON(data []byte) (err error)

type RulesetGetResponseRulesRulesetsChallengeRuleAction 

type RulesetGetResponseRulesRulesetsChallengeRuleAction string

The action to perform when the rule matches. 

const (
	RulesetGetResponseRulesRulesetsChallengeRuleActionChallenge RulesetGetResponseRulesRulesetsChallengeRuleAction = "challenge"
)

func (RulesetGetResponseRulesRulesetsChallengeRuleAction) IsKnown 

func (r RulesetGetResponseRulesRulesetsChallengeRuleAction) IsKnown() bool

type RulesetGetResponseRulesRulesetsChallengeRuleExposedCredentialCheck 

type RulesetGetResponseRulesRulesetsChallengeRuleExposedCredentialCheck struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression string `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression string                                                                 `json:"username_expression" api:"required"`
	JSON               rulesetGetResponseRulesRulesetsChallengeRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*RulesetGetResponseRulesRulesetsChallengeRuleExposedCredentialCheck) UnmarshalJSON 

func (r *RulesetGetResponseRulesRulesetsChallengeRuleExposedCredentialCheck) UnmarshalJSON(data []byte) (err error)

type RulesetGetResponseRulesRulesetsChallengeRuleRatelimit 

type RulesetGetResponseRulesRulesetsChallengeRuleRatelimit struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics []string `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period int64 `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression string `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout int64 `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod int64 `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin bool `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod int64 `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName string                                                    `json:"score_response_header_name"`
	JSON                    rulesetGetResponseRulesRulesetsChallengeRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*RulesetGetResponseRulesRulesetsChallengeRuleRatelimit) UnmarshalJSON 

func (r *RulesetGetResponseRulesRulesetsChallengeRuleRatelimit) UnmarshalJSON(data []byte) (err error)

type RulesetGetResponseRulesRulesetsJSChallengeRule 

type RulesetGetResponseRulesRulesetsJSChallengeRule struct {
	// The timestamp of when the rule was last modified.
	LastUpdated time.Time `json:"last_updated" api:"required" format:"date-time"`
	// The version of the rule.
	Version string `json:"version" api:"required"`
	// The unique ID of the rule.
	ID string `json:"id"`
	// The action to perform when the rule matches.
	Action RulesetGetResponseRulesRulesetsJSChallengeRuleAction `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters interface{} `json:"action_parameters"`
	// The categories of the rule.
	Categories []string `json:"categories"`
	// An informative description of the rule.
	Description string `json:"description"`
	// Whether the rule should be executed.
	Enabled bool `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck RulesetGetResponseRulesRulesetsJSChallengeRuleExposedCredentialCheck `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression string `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging Logging `json:"logging"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit RulesetGetResponseRulesRulesetsJSChallengeRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                                             `json:"ref"`
	JSON rulesetGetResponseRulesRulesetsJSChallengeRuleJSON `json:"-"`
}

func (*RulesetGetResponseRulesRulesetsJSChallengeRule) UnmarshalJSON 

func (r *RulesetGetResponseRulesRulesetsJSChallengeRule) UnmarshalJSON(data []byte) (err error)

type RulesetGetResponseRulesRulesetsJSChallengeRuleAction 

type RulesetGetResponseRulesRulesetsJSChallengeRuleAction string

The action to perform when the rule matches. 

const (
	RulesetGetResponseRulesRulesetsJSChallengeRuleActionJSChallenge RulesetGetResponseRulesRulesetsJSChallengeRuleAction = "js_challenge"
)

func (RulesetGetResponseRulesRulesetsJSChallengeRuleAction) IsKnown 

func (r RulesetGetResponseRulesRulesetsJSChallengeRuleAction) IsKnown() bool

type RulesetGetResponseRulesRulesetsJSChallengeRuleExposedCredentialCheck 

type RulesetGetResponseRulesRulesetsJSChallengeRuleExposedCredentialCheck struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression string `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression string                                                                   `json:"username_expression" api:"required"`
	JSON               rulesetGetResponseRulesRulesetsJSChallengeRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*RulesetGetResponseRulesRulesetsJSChallengeRuleExposedCredentialCheck) UnmarshalJSON 

func (r *RulesetGetResponseRulesRulesetsJSChallengeRuleExposedCredentialCheck) UnmarshalJSON(data []byte) (err error)

type RulesetGetResponseRulesRulesetsJSChallengeRuleRatelimit 

type RulesetGetResponseRulesRulesetsJSChallengeRuleRatelimit struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics []string `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period int64 `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression string `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout int64 `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod int64 `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin bool `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod int64 `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName string                                                      `json:"score_response_header_name"`
	JSON                    rulesetGetResponseRulesRulesetsJSChallengeRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*RulesetGetResponseRulesRulesetsJSChallengeRuleRatelimit) UnmarshalJSON 

func (r *RulesetGetResponseRulesRulesetsJSChallengeRuleRatelimit) UnmarshalJSON(data []byte) (err error)

type RulesetGetResponseRulesRulesetsSetCacheControlRule added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRule struct {
	// The timestamp of when the rule was last modified.
	LastUpdated time.Time `json:"last_updated" api:"required" format:"date-time"`
	// The version of the rule.
	Version string `json:"version" api:"required"`
	// The unique ID of the rule.
	ID string `json:"id"`
	// The action to perform when the rule matches.
	Action RulesetGetResponseRulesRulesetsSetCacheControlRuleAction `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParameters `json:"action_parameters"`
	// The categories of the rule.
	Categories []string `json:"categories"`
	// An informative description of the rule.
	Description string `json:"description"`
	// Whether the rule should be executed.
	Enabled bool `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck RulesetGetResponseRulesRulesetsSetCacheControlRuleExposedCredentialCheck `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression string `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging Logging `json:"logging"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit RulesetGetResponseRulesRulesetsSetCacheControlRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                                                 `json:"ref"`
	JSON rulesetGetResponseRulesRulesetsSetCacheControlRuleJSON `json:"-"`
}

func (*RulesetGetResponseRulesRulesetsSetCacheControlRule) UnmarshalJSON added in v6.9.0 

func (r *RulesetGetResponseRulesRulesetsSetCacheControlRule) UnmarshalJSON(data []byte) (err error)

type RulesetGetResponseRulesRulesetsSetCacheControlRuleAction added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleAction string

The action to perform when the rule matches. 

const (
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionSetCacheControl RulesetGetResponseRulesRulesetsSetCacheControlRuleAction = "set_cache_control"
)

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleAction) IsKnown added in v6.9.0 

func (r RulesetGetResponseRulesRulesetsSetCacheControlRuleAction) IsKnown() bool

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParameters added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParameters struct {
	// A cache-control directive configuration.
	Immutable RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutable `json:"immutable"`
	// A cache-control directive configuration that accepts a duration value in
	// seconds.
	MaxAge RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAge `json:"max-age"`
	// A cache-control directive configuration.
	MustRevalidate RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate `json:"must-revalidate"`
	// A cache-control directive configuration.
	MustUnderstand RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand `json:"must-understand"`
	// A cache-control directive configuration that accepts optional qualifiers (header
	// names).
	NoCache RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCache `json:"no-cache"`
	// A cache-control directive configuration.
	NoStore RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStore `json:"no-store"`
	// A cache-control directive configuration.
	NoTransform RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransform `json:"no-transform"`
	// A cache-control directive configuration that accepts optional qualifiers (header
	// names).
	Private RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivate `json:"private"`
	// A cache-control directive configuration.
	ProxyRevalidate RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate `json:"proxy-revalidate"`
	// A cache-control directive configuration.
	Public RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublic `json:"public"`
	// A cache-control directive configuration that accepts a duration value in
	// seconds.
	SMaxage RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxage `json:"s-maxage"`
	// A cache-control directive configuration that accepts a duration value in
	// seconds.
	StaleIfError RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfError `json:"stale-if-error"`
	// A cache-control directive configuration that accepts a duration value in
	// seconds.
	StaleWhileRevalidate RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate `json:"stale-while-revalidate"`
	JSON                 rulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersJSON                 `json:"-"`
}

The parameters configuring the rule's action.

func (*RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParameters) UnmarshalJSON added in v6.9.0 

func (r *RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParameters) UnmarshalJSON(data []byte) (err error)

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutable added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutable struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                            `json:"cloudflare_only"`
	JSON           rulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration.

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutable) AsUnion added in v6.9.0 

func (r RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutable) AsUnion() RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableUnion

AsUnion returns a RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective, RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective.

func (*RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutable) UnmarshalJSON added in v6.9.0 

func (r *RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutable) UnmarshalJSON(data []byte) (err error)

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperationSet    RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation = "set"
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperationRemove RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation = "remove"
)

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation) IsKnown added in v6.9.0 

func (r RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation) IsKnown() bool

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                           `json:"cloudflare_only"`
	JSON           rulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective) UnmarshalJSON added in v6.9.0 

func (r *RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective) UnmarshalJSON(data []byte) (err error)

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperationSet    RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation = "set"
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperationRemove RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation = "remove"
)

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation) IsKnown() bool

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                        `json:"cloudflare_only"`
	JSON           rulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveJSON `json:"-"`
}

Set the directive.

func (*RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective) UnmarshalJSON added in v6.9.0 

func (r *RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective) UnmarshalJSON(data []byte) (err error)

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperationSet    RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation = "set"
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperationRemove RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation = "remove"
)

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation) IsKnown() bool

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableUnion added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Union satisfied by RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective or RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective.

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAge added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAge struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool `json:"cloudflare_only"`
	// The duration value in seconds for the directive.
	Value int64                                                                        `json:"value"`
	JSON  rulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration that accepts a duration value in seconds.

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAge) AsUnion added in v6.9.0 

func (r RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAge) AsUnion() RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeUnion

AsUnion returns a RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective, RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective.

func (*RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAge) UnmarshalJSON added in v6.9.0 

func (r *RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAge) UnmarshalJSON(data []byte) (err error)

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperationSet    RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation = "set"
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperationRemove RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation = "remove"
)

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation) IsKnown added in v6.9.0 

func (r RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation) IsKnown() bool

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                        `json:"cloudflare_only"`
	JSON           rulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective) UnmarshalJSON added in v6.9.0 

func (r *RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective) UnmarshalJSON(data []byte) (err error)

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperationSet    RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation = "set"
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperationRemove RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation = "remove"
)

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation) IsKnown() bool

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation `json:"operation" api:"required"`
	// The duration value in seconds for the directive.
	Value int64 `json:"value" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                     `json:"cloudflare_only"`
	JSON           rulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveJSON `json:"-"`
}

Set the directive with a duration value in seconds.

func (*RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective) UnmarshalJSON added in v6.9.0 

func (r *RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective) UnmarshalJSON(data []byte) (err error)

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperationSet    RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation = "set"
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperationRemove RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation = "remove"
)

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation) IsKnown() bool

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeUnion added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts a duration value in seconds.

Union satisfied by RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective or RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective.

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                 `json:"cloudflare_only"`
	JSON           rulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration.

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate) AsUnion added in v6.9.0 

func (r RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate) AsUnion() RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateUnion

AsUnion returns a RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective, RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective.

func (*RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate) UnmarshalJSON added in v6.9.0 

func (r *RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate) UnmarshalJSON(data []byte) (err error)

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperationSet    RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation = "set"
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperationRemove RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation = "remove"
)

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation) IsKnown added in v6.9.0 

func (r RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation) IsKnown() bool

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                                `json:"cloudflare_only"`
	JSON           rulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective) UnmarshalJSON added in v6.9.0 

func (r *RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective) UnmarshalJSON(data []byte) (err error)

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperationSet    RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation = "set"
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperationRemove RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation = "remove"
)

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation) IsKnown() bool

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                             `json:"cloudflare_only"`
	JSON           rulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveJSON `json:"-"`
}

Set the directive.

func (*RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective) UnmarshalJSON added in v6.9.0 

func (r *RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective) UnmarshalJSON(data []byte) (err error)

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperationSet    RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation = "set"
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperationRemove RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation = "remove"
)

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation) IsKnown() bool

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateUnion added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Union satisfied by RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective or RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective.

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                 `json:"cloudflare_only"`
	JSON           rulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration.

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand) AsUnion added in v6.9.0 

func (r RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand) AsUnion() RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandUnion

AsUnion returns a RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective, RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective.

func (*RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand) UnmarshalJSON added in v6.9.0 

func (r *RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand) UnmarshalJSON(data []byte) (err error)

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperationSet    RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation = "set"
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperationRemove RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation = "remove"
)

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation) IsKnown added in v6.9.0 

func (r RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation) IsKnown() bool

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                                `json:"cloudflare_only"`
	JSON           rulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective) UnmarshalJSON added in v6.9.0 

func (r *RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective) UnmarshalJSON(data []byte) (err error)

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperationSet    RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation = "set"
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperationRemove RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation = "remove"
)

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation) IsKnown() bool

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                             `json:"cloudflare_only"`
	JSON           rulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveJSON `json:"-"`
}

Set the directive.

func (*RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective) UnmarshalJSON added in v6.9.0 

func (r *RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective) UnmarshalJSON(data []byte) (err error)

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperationSet    RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation = "set"
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperationRemove RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation = "remove"
)

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation) IsKnown() bool

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandUnion added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Union satisfied by RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective or RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective.

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCache added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCache struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool `json:"cloudflare_only"`
	// This field can have the runtime type of [[]string].
	Qualifiers interface{}                                                                   `json:"qualifiers"`
	JSON       rulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration that accepts optional qualifiers (header names).

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCache) AsUnion added in v6.9.0 

func (r RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCache) AsUnion() RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheUnion

AsUnion returns a RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective, RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective.

func (*RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCache) UnmarshalJSON added in v6.9.0 

func (r *RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCache) UnmarshalJSON(data []byte) (err error)

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperationSet    RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation = "set"
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperationRemove RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation = "remove"
)

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation) IsKnown added in v6.9.0 

func (r RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation) IsKnown() bool

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                         `json:"cloudflare_only"`
	JSON           rulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective) UnmarshalJSON added in v6.9.0 

func (r *RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective) UnmarshalJSON(data []byte) (err error)

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperationSet    RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation = "set"
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperationRemove RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation = "remove"
)

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation) IsKnown() bool

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool `json:"cloudflare_only"`
	// Optional list of header names to qualify the directive (e.g., for "private" or
	// "no-cache" directives).
	Qualifiers []string                                                                                  `json:"qualifiers"`
	JSON       rulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveJSON `json:"-"`
}

Set the directive with optional qualifiers.

func (*RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective) UnmarshalJSON added in v6.9.0 

func (r *RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective) UnmarshalJSON(data []byte) (err error)

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperationSet    RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation = "set"
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperationRemove RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation = "remove"
)

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation) IsKnown() bool

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheUnion added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts optional qualifiers (header names).

Union satisfied by RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective or RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective.

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStore added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStore struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                          `json:"cloudflare_only"`
	JSON           rulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration.

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStore) AsUnion added in v6.9.0 

func (r RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStore) AsUnion() RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreUnion

AsUnion returns a RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective, RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective.

func (*RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStore) UnmarshalJSON added in v6.9.0 

func (r *RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStore) UnmarshalJSON(data []byte) (err error)

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperationSet    RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation = "set"
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperationRemove RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation = "remove"
)

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation) IsKnown added in v6.9.0 

func (r RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation) IsKnown() bool

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                         `json:"cloudflare_only"`
	JSON           rulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective) UnmarshalJSON added in v6.9.0 

func (r *RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective) UnmarshalJSON(data []byte) (err error)

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperationSet    RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation = "set"
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperationRemove RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation = "remove"
)

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation) IsKnown() bool

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                      `json:"cloudflare_only"`
	JSON           rulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveJSON `json:"-"`
}

Set the directive.

func (*RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective) UnmarshalJSON added in v6.9.0 

func (r *RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective) UnmarshalJSON(data []byte) (err error)

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperationSet    RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation = "set"
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperationRemove RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation = "remove"
)

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation) IsKnown() bool

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreUnion added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Union satisfied by RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective or RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective.

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransform added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransform struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                              `json:"cloudflare_only"`
	JSON           rulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration.

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransform) AsUnion added in v6.9.0 

func (r RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransform) AsUnion() RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformUnion

AsUnion returns a RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective, RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective.

func (*RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransform) UnmarshalJSON added in v6.9.0 

func (r *RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransform) UnmarshalJSON(data []byte) (err error)

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperationSet    RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation = "set"
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperationRemove RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation = "remove"
)

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation) IsKnown added in v6.9.0 

func (r RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation) IsKnown() bool

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                             `json:"cloudflare_only"`
	JSON           rulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective) UnmarshalJSON added in v6.9.0 

func (r *RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective) UnmarshalJSON(data []byte) (err error)

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperationSet    RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation = "set"
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperationRemove RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation = "remove"
)

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation) IsKnown() bool

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                          `json:"cloudflare_only"`
	JSON           rulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveJSON `json:"-"`
}

Set the directive.

func (*RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective) UnmarshalJSON added in v6.9.0 

func (r *RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective) UnmarshalJSON(data []byte) (err error)

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperationSet    RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation = "set"
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperationRemove RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation = "remove"
)

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation) IsKnown() bool

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformUnion added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Union satisfied by RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective or RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective.

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivate added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivate struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool `json:"cloudflare_only"`
	// This field can have the runtime type of [[]string].
	Qualifiers interface{}                                                                   `json:"qualifiers"`
	JSON       rulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration that accepts optional qualifiers (header names).

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivate) AsUnion added in v6.9.0 

func (r RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivate) AsUnion() RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateUnion

AsUnion returns a RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective, RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective.

func (*RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivate) UnmarshalJSON added in v6.9.0 

func (r *RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivate) UnmarshalJSON(data []byte) (err error)

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperationSet    RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation = "set"
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperationRemove RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation = "remove"
)

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation) IsKnown added in v6.9.0 

func (r RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation) IsKnown() bool

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                         `json:"cloudflare_only"`
	JSON           rulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective) UnmarshalJSON added in v6.9.0 

func (r *RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective) UnmarshalJSON(data []byte) (err error)

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperationSet    RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation = "set"
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperationRemove RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation = "remove"
)

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation) IsKnown() bool

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool `json:"cloudflare_only"`
	// Optional list of header names to qualify the directive (e.g., for "private" or
	// "no-cache" directives).
	Qualifiers []string                                                                                  `json:"qualifiers"`
	JSON       rulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveJSON `json:"-"`
}

Set the directive with optional qualifiers.

func (*RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective) UnmarshalJSON added in v6.9.0 

func (r *RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective) UnmarshalJSON(data []byte) (err error)

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperationSet    RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation = "set"
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperationRemove RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation = "remove"
)

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation) IsKnown() bool

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateUnion added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts optional qualifiers (header names).

Union satisfied by RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective or RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective.

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                  `json:"cloudflare_only"`
	JSON           rulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration.

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate) AsUnion added in v6.9.0 

func (r RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate) AsUnion() RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateUnion

AsUnion returns a RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective, RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective.

func (*RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate) UnmarshalJSON added in v6.9.0 

func (r *RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate) UnmarshalJSON(data []byte) (err error)

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperationSet    RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation = "set"
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperationRemove RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation = "remove"
)

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation) IsKnown added in v6.9.0 

func (r RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation) IsKnown() bool

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                                 `json:"cloudflare_only"`
	JSON           rulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective) UnmarshalJSON added in v6.9.0 

func (r *RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective) UnmarshalJSON(data []byte) (err error)

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperationSet    RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation = "set"
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperationRemove RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation = "remove"
)

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation) IsKnown() bool

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                              `json:"cloudflare_only"`
	JSON           rulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveJSON `json:"-"`
}

Set the directive.

func (*RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective) UnmarshalJSON added in v6.9.0 

func (r *RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective) UnmarshalJSON(data []byte) (err error)

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperationSet    RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation = "set"
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperationRemove RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation = "remove"
)

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation) IsKnown() bool

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateUnion added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Union satisfied by RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective or RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective.

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublic added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublic struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                         `json:"cloudflare_only"`
	JSON           rulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration.

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublic) AsUnion added in v6.9.0 

func (r RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublic) AsUnion() RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicUnion

AsUnion returns a RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective, RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective.

func (*RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublic) UnmarshalJSON added in v6.9.0 

func (r *RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublic) UnmarshalJSON(data []byte) (err error)

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperationSet    RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation = "set"
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperationRemove RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation = "remove"
)

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation) IsKnown added in v6.9.0 

func (r RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation) IsKnown() bool

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                        `json:"cloudflare_only"`
	JSON           rulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective) UnmarshalJSON added in v6.9.0 

func (r *RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective) UnmarshalJSON(data []byte) (err error)

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperationSet    RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation = "set"
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperationRemove RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation = "remove"
)

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation) IsKnown() bool

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                     `json:"cloudflare_only"`
	JSON           rulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveJSON `json:"-"`
}

Set the directive.

func (*RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective) UnmarshalJSON added in v6.9.0 

func (r *RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective) UnmarshalJSON(data []byte) (err error)

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperationSet    RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation = "set"
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperationRemove RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation = "remove"
)

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation) IsKnown() bool

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicUnion added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Union satisfied by RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective or RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective.

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxage added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxage struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool `json:"cloudflare_only"`
	// The duration value in seconds for the directive.
	Value int64                                                                         `json:"value"`
	JSON  rulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration that accepts a duration value in seconds.

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxage) AsUnion added in v6.9.0 

func (r RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxage) AsUnion() RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageUnion

AsUnion returns a RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective, RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective.

func (*RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxage) UnmarshalJSON added in v6.9.0 

func (r *RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxage) UnmarshalJSON(data []byte) (err error)

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperationSet    RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation = "set"
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperationRemove RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation = "remove"
)

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation) IsKnown added in v6.9.0 

func (r RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation) IsKnown() bool

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                         `json:"cloudflare_only"`
	JSON           rulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective) UnmarshalJSON added in v6.9.0 

func (r *RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective) UnmarshalJSON(data []byte) (err error)

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperationSet    RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation = "set"
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperationRemove RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation = "remove"
)

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation) IsKnown() bool

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation `json:"operation" api:"required"`
	// The duration value in seconds for the directive.
	Value int64 `json:"value" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                      `json:"cloudflare_only"`
	JSON           rulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveJSON `json:"-"`
}

Set the directive with a duration value in seconds.

func (*RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective) UnmarshalJSON added in v6.9.0 

func (r *RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective) UnmarshalJSON(data []byte) (err error)

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperationSet    RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation = "set"
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperationRemove RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation = "remove"
)

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation) IsKnown() bool

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageUnion added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts a duration value in seconds.

Union satisfied by RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective or RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective.

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfError added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfError struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool `json:"cloudflare_only"`
	// The duration value in seconds for the directive.
	Value int64                                                                              `json:"value"`
	JSON  rulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration that accepts a duration value in seconds.

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfError) AsUnion added in v6.9.0 

func (r RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfError) AsUnion() RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorUnion

AsUnion returns a RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective, RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective.

func (*RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfError) UnmarshalJSON added in v6.9.0 

func (r *RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfError) UnmarshalJSON(data []byte) (err error)

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperationSet    RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation = "set"
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperationRemove RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation = "remove"
)

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation) IsKnown added in v6.9.0 

func (r RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation) IsKnown() bool

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                              `json:"cloudflare_only"`
	JSON           rulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective) UnmarshalJSON added in v6.9.0 

func (r *RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective) UnmarshalJSON(data []byte) (err error)

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperationSet    RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation = "set"
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperationRemove RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation = "remove"
)

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation) IsKnown() bool

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation `json:"operation" api:"required"`
	// The duration value in seconds for the directive.
	Value int64 `json:"value" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                           `json:"cloudflare_only"`
	JSON           rulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveJSON `json:"-"`
}

Set the directive with a duration value in seconds.

func (*RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective) UnmarshalJSON added in v6.9.0 

func (r *RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective) UnmarshalJSON(data []byte) (err error)

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperationSet    RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation = "set"
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperationRemove RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation = "remove"
)

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation) IsKnown() bool

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorUnion added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts a duration value in seconds.

Union satisfied by RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective or RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective.

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool `json:"cloudflare_only"`
	// The duration value in seconds for the directive.
	Value int64                                                                                      `json:"value"`
	JSON  rulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration that accepts a duration value in seconds.

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate) AsUnion added in v6.9.0 

func (r RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate) AsUnion() RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateUnion

AsUnion returns a RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective, RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective.

func (*RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate) UnmarshalJSON added in v6.9.0 

func (r *RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate) UnmarshalJSON(data []byte) (err error)

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperationSet    RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation = "set"
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperationRemove RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation = "remove"
)

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation) IsKnown added in v6.9.0 

func (r RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation) IsKnown() bool

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                                      `json:"cloudflare_only"`
	JSON           rulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective) UnmarshalJSON added in v6.9.0 

func (r *RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective) UnmarshalJSON(data []byte) (err error)

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperationSet    RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation = "set"
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperationRemove RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation = "remove"
)

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation) IsKnown() bool

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation `json:"operation" api:"required"`
	// The duration value in seconds for the directive.
	Value int64 `json:"value" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                                   `json:"cloudflare_only"`
	JSON           rulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveJSON `json:"-"`
}

Set the directive with a duration value in seconds.

func (*RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective) UnmarshalJSON added in v6.9.0 

func (r *RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective) UnmarshalJSON(data []byte) (err error)

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperationSet    RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation = "set"
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperationRemove RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation = "remove"
)

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation) IsKnown() bool

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateUnion added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts a duration value in seconds.

Union satisfied by RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective or RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective.

type RulesetGetResponseRulesRulesetsSetCacheControlRuleExposedCredentialCheck added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleExposedCredentialCheck struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression string `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression string                                                                       `json:"username_expression" api:"required"`
	JSON               rulesetGetResponseRulesRulesetsSetCacheControlRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*RulesetGetResponseRulesRulesetsSetCacheControlRuleExposedCredentialCheck) UnmarshalJSON added in v6.9.0 

func (r *RulesetGetResponseRulesRulesetsSetCacheControlRuleExposedCredentialCheck) UnmarshalJSON(data []byte) (err error)

type RulesetGetResponseRulesRulesetsSetCacheControlRuleRatelimit added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheControlRuleRatelimit struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics []string `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period int64 `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression string `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout int64 `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod int64 `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin bool `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod int64 `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName string                                                          `json:"score_response_header_name"`
	JSON                    rulesetGetResponseRulesRulesetsSetCacheControlRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*RulesetGetResponseRulesRulesetsSetCacheControlRuleRatelimit) UnmarshalJSON added in v6.9.0 

func (r *RulesetGetResponseRulesRulesetsSetCacheControlRuleRatelimit) UnmarshalJSON(data []byte) (err error)

type RulesetGetResponseRulesRulesetsSetCacheTagsRule added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheTagsRule struct {
	// The timestamp of when the rule was last modified.
	LastUpdated time.Time `json:"last_updated" api:"required" format:"date-time"`
	// The version of the rule.
	Version string `json:"version" api:"required"`
	// The unique ID of the rule.
	ID string `json:"id"`
	// The action to perform when the rule matches.
	Action RulesetGetResponseRulesRulesetsSetCacheTagsRuleAction `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParameters `json:"action_parameters"`
	// The categories of the rule.
	Categories []string `json:"categories"`
	// An informative description of the rule.
	Description string `json:"description"`
	// Whether the rule should be executed.
	Enabled bool `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck RulesetGetResponseRulesRulesetsSetCacheTagsRuleExposedCredentialCheck `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression string `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging Logging `json:"logging"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit RulesetGetResponseRulesRulesetsSetCacheTagsRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                                              `json:"ref"`
	JSON rulesetGetResponseRulesRulesetsSetCacheTagsRuleJSON `json:"-"`
}

func (*RulesetGetResponseRulesRulesetsSetCacheTagsRule) UnmarshalJSON added in v6.9.0 

func (r *RulesetGetResponseRulesRulesetsSetCacheTagsRule) UnmarshalJSON(data []byte) (err error)

type RulesetGetResponseRulesRulesetsSetCacheTagsRuleAction added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheTagsRuleAction string

The action to perform when the rule matches. 

const (
	RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionSetCacheTags RulesetGetResponseRulesRulesetsSetCacheTagsRuleAction = "set_cache_tags"
)

func (RulesetGetResponseRulesRulesetsSetCacheTagsRuleAction) IsKnown added in v6.9.0 

func (r RulesetGetResponseRulesRulesetsSetCacheTagsRuleAction) IsKnown() bool

type RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParameters added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParameters struct {
	// The operation to perform on the cache tags.
	Operation RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation `json:"operation" api:"required"`
	// An expression that evaluates to an array of cache tag values.
	Expression string `json:"expression"`
	// This field can have the runtime type of [[]string].
	Values interface{}                                                         `json:"values"`
	JSON   rulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersJSON `json:"-"`
	// contains filtered or unexported fields
}

The parameters configuring the rule's action.

func (RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParameters) AsUnion added in v6.9.0 

func (r RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParameters) AsUnion() RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersUnion

AsUnion returns a RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues, RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression, RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues, RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression, RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues, RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression.

func (*RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParameters) UnmarshalJSON added in v6.9.0 

func (r *RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParameters) UnmarshalJSON(data []byte) (err error)

type RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression struct {
	// An expression that evaluates to an array of cache tag values.
	Expression string `json:"expression" api:"required"`
	// The operation to perform on the cache tags.
	Operation RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation `json:"operation" api:"required"`
	JSON      rulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionJSON      `json:"-"`
}

Add cache tags using an expression.

func (*RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression) UnmarshalJSON added in v6.9.0 

func (r *RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression) UnmarshalJSON(data []byte) (err error)

type RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation string

The operation to perform on the cache tags. 

const (
	RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationAdd    RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "add"
	RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationRemove RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "remove"
	RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationSet    RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "set"
)

func (RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation) IsKnown added in v6.9.0 

func (r RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation) IsKnown() bool

type RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues struct {
	// The operation to perform on the cache tags.
	Operation RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation `json:"operation" api:"required"`
	// A list of cache tag values.
	Values []string                                                                              `json:"values" api:"required"`
	JSON   rulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesJSON `json:"-"`
}

Add cache tags using a list of values.

func (*RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues) UnmarshalJSON added in v6.9.0 

func (r *RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues) UnmarshalJSON(data []byte) (err error)

type RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation string

The operation to perform on the cache tags. 

const (
	RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationAdd    RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "add"
	RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationRemove RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "remove"
	RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationSet    RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "set"
)

func (RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation) IsKnown added in v6.9.0 

func (r RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation) IsKnown() bool

type RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation string

The operation to perform on the cache tags. 

const (
	RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersOperationAdd    RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation = "add"
	RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersOperationRemove RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation = "remove"
	RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersOperationSet    RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation = "set"
)

func (RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation) IsKnown added in v6.9.0 

func (r RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation) IsKnown() bool

type RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression struct {
	// An expression that evaluates to an array of cache tag values.
	Expression string `json:"expression" api:"required"`
	// The operation to perform on the cache tags.
	Operation RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation `json:"operation" api:"required"`
	JSON      rulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionJSON      `json:"-"`
}

Remove cache tags using an expression.

func (*RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression) UnmarshalJSON added in v6.9.0 

func (r *RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression) UnmarshalJSON(data []byte) (err error)

type RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation string

The operation to perform on the cache tags. 

const (
	RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationAdd    RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "add"
	RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationRemove RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "remove"
	RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationSet    RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "set"
)

func (RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation) IsKnown added in v6.9.0 

func (r RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation) IsKnown() bool

type RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues struct {
	// The operation to perform on the cache tags.
	Operation RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation `json:"operation" api:"required"`
	// A list of cache tag values.
	Values []string                                                                                 `json:"values" api:"required"`
	JSON   rulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesJSON `json:"-"`
}

Remove cache tags using a list of values.

func (*RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues) UnmarshalJSON added in v6.9.0 

func (r *RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues) UnmarshalJSON(data []byte) (err error)

type RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation string

The operation to perform on the cache tags. 

const (
	RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationAdd    RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "add"
	RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationRemove RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "remove"
	RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationSet    RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "set"
)

func (RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation) IsKnown added in v6.9.0 

func (r RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation) IsKnown() bool

type RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression struct {
	// An expression that evaluates to an array of cache tag values.
	Expression string `json:"expression" api:"required"`
	// The operation to perform on the cache tags.
	Operation RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation `json:"operation" api:"required"`
	JSON      rulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionJSON      `json:"-"`
}

Set cache tags using an expression.

func (*RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression) UnmarshalJSON added in v6.9.0 

func (r *RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression) UnmarshalJSON(data []byte) (err error)

type RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation string

The operation to perform on the cache tags. 

const (
	RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationAdd    RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "add"
	RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationRemove RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "remove"
	RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationSet    RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "set"
)

func (RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation) IsKnown added in v6.9.0 

func (r RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation) IsKnown() bool

type RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues struct {
	// The operation to perform on the cache tags.
	Operation RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation `json:"operation" api:"required"`
	// A list of cache tag values.
	Values []string                                                                              `json:"values" api:"required"`
	JSON   rulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesJSON `json:"-"`
}

Set cache tags using a list of values.

func (*RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues) UnmarshalJSON added in v6.9.0 

func (r *RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues) UnmarshalJSON(data []byte) (err error)

type RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation string

The operation to perform on the cache tags. 

const (
	RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationAdd    RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "add"
	RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationRemove RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "remove"
	RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationSet    RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "set"
)

func (RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation) IsKnown added in v6.9.0 

func (r RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation) IsKnown() bool

type RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersUnion added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersUnion interface {
	// contains filtered or unexported methods
}

The parameters configuring the rule's action.

Union satisfied by RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues, RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression, RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues, RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression, RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues or RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression.

type RulesetGetResponseRulesRulesetsSetCacheTagsRuleExposedCredentialCheck added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheTagsRuleExposedCredentialCheck struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression string `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression string                                                                    `json:"username_expression" api:"required"`
	JSON               rulesetGetResponseRulesRulesetsSetCacheTagsRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*RulesetGetResponseRulesRulesetsSetCacheTagsRuleExposedCredentialCheck) UnmarshalJSON added in v6.9.0 

func (r *RulesetGetResponseRulesRulesetsSetCacheTagsRuleExposedCredentialCheck) UnmarshalJSON(data []byte) (err error)

type RulesetGetResponseRulesRulesetsSetCacheTagsRuleRatelimit added in v6.9.0 

type RulesetGetResponseRulesRulesetsSetCacheTagsRuleRatelimit struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics []string `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period int64 `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression string `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout int64 `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod int64 `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin bool `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod int64 `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName string                                                       `json:"score_response_header_name"`
	JSON                    rulesetGetResponseRulesRulesetsSetCacheTagsRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*RulesetGetResponseRulesRulesetsSetCacheTagsRuleRatelimit) UnmarshalJSON added in v6.9.0 

func (r *RulesetGetResponseRulesRulesetsSetCacheTagsRuleRatelimit) UnmarshalJSON(data []byte) (err error)

type RulesetGetResponseRulesUnion 

type RulesetGetResponseRulesUnion interface {
	// contains filtered or unexported methods
}

Union satisfied by BlockRule, RulesetGetResponseRulesRulesetsChallengeRule, CompressResponseRule, DDoSDynamicRule, ExecuteRule, ForceConnectionCloseRule, RulesetGetResponseRulesRulesetsJSChallengeRule, LogRule, LogCustomFieldRule, ManagedChallengeRule, RedirectRule, RewriteRule, RouteRule, ScoreRule, ServeErrorRule, RulesetGetResponseRulesRulesetsSetCacheControlRule, SetCacheSettingsRule, RulesetGetResponseRulesRulesetsSetCacheTagsRule, SetConfigRule or SkipRule.

type RulesetListParams 

type RulesetListParams struct {
	// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
	AccountID param.Field[string] `path:"account_id"`
	// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
	ZoneID param.Field[string] `path:"zone_id"`
	// The cursor to use for the next page.
	Cursor param.Field[string] `query:"cursor"`
	// The number of rulesets to return per page.
	PerPage param.Field[int64] `query:"per_page"`
}

func (RulesetListParams) URLQuery 

func (r RulesetListParams) URLQuery() (v url.Values)

URLQuery serializes RulesetListParams's query parameters as `url.Values`.

type RulesetListResponse 

type RulesetListResponse struct {
	// The unique ID of the ruleset.
	ID string `json:"id" api:"required"`
	// The kind of the ruleset.
	Kind Kind `json:"kind" api:"required"`
	// The timestamp of when the ruleset was last modified.
	LastUpdated time.Time `json:"last_updated" api:"required" format:"date-time"`
	// The human-readable name of the ruleset.
	Name string `json:"name" api:"required"`
	// The phase of the ruleset.
	Phase Phase `json:"phase" api:"required"`
	// The version of the ruleset.
	Version string `json:"version" api:"required"`
	// An informative description of the ruleset.
	Description string                  `json:"description"`
	JSON        rulesetListResponseJSON `json:"-"`
}

A ruleset object.

func (*RulesetListResponse) UnmarshalJSON 

func (r *RulesetListResponse) UnmarshalJSON(data []byte) (err error)

type RulesetNewParams 

type RulesetNewParams struct {
	// The kind of the ruleset.
	Kind param.Field[Kind] `json:"kind" api:"required"`
	// The human-readable name of the ruleset.
	Name param.Field[string] `json:"name" api:"required"`
	// The phase of the ruleset.
	Phase param.Field[Phase] `json:"phase" api:"required"`
	// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
	AccountID param.Field[string] `path:"account_id"`
	// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
	ZoneID param.Field[string] `path:"zone_id"`
	// An informative description of the ruleset.
	Description param.Field[string] `json:"description"`
	// The list of rules in the ruleset.
	Rules param.Field[[]RulesetNewParamsRuleUnion] `json:"rules"`
}

func (RulesetNewParams) MarshalJSON 

func (r RulesetNewParams) MarshalJSON() (data []byte, err error)

type RulesetNewParamsRule 

type RulesetNewParamsRule struct {
	// The unique ID of the rule.
	ID param.Field[string] `json:"id"`
	// The action to perform when the rule matches.
	Action           param.Field[RulesetNewParamsRulesAction] `json:"action"`
	ActionParameters param.Field[interface{}]                 `json:"action_parameters"`
	Categories       param.Field[interface{}]                 `json:"categories"`
	// An informative description of the rule.
	Description param.Field[string] `json:"description"`
	// Whether the rule should be executed.
	Enabled                param.Field[bool]        `json:"enabled"`
	ExposedCredentialCheck param.Field[interface{}] `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression param.Field[string] `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging   param.Field[LoggingParam] `json:"logging"`
	Ratelimit param.Field[interface{}]  `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref param.Field[string] `json:"ref"`
}

func (RulesetNewParamsRule) MarshalJSON 

func (r RulesetNewParamsRule) MarshalJSON() (data []byte, err error)

type RulesetNewParamsRuleUnion 

type RulesetNewParamsRuleUnion interface {
	// contains filtered or unexported methods
}

Satisfied by rulesets.BlockRuleParam, rulesets.RulesetNewParamsRulesRulesetsChallengeRule, rulesets.CompressResponseRuleParam, rulesets.DDoSDynamicRuleParam, rulesets.ExecuteRuleParam, rulesets.ForceConnectionCloseRuleParam, rulesets.RulesetNewParamsRulesRulesetsJSChallengeRule, rulesets.LogRuleParam, rulesets.LogCustomFieldRuleParam, rulesets.ManagedChallengeRuleParam, rulesets.RedirectRuleParam, rulesets.RewriteRuleParam, rulesets.RouteRuleParam, rulesets.ScoreRuleParam, rulesets.ServeErrorRuleParam, rulesets.RulesetNewParamsRulesRulesetsSetCacheControlRule, rulesets.SetCacheSettingsRuleParam, rulesets.RulesetNewParamsRulesRulesetsSetCacheTagsRule, rulesets.SetConfigRuleParam, rulesets.SkipRuleParam, RulesetNewParamsRule.

type RulesetNewParamsRulesAction 

type RulesetNewParamsRulesAction string

The action to perform when the rule matches. 

const (
	RulesetNewParamsRulesActionBlock                RulesetNewParamsRulesAction = "block"
	RulesetNewParamsRulesActionChallenge            RulesetNewParamsRulesAction = "challenge"
	RulesetNewParamsRulesActionCompressResponse     RulesetNewParamsRulesAction = "compress_response"
	RulesetNewParamsRulesActionDDoSDynamic          RulesetNewParamsRulesAction = "ddos_dynamic"
	RulesetNewParamsRulesActionExecute              RulesetNewParamsRulesAction = "execute"
	RulesetNewParamsRulesActionForceConnectionClose RulesetNewParamsRulesAction = "force_connection_close"
	RulesetNewParamsRulesActionJSChallenge          RulesetNewParamsRulesAction = "js_challenge"
	RulesetNewParamsRulesActionLog                  RulesetNewParamsRulesAction = "log"
	RulesetNewParamsRulesActionLogCustomField       RulesetNewParamsRulesAction = "log_custom_field"
	RulesetNewParamsRulesActionManagedChallenge     RulesetNewParamsRulesAction = "managed_challenge"
	RulesetNewParamsRulesActionRedirect             RulesetNewParamsRulesAction = "redirect"
	RulesetNewParamsRulesActionRewrite              RulesetNewParamsRulesAction = "rewrite"
	RulesetNewParamsRulesActionRoute                RulesetNewParamsRulesAction = "route"
	RulesetNewParamsRulesActionScore                RulesetNewParamsRulesAction = "score"
	RulesetNewParamsRulesActionServeError           RulesetNewParamsRulesAction = "serve_error"
	RulesetNewParamsRulesActionSetCacheControl      RulesetNewParamsRulesAction = "set_cache_control"
	RulesetNewParamsRulesActionSetCacheSettings     RulesetNewParamsRulesAction = "set_cache_settings"
	RulesetNewParamsRulesActionSetCacheTags         RulesetNewParamsRulesAction = "set_cache_tags"
	RulesetNewParamsRulesActionSetConfig            RulesetNewParamsRulesAction = "set_config"
	RulesetNewParamsRulesActionSkip                 RulesetNewParamsRulesAction = "skip"
)

func (RulesetNewParamsRulesAction) IsKnown 

func (r RulesetNewParamsRulesAction) IsKnown() bool

type RulesetNewParamsRulesRulesetsChallengeRule 

type RulesetNewParamsRulesRulesetsChallengeRule struct {
	// The unique ID of the rule.
	ID param.Field[string] `json:"id"`
	// The action to perform when the rule matches.
	Action param.Field[RulesetNewParamsRulesRulesetsChallengeRuleAction] `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters param.Field[interface{}] `json:"action_parameters"`
	// An informative description of the rule.
	Description param.Field[string] `json:"description"`
	// Whether the rule should be executed.
	Enabled param.Field[bool] `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck param.Field[RulesetNewParamsRulesRulesetsChallengeRuleExposedCredentialCheck] `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression param.Field[string] `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging param.Field[LoggingParam] `json:"logging"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit param.Field[RulesetNewParamsRulesRulesetsChallengeRuleRatelimit] `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref param.Field[string] `json:"ref"`
}

func (RulesetNewParamsRulesRulesetsChallengeRule) MarshalJSON 

func (r RulesetNewParamsRulesRulesetsChallengeRule) MarshalJSON() (data []byte, err error)

type RulesetNewParamsRulesRulesetsChallengeRuleAction 

type RulesetNewParamsRulesRulesetsChallengeRuleAction string

The action to perform when the rule matches. 

const (
	RulesetNewParamsRulesRulesetsChallengeRuleActionChallenge RulesetNewParamsRulesRulesetsChallengeRuleAction = "challenge"
)

func (RulesetNewParamsRulesRulesetsChallengeRuleAction) IsKnown 

func (r RulesetNewParamsRulesRulesetsChallengeRuleAction) IsKnown() bool

type RulesetNewParamsRulesRulesetsChallengeRuleExposedCredentialCheck 

type RulesetNewParamsRulesRulesetsChallengeRuleExposedCredentialCheck struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression param.Field[string] `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression param.Field[string] `json:"username_expression" api:"required"`
}

Configuration for exposed credential checking.

func (RulesetNewParamsRulesRulesetsChallengeRuleExposedCredentialCheck) MarshalJSON 

func (r RulesetNewParamsRulesRulesetsChallengeRuleExposedCredentialCheck) MarshalJSON() (data []byte, err error)

type RulesetNewParamsRulesRulesetsChallengeRuleRatelimit 

type RulesetNewParamsRulesRulesetsChallengeRuleRatelimit struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics param.Field[[]string] `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period param.Field[int64] `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression param.Field[string] `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout param.Field[int64] `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod param.Field[int64] `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin param.Field[bool] `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod param.Field[int64] `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName param.Field[string] `json:"score_response_header_name"`
}

An object configuring the rule's rate limit behavior.

func (RulesetNewParamsRulesRulesetsChallengeRuleRatelimit) MarshalJSON 

func (r RulesetNewParamsRulesRulesetsChallengeRuleRatelimit) MarshalJSON() (data []byte, err error)

type RulesetNewParamsRulesRulesetsJSChallengeRule 

type RulesetNewParamsRulesRulesetsJSChallengeRule struct {
	// The unique ID of the rule.
	ID param.Field[string] `json:"id"`
	// The action to perform when the rule matches.
	Action param.Field[RulesetNewParamsRulesRulesetsJSChallengeRuleAction] `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters param.Field[interface{}] `json:"action_parameters"`
	// An informative description of the rule.
	Description param.Field[string] `json:"description"`
	// Whether the rule should be executed.
	Enabled param.Field[bool] `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck param.Field[RulesetNewParamsRulesRulesetsJSChallengeRuleExposedCredentialCheck] `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression param.Field[string] `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging param.Field[LoggingParam] `json:"logging"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit param.Field[RulesetNewParamsRulesRulesetsJSChallengeRuleRatelimit] `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref param.Field[string] `json:"ref"`
}

func (RulesetNewParamsRulesRulesetsJSChallengeRule) MarshalJSON 

func (r RulesetNewParamsRulesRulesetsJSChallengeRule) MarshalJSON() (data []byte, err error)

type RulesetNewParamsRulesRulesetsJSChallengeRuleAction 

type RulesetNewParamsRulesRulesetsJSChallengeRuleAction string

The action to perform when the rule matches. 

const (
	RulesetNewParamsRulesRulesetsJSChallengeRuleActionJSChallenge RulesetNewParamsRulesRulesetsJSChallengeRuleAction = "js_challenge"
)

func (RulesetNewParamsRulesRulesetsJSChallengeRuleAction) IsKnown 

func (r RulesetNewParamsRulesRulesetsJSChallengeRuleAction) IsKnown() bool

type RulesetNewParamsRulesRulesetsJSChallengeRuleExposedCredentialCheck 

type RulesetNewParamsRulesRulesetsJSChallengeRuleExposedCredentialCheck struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression param.Field[string] `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression param.Field[string] `json:"username_expression" api:"required"`
}

Configuration for exposed credential checking.

func (RulesetNewParamsRulesRulesetsJSChallengeRuleExposedCredentialCheck) MarshalJSON 

func (r RulesetNewParamsRulesRulesetsJSChallengeRuleExposedCredentialCheck) MarshalJSON() (data []byte, err error)

type RulesetNewParamsRulesRulesetsJSChallengeRuleRatelimit 

type RulesetNewParamsRulesRulesetsJSChallengeRuleRatelimit struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics param.Field[[]string] `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period param.Field[int64] `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression param.Field[string] `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout param.Field[int64] `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod param.Field[int64] `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin param.Field[bool] `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod param.Field[int64] `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName param.Field[string] `json:"score_response_header_name"`
}

An object configuring the rule's rate limit behavior.

func (RulesetNewParamsRulesRulesetsJSChallengeRuleRatelimit) MarshalJSON 

func (r RulesetNewParamsRulesRulesetsJSChallengeRuleRatelimit) MarshalJSON() (data []byte, err error)

type RulesetNewParamsRulesRulesetsSetCacheControlRule added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRule struct {
	// The unique ID of the rule.
	ID param.Field[string] `json:"id"`
	// The action to perform when the rule matches.
	Action param.Field[RulesetNewParamsRulesRulesetsSetCacheControlRuleAction] `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters param.Field[RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParameters] `json:"action_parameters"`
	// An informative description of the rule.
	Description param.Field[string] `json:"description"`
	// Whether the rule should be executed.
	Enabled param.Field[bool] `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck param.Field[RulesetNewParamsRulesRulesetsSetCacheControlRuleExposedCredentialCheck] `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression param.Field[string] `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging param.Field[LoggingParam] `json:"logging"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit param.Field[RulesetNewParamsRulesRulesetsSetCacheControlRuleRatelimit] `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref param.Field[string] `json:"ref"`
}

func (RulesetNewParamsRulesRulesetsSetCacheControlRule) MarshalJSON added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheControlRule) MarshalJSON() (data []byte, err error)

type RulesetNewParamsRulesRulesetsSetCacheControlRuleAction added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleAction string

The action to perform when the rule matches. 

const (
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionSetCacheControl RulesetNewParamsRulesRulesetsSetCacheControlRuleAction = "set_cache_control"
)

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleAction) IsKnown added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheControlRuleAction) IsKnown() bool

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParameters added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParameters struct {
	// A cache-control directive configuration.
	Immutable param.Field[RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableUnion] `json:"immutable"`
	// A cache-control directive configuration that accepts a duration value in
	// seconds.
	MaxAge param.Field[RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeUnion] `json:"max-age"`
	// A cache-control directive configuration.
	MustRevalidate param.Field[RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateUnion] `json:"must-revalidate"`
	// A cache-control directive configuration.
	MustUnderstand param.Field[RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandUnion] `json:"must-understand"`
	// A cache-control directive configuration that accepts optional qualifiers (header
	// names).
	NoCache param.Field[RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheUnion] `json:"no-cache"`
	// A cache-control directive configuration.
	NoStore param.Field[RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreUnion] `json:"no-store"`
	// A cache-control directive configuration.
	NoTransform param.Field[RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformUnion] `json:"no-transform"`
	// A cache-control directive configuration that accepts optional qualifiers (header
	// names).
	Private param.Field[RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateUnion] `json:"private"`
	// A cache-control directive configuration.
	ProxyRevalidate param.Field[RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateUnion] `json:"proxy-revalidate"`
	// A cache-control directive configuration.
	Public param.Field[RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPublicUnion] `json:"public"`
	// A cache-control directive configuration that accepts a duration value in
	// seconds.
	SMaxage param.Field[RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageUnion] `json:"s-maxage"`
	// A cache-control directive configuration that accepts a duration value in
	// seconds.
	StaleIfError param.Field[RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorUnion] `json:"stale-if-error"`
	// A cache-control directive configuration that accepts a duration value in
	// seconds.
	StaleWhileRevalidate param.Field[RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateUnion] `json:"stale-while-revalidate"`
}

The parameters configuring the rule's action.

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParameters) MarshalJSON added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParameters) MarshalJSON() (data []byte, err error)

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersImmutable added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersImmutable struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

A cache-control directive configuration.

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersImmutable) MarshalJSON added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersImmutable) MarshalJSON() (data []byte, err error)

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableOperationSet    RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation = "set"
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation = "remove"
)

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation) IsKnown added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation) IsKnown() bool

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Remove the directive.

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective) MarshalJSON added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective) MarshalJSON() (data []byte, err error)

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperationSet    RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation = "set"
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation = "remove"
)

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation) IsKnown() bool

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Set the directive.

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective) MarshalJSON added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective) MarshalJSON() (data []byte, err error)

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperationSet    RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation = "set"
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation = "remove"
)

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation) IsKnown() bool

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableUnion added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Satisfied by rulesets.RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective, rulesets.RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective, RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersImmutable.

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAge added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAge struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
	// The duration value in seconds for the directive.
	Value param.Field[int64] `json:"value"`
}

A cache-control directive configuration that accepts a duration value in seconds.

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAge) MarshalJSON added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAge) MarshalJSON() (data []byte, err error)

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperationSet    RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation = "set"
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation = "remove"
)

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation) IsKnown added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation) IsKnown() bool

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Remove the directive.

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective) MarshalJSON added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective) MarshalJSON() (data []byte, err error)

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperationSet    RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation = "set"
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation = "remove"
)

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation) IsKnown() bool

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation] `json:"operation" api:"required"`
	// The duration value in seconds for the directive.
	Value param.Field[int64] `json:"value" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Set the directive with a duration value in seconds.

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective) MarshalJSON added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective) MarshalJSON() (data []byte, err error)

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperationSet    RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation = "set"
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation = "remove"
)

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation) IsKnown() bool

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeUnion added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts a duration value in seconds.

Satisfied by rulesets.RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective, rulesets.RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective, RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAge.

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

A cache-control directive configuration.

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate) MarshalJSON added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate) MarshalJSON() (data []byte, err error)

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperationSet    RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation = "set"
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation = "remove"
)

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation) IsKnown added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation) IsKnown() bool

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Remove the directive.

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective) MarshalJSON added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective) MarshalJSON() (data []byte, err error)

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperationSet    RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation = "set"
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation = "remove"
)

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation) IsKnown() bool

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Set the directive.

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective) MarshalJSON added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective) MarshalJSON() (data []byte, err error)

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperationSet    RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation = "set"
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation = "remove"
)

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation) IsKnown() bool

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateUnion added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Satisfied by rulesets.RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective, rulesets.RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective, RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate.

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

A cache-control directive configuration.

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand) MarshalJSON added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand) MarshalJSON() (data []byte, err error)

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperationSet    RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation = "set"
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation = "remove"
)

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation) IsKnown added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation) IsKnown() bool

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Remove the directive.

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective) MarshalJSON added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective) MarshalJSON() (data []byte, err error)

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperationSet    RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation = "set"
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation = "remove"
)

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation) IsKnown() bool

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Set the directive.

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective) MarshalJSON added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective) MarshalJSON() (data []byte, err error)

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperationSet    RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation = "set"
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation = "remove"
)

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation) IsKnown() bool

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandUnion added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Satisfied by rulesets.RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective, rulesets.RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective, RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand.

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoCache added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoCache struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool]        `json:"cloudflare_only"`
	Qualifiers     param.Field[interface{}] `json:"qualifiers"`
}

A cache-control directive configuration that accepts optional qualifiers (header names).

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoCache) MarshalJSON added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoCache) MarshalJSON() (data []byte, err error)

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperationSet    RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation = "set"
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation = "remove"
)

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation) IsKnown added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation) IsKnown() bool

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Remove the directive.

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective) MarshalJSON added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective) MarshalJSON() (data []byte, err error)

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperationSet    RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation = "set"
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation = "remove"
)

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation) IsKnown() bool

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
	// Optional list of header names to qualify the directive (e.g., for "private" or
	// "no-cache" directives).
	Qualifiers param.Field[[]string] `json:"qualifiers"`
}

Set the directive with optional qualifiers.

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective) MarshalJSON added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective) MarshalJSON() (data []byte, err error)

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperationSet    RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation = "set"
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation = "remove"
)

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation) IsKnown() bool

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheUnion added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts optional qualifiers (header names).

Satisfied by rulesets.RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective, rulesets.RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective, RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoCache.

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoStore added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoStore struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

A cache-control directive configuration.

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoStore) MarshalJSON added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoStore) MarshalJSON() (data []byte, err error)

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperationSet    RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation = "set"
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation = "remove"
)

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation) IsKnown added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation) IsKnown() bool

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Remove the directive.

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective) MarshalJSON added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective) MarshalJSON() (data []byte, err error)

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperationSet    RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation = "set"
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation = "remove"
)

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation) IsKnown() bool

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Set the directive.

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective) MarshalJSON added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective) MarshalJSON() (data []byte, err error)

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperationSet    RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation = "set"
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation = "remove"
)

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation) IsKnown() bool

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreUnion added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Satisfied by rulesets.RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective, rulesets.RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective, RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoStore.

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransform added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransform struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

A cache-control directive configuration.

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransform) MarshalJSON added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransform) MarshalJSON() (data []byte, err error)

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperationSet    RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation = "set"
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation = "remove"
)

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation) IsKnown added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation) IsKnown() bool

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Remove the directive.

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective) MarshalJSON added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective) MarshalJSON() (data []byte, err error)

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperationSet    RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation = "set"
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation = "remove"
)

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation) IsKnown() bool

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Set the directive.

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective) MarshalJSON added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective) MarshalJSON() (data []byte, err error)

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperationSet    RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation = "set"
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation = "remove"
)

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation) IsKnown() bool

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformUnion added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Satisfied by rulesets.RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective, rulesets.RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective, RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransform.

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPrivate added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPrivate struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool]        `json:"cloudflare_only"`
	Qualifiers     param.Field[interface{}] `json:"qualifiers"`
}

A cache-control directive configuration that accepts optional qualifiers (header names).

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPrivate) MarshalJSON added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPrivate) MarshalJSON() (data []byte, err error)

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateOperationSet    RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation = "set"
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation = "remove"
)

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation) IsKnown added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation) IsKnown() bool

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Remove the directive.

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective) MarshalJSON added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective) MarshalJSON() (data []byte, err error)

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperationSet    RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation = "set"
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation = "remove"
)

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation) IsKnown() bool

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
	// Optional list of header names to qualify the directive (e.g., for "private" or
	// "no-cache" directives).
	Qualifiers param.Field[[]string] `json:"qualifiers"`
}

Set the directive with optional qualifiers.

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective) MarshalJSON added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective) MarshalJSON() (data []byte, err error)

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperationSet    RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation = "set"
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation = "remove"
)

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation) IsKnown() bool

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateUnion added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts optional qualifiers (header names).

Satisfied by rulesets.RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective, rulesets.RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective, RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPrivate.

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

A cache-control directive configuration.

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate) MarshalJSON added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate) MarshalJSON() (data []byte, err error)

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperationSet    RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation = "set"
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation = "remove"
)

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation) IsKnown added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation) IsKnown() bool

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Remove the directive.

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective) MarshalJSON added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective) MarshalJSON() (data []byte, err error)

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperationSet    RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation = "set"
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation = "remove"
)

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation) IsKnown() bool

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Set the directive.

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective) MarshalJSON added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective) MarshalJSON() (data []byte, err error)

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperationSet    RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation = "set"
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation = "remove"
)

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation) IsKnown() bool

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateUnion added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Satisfied by rulesets.RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective, rulesets.RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective, RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate.

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPublic added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPublic struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPublicOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

A cache-control directive configuration.

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPublic) MarshalJSON added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPublic) MarshalJSON() (data []byte, err error)

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPublicOperation added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPublicOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPublicOperationSet    RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPublicOperation = "set"
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPublicOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPublicOperation = "remove"
)

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPublicOperation) IsKnown added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPublicOperation) IsKnown() bool

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Remove the directive.

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective) MarshalJSON added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective) MarshalJSON() (data []byte, err error)

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperationSet    RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation = "set"
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation = "remove"
)

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation) IsKnown() bool

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Set the directive.

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective) MarshalJSON added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective) MarshalJSON() (data []byte, err error)

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperationSet    RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation = "set"
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation = "remove"
)

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation) IsKnown() bool

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPublicUnion added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPublicUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Satisfied by rulesets.RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective, rulesets.RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective, RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPublic.

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxage added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxage struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
	// The duration value in seconds for the directive.
	Value param.Field[int64] `json:"value"`
}

A cache-control directive configuration that accepts a duration value in seconds.

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxage) MarshalJSON added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxage) MarshalJSON() (data []byte, err error)

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperationSet    RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation = "set"
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation = "remove"
)

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation) IsKnown added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation) IsKnown() bool

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Remove the directive.

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective) MarshalJSON added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective) MarshalJSON() (data []byte, err error)

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperationSet    RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation = "set"
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation = "remove"
)

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation) IsKnown() bool

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation] `json:"operation" api:"required"`
	// The duration value in seconds for the directive.
	Value param.Field[int64] `json:"value" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Set the directive with a duration value in seconds.

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective) MarshalJSON added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective) MarshalJSON() (data []byte, err error)

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperationSet    RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation = "set"
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation = "remove"
)

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation) IsKnown() bool

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageUnion added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts a duration value in seconds.

Satisfied by rulesets.RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective, rulesets.RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective, RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxage.

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfError added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfError struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
	// The duration value in seconds for the directive.
	Value param.Field[int64] `json:"value"`
}

A cache-control directive configuration that accepts a duration value in seconds.

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfError) MarshalJSON added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfError) MarshalJSON() (data []byte, err error)

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperationSet    RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation = "set"
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation = "remove"
)

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation) IsKnown added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation) IsKnown() bool

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Remove the directive.

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective) MarshalJSON added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective) MarshalJSON() (data []byte, err error)

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperationSet    RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation = "set"
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation = "remove"
)

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation) IsKnown() bool

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation] `json:"operation" api:"required"`
	// The duration value in seconds for the directive.
	Value param.Field[int64] `json:"value" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Set the directive with a duration value in seconds.

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective) MarshalJSON added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective) MarshalJSON() (data []byte, err error)

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperationSet    RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation = "set"
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation = "remove"
)

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation) IsKnown() bool

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorUnion added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts a duration value in seconds.

Satisfied by rulesets.RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective, rulesets.RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective, RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfError.

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
	// The duration value in seconds for the directive.
	Value param.Field[int64] `json:"value"`
}

A cache-control directive configuration that accepts a duration value in seconds.

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate) MarshalJSON added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate) MarshalJSON() (data []byte, err error)

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperationSet    RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation = "set"
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation = "remove"
)

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation) IsKnown added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation) IsKnown() bool

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Remove the directive.

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective) MarshalJSON added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective) MarshalJSON() (data []byte, err error)

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperationSet    RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation = "set"
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation = "remove"
)

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation) IsKnown() bool

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation] `json:"operation" api:"required"`
	// The duration value in seconds for the directive.
	Value param.Field[int64] `json:"value" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Set the directive with a duration value in seconds.

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective) MarshalJSON added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective) MarshalJSON() (data []byte, err error)

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperationSet    RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation = "set"
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation = "remove"
)

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation) IsKnown() bool

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateUnion added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts a duration value in seconds.

Satisfied by rulesets.RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective, rulesets.RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective, RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate.

type RulesetNewParamsRulesRulesetsSetCacheControlRuleExposedCredentialCheck added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleExposedCredentialCheck struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression param.Field[string] `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression param.Field[string] `json:"username_expression" api:"required"`
}

Configuration for exposed credential checking.

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleExposedCredentialCheck) MarshalJSON added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheControlRuleExposedCredentialCheck) MarshalJSON() (data []byte, err error)

type RulesetNewParamsRulesRulesetsSetCacheControlRuleRatelimit added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheControlRuleRatelimit struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics param.Field[[]string] `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period param.Field[int64] `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression param.Field[string] `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout param.Field[int64] `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod param.Field[int64] `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin param.Field[bool] `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod param.Field[int64] `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName param.Field[string] `json:"score_response_header_name"`
}

An object configuring the rule's rate limit behavior.

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleRatelimit) MarshalJSON added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheControlRuleRatelimit) MarshalJSON() (data []byte, err error)

type RulesetNewParamsRulesRulesetsSetCacheTagsRule added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheTagsRule struct {
	// The unique ID of the rule.
	ID param.Field[string] `json:"id"`
	// The action to perform when the rule matches.
	Action param.Field[RulesetNewParamsRulesRulesetsSetCacheTagsRuleAction] `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters param.Field[RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersUnion] `json:"action_parameters"`
	// An informative description of the rule.
	Description param.Field[string] `json:"description"`
	// Whether the rule should be executed.
	Enabled param.Field[bool] `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck param.Field[RulesetNewParamsRulesRulesetsSetCacheTagsRuleExposedCredentialCheck] `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression param.Field[string] `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging param.Field[LoggingParam] `json:"logging"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit param.Field[RulesetNewParamsRulesRulesetsSetCacheTagsRuleRatelimit] `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref param.Field[string] `json:"ref"`
}

func (RulesetNewParamsRulesRulesetsSetCacheTagsRule) MarshalJSON added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheTagsRule) MarshalJSON() (data []byte, err error)

type RulesetNewParamsRulesRulesetsSetCacheTagsRuleAction added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheTagsRuleAction string

The action to perform when the rule matches. 

const (
	RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionSetCacheTags RulesetNewParamsRulesRulesetsSetCacheTagsRuleAction = "set_cache_tags"
)

func (RulesetNewParamsRulesRulesetsSetCacheTagsRuleAction) IsKnown added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheTagsRuleAction) IsKnown() bool

type RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParameters added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParameters struct {
	// The operation to perform on the cache tags.
	Operation param.Field[RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersOperation] `json:"operation" api:"required"`
	// An expression that evaluates to an array of cache tag values.
	Expression param.Field[string]      `json:"expression"`
	Values     param.Field[interface{}] `json:"values"`
}

The parameters configuring the rule's action.

func (RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParameters) MarshalJSON added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParameters) MarshalJSON() (data []byte, err error)

type RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression struct {
	// An expression that evaluates to an array of cache tag values.
	Expression param.Field[string] `json:"expression" api:"required"`
	// The operation to perform on the cache tags.
	Operation param.Field[RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation] `json:"operation" api:"required"`
}

Add cache tags using an expression.

func (RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression) MarshalJSON added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression) MarshalJSON() (data []byte, err error)

type RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation string

The operation to perform on the cache tags. 

const (
	RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationAdd    RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "add"
	RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationRemove RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "remove"
	RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationSet    RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "set"
)

func (RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation) IsKnown added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation) IsKnown() bool

type RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues struct {
	// The operation to perform on the cache tags.
	Operation param.Field[RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation] `json:"operation" api:"required"`
	// A list of cache tag values.
	Values param.Field[[]string] `json:"values" api:"required"`
}

Add cache tags using a list of values.

func (RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues) MarshalJSON added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues) MarshalJSON() (data []byte, err error)

type RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation string

The operation to perform on the cache tags. 

const (
	RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationAdd    RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "add"
	RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationRemove RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "remove"
	RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationSet    RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "set"
)

func (RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation) IsKnown added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation) IsKnown() bool

type RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersOperation added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersOperation string

The operation to perform on the cache tags. 

const (
	RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersOperationAdd    RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersOperation = "add"
	RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersOperationRemove RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersOperation = "remove"
	RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersOperationSet    RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersOperation = "set"
)

func (RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersOperation) IsKnown added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersOperation) IsKnown() bool

type RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression struct {
	// An expression that evaluates to an array of cache tag values.
	Expression param.Field[string] `json:"expression" api:"required"`
	// The operation to perform on the cache tags.
	Operation param.Field[RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation] `json:"operation" api:"required"`
}

Remove cache tags using an expression.

func (RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression) MarshalJSON added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression) MarshalJSON() (data []byte, err error)

type RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation string

The operation to perform on the cache tags. 

const (
	RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationAdd    RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "add"
	RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationRemove RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "remove"
	RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationSet    RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "set"
)

func (RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation) IsKnown added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation) IsKnown() bool

type RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues struct {
	// The operation to perform on the cache tags.
	Operation param.Field[RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation] `json:"operation" api:"required"`
	// A list of cache tag values.
	Values param.Field[[]string] `json:"values" api:"required"`
}

Remove cache tags using a list of values.

func (RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues) MarshalJSON added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues) MarshalJSON() (data []byte, err error)

type RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation string

The operation to perform on the cache tags. 

const (
	RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationAdd    RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "add"
	RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationRemove RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "remove"
	RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationSet    RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "set"
)

func (RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation) IsKnown added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation) IsKnown() bool

type RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression struct {
	// An expression that evaluates to an array of cache tag values.
	Expression param.Field[string] `json:"expression" api:"required"`
	// The operation to perform on the cache tags.
	Operation param.Field[RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation] `json:"operation" api:"required"`
}

Set cache tags using an expression.

func (RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression) MarshalJSON added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression) MarshalJSON() (data []byte, err error)

type RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation string

The operation to perform on the cache tags. 

const (
	RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationAdd    RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "add"
	RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationRemove RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "remove"
	RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationSet    RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "set"
)

func (RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation) IsKnown added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation) IsKnown() bool

type RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues struct {
	// The operation to perform on the cache tags.
	Operation param.Field[RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation] `json:"operation" api:"required"`
	// A list of cache tag values.
	Values param.Field[[]string] `json:"values" api:"required"`
}

Set cache tags using a list of values.

func (RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues) MarshalJSON added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues) MarshalJSON() (data []byte, err error)

type RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation string

The operation to perform on the cache tags. 

const (
	RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationAdd    RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "add"
	RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationRemove RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "remove"
	RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationSet    RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "set"
)

func (RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation) IsKnown added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation) IsKnown() bool

type RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersUnion added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersUnion interface {
	// contains filtered or unexported methods
}

The parameters configuring the rule's action.

Satisfied by rulesets.RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues, rulesets.RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression, rulesets.RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues, rulesets.RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression, rulesets.RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues, rulesets.RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression, RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParameters.

type RulesetNewParamsRulesRulesetsSetCacheTagsRuleExposedCredentialCheck added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheTagsRuleExposedCredentialCheck struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression param.Field[string] `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression param.Field[string] `json:"username_expression" api:"required"`
}

Configuration for exposed credential checking.

func (RulesetNewParamsRulesRulesetsSetCacheTagsRuleExposedCredentialCheck) MarshalJSON added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheTagsRuleExposedCredentialCheck) MarshalJSON() (data []byte, err error)

type RulesetNewParamsRulesRulesetsSetCacheTagsRuleRatelimit added in v6.9.0 

type RulesetNewParamsRulesRulesetsSetCacheTagsRuleRatelimit struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics param.Field[[]string] `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period param.Field[int64] `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression param.Field[string] `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout param.Field[int64] `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod param.Field[int64] `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin param.Field[bool] `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod param.Field[int64] `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName param.Field[string] `json:"score_response_header_name"`
}

An object configuring the rule's rate limit behavior.

func (RulesetNewParamsRulesRulesetsSetCacheTagsRuleRatelimit) MarshalJSON added in v6.9.0 

func (r RulesetNewParamsRulesRulesetsSetCacheTagsRuleRatelimit) MarshalJSON() (data []byte, err error)

type RulesetNewResponse 

type RulesetNewResponse struct {
	// The unique ID of the ruleset.
	ID string `json:"id" api:"required"`
	// The kind of the ruleset.
	Kind Kind `json:"kind" api:"required"`
	// The timestamp of when the ruleset was last modified.
	LastUpdated time.Time `json:"last_updated" api:"required" format:"date-time"`
	// The human-readable name of the ruleset.
	Name string `json:"name" api:"required"`
	// The phase of the ruleset.
	Phase Phase `json:"phase" api:"required"`
	// The list of rules in the ruleset.
	Rules []RulesetNewResponseRule `json:"rules" api:"required"`
	// The version of the ruleset.
	Version string `json:"version" api:"required"`
	// An informative description of the ruleset.
	Description string                 `json:"description"`
	JSON        rulesetNewResponseJSON `json:"-"`
}

A ruleset object.

func (*RulesetNewResponse) UnmarshalJSON 

func (r *RulesetNewResponse) UnmarshalJSON(data []byte) (err error)

type RulesetNewResponseEnvelope 

type RulesetNewResponseEnvelope struct {
	// A list of error messages.
	Errors []RulesetNewResponseEnvelopeErrors `json:"errors" api:"required"`
	// A list of warning messages.
	Messages []RulesetNewResponseEnvelopeMessages `json:"messages" api:"required"`
	// A ruleset object.
	Result RulesetNewResponse `json:"result" api:"required"`
	// Whether the API call was successful.
	Success RulesetNewResponseEnvelopeSuccess `json:"success" api:"required"`
	JSON    rulesetNewResponseEnvelopeJSON    `json:"-"`
}

A response object.

func (*RulesetNewResponseEnvelope) UnmarshalJSON 

func (r *RulesetNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type RulesetNewResponseEnvelopeErrors 

type RulesetNewResponseEnvelopeErrors struct {
	// A text description of this message.
	Message string `json:"message" api:"required"`
	// A unique code for this message.
	Code int64 `json:"code"`
	// The source of this message.
	Source RulesetNewResponseEnvelopeErrorsSource `json:"source"`
	JSON   rulesetNewResponseEnvelopeErrorsJSON   `json:"-"`
}

A message.

func (*RulesetNewResponseEnvelopeErrors) UnmarshalJSON 

func (r *RulesetNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type RulesetNewResponseEnvelopeErrorsSource 

type RulesetNewResponseEnvelopeErrorsSource struct {
	// A JSON pointer to the field that is the source of the message.
	Pointer string                                     `json:"pointer" api:"required"`
	JSON    rulesetNewResponseEnvelopeErrorsSourceJSON `json:"-"`
}

The source of this message.

func (*RulesetNewResponseEnvelopeErrorsSource) UnmarshalJSON 

func (r *RulesetNewResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)

type RulesetNewResponseEnvelopeMessages 

type RulesetNewResponseEnvelopeMessages struct {
	// A text description of this message.
	Message string `json:"message" api:"required"`
	// A unique code for this message.
	Code int64 `json:"code"`
	// The source of this message.
	Source RulesetNewResponseEnvelopeMessagesSource `json:"source"`
	JSON   rulesetNewResponseEnvelopeMessagesJSON   `json:"-"`
}

A message.

func (*RulesetNewResponseEnvelopeMessages) UnmarshalJSON 

func (r *RulesetNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type RulesetNewResponseEnvelopeMessagesSource 

type RulesetNewResponseEnvelopeMessagesSource struct {
	// A JSON pointer to the field that is the source of the message.
	Pointer string                                       `json:"pointer" api:"required"`
	JSON    rulesetNewResponseEnvelopeMessagesSourceJSON `json:"-"`
}

The source of this message.

func (*RulesetNewResponseEnvelopeMessagesSource) UnmarshalJSON 

func (r *RulesetNewResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)

type RulesetNewResponseEnvelopeSuccess 

type RulesetNewResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	RulesetNewResponseEnvelopeSuccessTrue RulesetNewResponseEnvelopeSuccess = true
)

func (RulesetNewResponseEnvelopeSuccess) IsKnown 

func (r RulesetNewResponseEnvelopeSuccess) IsKnown() bool

type RulesetNewResponseRule 

type RulesetNewResponseRule struct {
	// The timestamp of when the rule was last modified.
	LastUpdated time.Time `json:"last_updated" api:"required" format:"date-time"`
	// The version of the rule.
	Version string `json:"version" api:"required"`
	// The unique ID of the rule.
	ID string `json:"id"`
	// The action to perform when the rule matches.
	Action RulesetNewResponseRulesAction `json:"action"`
	// This field can have the runtime type of [BlockRuleActionParameters],
	// [interface{}], [CompressResponseRuleActionParameters],
	// [ExecuteRuleActionParameters], [LogCustomFieldRuleActionParameters],
	// [RedirectRuleActionParameters], [RewriteRuleActionParameters],
	// [RouteRuleActionParameters], [ScoreRuleActionParameters],
	// [ServeErrorRuleActionParameters],
	// [RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParameters],
	// [SetCacheSettingsRuleActionParameters],
	// [RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParameters],
	// [SetConfigRuleActionParameters], [SkipRuleActionParameters].
	ActionParameters interface{} `json:"action_parameters"`
	// This field can have the runtime type of [[]string].
	Categories interface{} `json:"categories"`
	// An informative description of the rule.
	Description string `json:"description"`
	// Whether the rule should be executed.
	Enabled bool `json:"enabled"`
	// This field can have the runtime type of [BlockRuleExposedCredentialCheck],
	// [RulesetNewResponseRulesRulesetsChallengeRuleExposedCredentialCheck],
	// [CompressResponseRuleExposedCredentialCheck],
	// [DDoSDynamicRuleExposedCredentialCheck], [ExecuteRuleExposedCredentialCheck],
	// [ForceConnectionCloseRuleExposedCredentialCheck],
	// [RulesetNewResponseRulesRulesetsJSChallengeRuleExposedCredentialCheck],
	// [LogRuleExposedCredentialCheck], [LogCustomFieldRuleExposedCredentialCheck],
	// [ManagedChallengeRuleExposedCredentialCheck],
	// [RedirectRuleExposedCredentialCheck], [RewriteRuleExposedCredentialCheck],
	// [RouteRuleExposedCredentialCheck], [ScoreRuleExposedCredentialCheck],
	// [ServeErrorRuleExposedCredentialCheck],
	// [RulesetNewResponseRulesRulesetsSetCacheControlRuleExposedCredentialCheck],
	// [SetCacheSettingsRuleExposedCredentialCheck],
	// [RulesetNewResponseRulesRulesetsSetCacheTagsRuleExposedCredentialCheck],
	// [SetConfigRuleExposedCredentialCheck], [SkipRuleExposedCredentialCheck].
	ExposedCredentialCheck interface{} `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression string `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging Logging `json:"logging"`
	// This field can have the runtime type of [BlockRuleRatelimit],
	// [RulesetNewResponseRulesRulesetsChallengeRuleRatelimit],
	// [CompressResponseRuleRatelimit], [DDoSDynamicRuleRatelimit],
	// [ExecuteRuleRatelimit], [ForceConnectionCloseRuleRatelimit],
	// [RulesetNewResponseRulesRulesetsJSChallengeRuleRatelimit], [LogRuleRatelimit],
	// [LogCustomFieldRuleRatelimit], [ManagedChallengeRuleRatelimit],
	// [RedirectRuleRatelimit], [RewriteRuleRatelimit], [RouteRuleRatelimit],
	// [ScoreRuleRatelimit], [ServeErrorRuleRatelimit],
	// [RulesetNewResponseRulesRulesetsSetCacheControlRuleRatelimit],
	// [SetCacheSettingsRuleRatelimit],
	// [RulesetNewResponseRulesRulesetsSetCacheTagsRuleRatelimit],
	// [SetConfigRuleRatelimit], [SkipRuleRatelimit].
	Ratelimit interface{} `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                     `json:"ref"`
	JSON rulesetNewResponseRuleJSON `json:"-"`
	// contains filtered or unexported fields
}

func (RulesetNewResponseRule) AsUnion 

func (r RulesetNewResponseRule) AsUnion() RulesetNewResponseRulesUnion

AsUnion returns a RulesetNewResponseRulesUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are BlockRule, RulesetNewResponseRulesRulesetsChallengeRule, CompressResponseRule, DDoSDynamicRule, ExecuteRule, ForceConnectionCloseRule, RulesetNewResponseRulesRulesetsJSChallengeRule, LogRule, LogCustomFieldRule, ManagedChallengeRule, RedirectRule, RewriteRule, RouteRule, ScoreRule, ServeErrorRule, RulesetNewResponseRulesRulesetsSetCacheControlRule, SetCacheSettingsRule, RulesetNewResponseRulesRulesetsSetCacheTagsRule, SetConfigRule, SkipRule.

func (*RulesetNewResponseRule) UnmarshalJSON 

func (r *RulesetNewResponseRule) UnmarshalJSON(data []byte) (err error)

type RulesetNewResponseRulesAction 

type RulesetNewResponseRulesAction string

The action to perform when the rule matches. 

const (
	RulesetNewResponseRulesActionBlock                RulesetNewResponseRulesAction = "block"
	RulesetNewResponseRulesActionChallenge            RulesetNewResponseRulesAction = "challenge"
	RulesetNewResponseRulesActionCompressResponse     RulesetNewResponseRulesAction = "compress_response"
	RulesetNewResponseRulesActionDDoSDynamic          RulesetNewResponseRulesAction = "ddos_dynamic"
	RulesetNewResponseRulesActionExecute              RulesetNewResponseRulesAction = "execute"
	RulesetNewResponseRulesActionForceConnectionClose RulesetNewResponseRulesAction = "force_connection_close"
	RulesetNewResponseRulesActionJSChallenge          RulesetNewResponseRulesAction = "js_challenge"
	RulesetNewResponseRulesActionLog                  RulesetNewResponseRulesAction = "log"
	RulesetNewResponseRulesActionLogCustomField       RulesetNewResponseRulesAction = "log_custom_field"
	RulesetNewResponseRulesActionManagedChallenge     RulesetNewResponseRulesAction = "managed_challenge"
	RulesetNewResponseRulesActionRedirect             RulesetNewResponseRulesAction = "redirect"
	RulesetNewResponseRulesActionRewrite              RulesetNewResponseRulesAction = "rewrite"
	RulesetNewResponseRulesActionRoute                RulesetNewResponseRulesAction = "route"
	RulesetNewResponseRulesActionScore                RulesetNewResponseRulesAction = "score"
	RulesetNewResponseRulesActionServeError           RulesetNewResponseRulesAction = "serve_error"
	RulesetNewResponseRulesActionSetCacheControl      RulesetNewResponseRulesAction = "set_cache_control"
	RulesetNewResponseRulesActionSetCacheSettings     RulesetNewResponseRulesAction = "set_cache_settings"
	RulesetNewResponseRulesActionSetCacheTags         RulesetNewResponseRulesAction = "set_cache_tags"
	RulesetNewResponseRulesActionSetConfig            RulesetNewResponseRulesAction = "set_config"
	RulesetNewResponseRulesActionSkip                 RulesetNewResponseRulesAction = "skip"
)

func (RulesetNewResponseRulesAction) IsKnown 

func (r RulesetNewResponseRulesAction) IsKnown() bool

type RulesetNewResponseRulesRulesetsChallengeRule 

type RulesetNewResponseRulesRulesetsChallengeRule struct {
	// The timestamp of when the rule was last modified.
	LastUpdated time.Time `json:"last_updated" api:"required" format:"date-time"`
	// The version of the rule.
	Version string `json:"version" api:"required"`
	// The unique ID of the rule.
	ID string `json:"id"`
	// The action to perform when the rule matches.
	Action RulesetNewResponseRulesRulesetsChallengeRuleAction `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters interface{} `json:"action_parameters"`
	// The categories of the rule.
	Categories []string `json:"categories"`
	// An informative description of the rule.
	Description string `json:"description"`
	// Whether the rule should be executed.
	Enabled bool `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck RulesetNewResponseRulesRulesetsChallengeRuleExposedCredentialCheck `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression string `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging Logging `json:"logging"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit RulesetNewResponseRulesRulesetsChallengeRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                                           `json:"ref"`
	JSON rulesetNewResponseRulesRulesetsChallengeRuleJSON `json:"-"`
}

func (*RulesetNewResponseRulesRulesetsChallengeRule) UnmarshalJSON 

func (r *RulesetNewResponseRulesRulesetsChallengeRule) UnmarshalJSON(data []byte) (err error)

type RulesetNewResponseRulesRulesetsChallengeRuleAction 

type RulesetNewResponseRulesRulesetsChallengeRuleAction string

The action to perform when the rule matches. 

const (
	RulesetNewResponseRulesRulesetsChallengeRuleActionChallenge RulesetNewResponseRulesRulesetsChallengeRuleAction = "challenge"
)

func (RulesetNewResponseRulesRulesetsChallengeRuleAction) IsKnown 

func (r RulesetNewResponseRulesRulesetsChallengeRuleAction) IsKnown() bool

type RulesetNewResponseRulesRulesetsChallengeRuleExposedCredentialCheck 

type RulesetNewResponseRulesRulesetsChallengeRuleExposedCredentialCheck struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression string `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression string                                                                 `json:"username_expression" api:"required"`
	JSON               rulesetNewResponseRulesRulesetsChallengeRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*RulesetNewResponseRulesRulesetsChallengeRuleExposedCredentialCheck) UnmarshalJSON 

func (r *RulesetNewResponseRulesRulesetsChallengeRuleExposedCredentialCheck) UnmarshalJSON(data []byte) (err error)

type RulesetNewResponseRulesRulesetsChallengeRuleRatelimit 

type RulesetNewResponseRulesRulesetsChallengeRuleRatelimit struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics []string `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period int64 `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression string `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout int64 `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod int64 `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin bool `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod int64 `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName string                                                    `json:"score_response_header_name"`
	JSON                    rulesetNewResponseRulesRulesetsChallengeRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*RulesetNewResponseRulesRulesetsChallengeRuleRatelimit) UnmarshalJSON 

func (r *RulesetNewResponseRulesRulesetsChallengeRuleRatelimit) UnmarshalJSON(data []byte) (err error)

type RulesetNewResponseRulesRulesetsJSChallengeRule 

type RulesetNewResponseRulesRulesetsJSChallengeRule struct {
	// The timestamp of when the rule was last modified.
	LastUpdated time.Time `json:"last_updated" api:"required" format:"date-time"`
	// The version of the rule.
	Version string `json:"version" api:"required"`
	// The unique ID of the rule.
	ID string `json:"id"`
	// The action to perform when the rule matches.
	Action RulesetNewResponseRulesRulesetsJSChallengeRuleAction `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters interface{} `json:"action_parameters"`
	// The categories of the rule.
	Categories []string `json:"categories"`
	// An informative description of the rule.
	Description string `json:"description"`
	// Whether the rule should be executed.
	Enabled bool `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck RulesetNewResponseRulesRulesetsJSChallengeRuleExposedCredentialCheck `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression string `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging Logging `json:"logging"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit RulesetNewResponseRulesRulesetsJSChallengeRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                                             `json:"ref"`
	JSON rulesetNewResponseRulesRulesetsJSChallengeRuleJSON `json:"-"`
}

func (*RulesetNewResponseRulesRulesetsJSChallengeRule) UnmarshalJSON 

func (r *RulesetNewResponseRulesRulesetsJSChallengeRule) UnmarshalJSON(data []byte) (err error)

type RulesetNewResponseRulesRulesetsJSChallengeRuleAction 

type RulesetNewResponseRulesRulesetsJSChallengeRuleAction string

The action to perform when the rule matches. 

const (
	RulesetNewResponseRulesRulesetsJSChallengeRuleActionJSChallenge RulesetNewResponseRulesRulesetsJSChallengeRuleAction = "js_challenge"
)

func (RulesetNewResponseRulesRulesetsJSChallengeRuleAction) IsKnown 

func (r RulesetNewResponseRulesRulesetsJSChallengeRuleAction) IsKnown() bool

type RulesetNewResponseRulesRulesetsJSChallengeRuleExposedCredentialCheck 

type RulesetNewResponseRulesRulesetsJSChallengeRuleExposedCredentialCheck struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression string `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression string                                                                   `json:"username_expression" api:"required"`
	JSON               rulesetNewResponseRulesRulesetsJSChallengeRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*RulesetNewResponseRulesRulesetsJSChallengeRuleExposedCredentialCheck) UnmarshalJSON 

func (r *RulesetNewResponseRulesRulesetsJSChallengeRuleExposedCredentialCheck) UnmarshalJSON(data []byte) (err error)

type RulesetNewResponseRulesRulesetsJSChallengeRuleRatelimit 

type RulesetNewResponseRulesRulesetsJSChallengeRuleRatelimit struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics []string `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period int64 `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression string `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout int64 `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod int64 `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin bool `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod int64 `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName string                                                      `json:"score_response_header_name"`
	JSON                    rulesetNewResponseRulesRulesetsJSChallengeRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*RulesetNewResponseRulesRulesetsJSChallengeRuleRatelimit) UnmarshalJSON 

func (r *RulesetNewResponseRulesRulesetsJSChallengeRuleRatelimit) UnmarshalJSON(data []byte) (err error)

type RulesetNewResponseRulesRulesetsSetCacheControlRule added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRule struct {
	// The timestamp of when the rule was last modified.
	LastUpdated time.Time `json:"last_updated" api:"required" format:"date-time"`
	// The version of the rule.
	Version string `json:"version" api:"required"`
	// The unique ID of the rule.
	ID string `json:"id"`
	// The action to perform when the rule matches.
	Action RulesetNewResponseRulesRulesetsSetCacheControlRuleAction `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParameters `json:"action_parameters"`
	// The categories of the rule.
	Categories []string `json:"categories"`
	// An informative description of the rule.
	Description string `json:"description"`
	// Whether the rule should be executed.
	Enabled bool `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck RulesetNewResponseRulesRulesetsSetCacheControlRuleExposedCredentialCheck `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression string `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging Logging `json:"logging"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit RulesetNewResponseRulesRulesetsSetCacheControlRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                                                 `json:"ref"`
	JSON rulesetNewResponseRulesRulesetsSetCacheControlRuleJSON `json:"-"`
}

func (*RulesetNewResponseRulesRulesetsSetCacheControlRule) UnmarshalJSON added in v6.9.0 

func (r *RulesetNewResponseRulesRulesetsSetCacheControlRule) UnmarshalJSON(data []byte) (err error)

type RulesetNewResponseRulesRulesetsSetCacheControlRuleAction added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleAction string

The action to perform when the rule matches. 

const (
	RulesetNewResponseRulesRulesetsSetCacheControlRuleActionSetCacheControl RulesetNewResponseRulesRulesetsSetCacheControlRuleAction = "set_cache_control"
)

func (RulesetNewResponseRulesRulesetsSetCacheControlRuleAction) IsKnown added in v6.9.0 

func (r RulesetNewResponseRulesRulesetsSetCacheControlRuleAction) IsKnown() bool

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParameters added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParameters struct {
	// A cache-control directive configuration.
	Immutable RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutable `json:"immutable"`
	// A cache-control directive configuration that accepts a duration value in
	// seconds.
	MaxAge RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAge `json:"max-age"`
	// A cache-control directive configuration.
	MustRevalidate RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate `json:"must-revalidate"`
	// A cache-control directive configuration.
	MustUnderstand RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand `json:"must-understand"`
	// A cache-control directive configuration that accepts optional qualifiers (header
	// names).
	NoCache RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCache `json:"no-cache"`
	// A cache-control directive configuration.
	NoStore RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStore `json:"no-store"`
	// A cache-control directive configuration.
	NoTransform RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransform `json:"no-transform"`
	// A cache-control directive configuration that accepts optional qualifiers (header
	// names).
	Private RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivate `json:"private"`
	// A cache-control directive configuration.
	ProxyRevalidate RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate `json:"proxy-revalidate"`
	// A cache-control directive configuration.
	Public RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublic `json:"public"`
	// A cache-control directive configuration that accepts a duration value in
	// seconds.
	SMaxage RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxage `json:"s-maxage"`
	// A cache-control directive configuration that accepts a duration value in
	// seconds.
	StaleIfError RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfError `json:"stale-if-error"`
	// A cache-control directive configuration that accepts a duration value in
	// seconds.
	StaleWhileRevalidate RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate `json:"stale-while-revalidate"`
	JSON                 rulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersJSON                 `json:"-"`
}

The parameters configuring the rule's action.

func (*RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParameters) UnmarshalJSON added in v6.9.0 

func (r *RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParameters) UnmarshalJSON(data []byte) (err error)

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutable added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutable struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                            `json:"cloudflare_only"`
	JSON           rulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration.

func (RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutable) AsUnion added in v6.9.0 

func (r RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutable) AsUnion() RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableUnion

AsUnion returns a RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective, RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective.

func (*RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutable) UnmarshalJSON added in v6.9.0 

func (r *RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutable) UnmarshalJSON(data []byte) (err error)

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperationSet    RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation = "set"
	RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperationRemove RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation = "remove"
)

func (RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation) IsKnown added in v6.9.0 

func (r RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation) IsKnown() bool

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                           `json:"cloudflare_only"`
	JSON           rulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective) UnmarshalJSON added in v6.9.0 

func (r *RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective) UnmarshalJSON(data []byte) (err error)

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperationSet    RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation = "set"
	RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperationRemove RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation = "remove"
)

func (RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation) IsKnown() bool

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                        `json:"cloudflare_only"`
	JSON           rulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveJSON `json:"-"`
}

Set the directive.

func (*RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective) UnmarshalJSON added in v6.9.0 

func (r *RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective) UnmarshalJSON(data []byte) (err error)

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperationSet    RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation = "set"
	RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperationRemove RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation = "remove"
)

func (RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation) IsKnown() bool

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableUnion added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Union satisfied by RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective or RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective.

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAge added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAge struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool `json:"cloudflare_only"`
	// The duration value in seconds for the directive.
	Value int64                                                                        `json:"value"`
	JSON  rulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration that accepts a duration value in seconds.

func (RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAge) AsUnion added in v6.9.0 

func (r RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAge) AsUnion() RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeUnion

AsUnion returns a RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective, RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective.

func (*RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAge) UnmarshalJSON added in v6.9.0 

func (r *RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAge) UnmarshalJSON(data []byte) (err error)

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperationSet    RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation = "set"
	RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperationRemove RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation = "remove"
)

func (RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation) IsKnown added in v6.9.0 

func (r RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation) IsKnown() bool

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                        `json:"cloudflare_only"`
	JSON           rulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective) UnmarshalJSON added in v6.9.0 

func (r *RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective) UnmarshalJSON(data []byte) (err error)

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperationSet    RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation = "set"
	RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperationRemove RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation = "remove"
)

func (RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation) IsKnown() bool

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation `json:"operation" api:"required"`
	// The duration value in seconds for the directive.
	Value int64 `json:"value" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                     `json:"cloudflare_only"`
	JSON           rulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveJSON `json:"-"`
}

Set the directive with a duration value in seconds.

func (*RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective) UnmarshalJSON added in v6.9.0 

func (r *RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective) UnmarshalJSON(data []byte) (err error)

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperationSet    RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation = "set"
	RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperationRemove RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation = "remove"
)

func (RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation) IsKnown() bool

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeUnion added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts a duration value in seconds.

Union satisfied by RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective or RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective.

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                 `json:"cloudflare_only"`
	JSON           rulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration.

func (RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate) AsUnion added in v6.9.0 

func (r RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate) AsUnion() RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateUnion

AsUnion returns a RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective, RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective.

func (*RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate) UnmarshalJSON added in v6.9.0 

func (r *RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate) UnmarshalJSON(data []byte) (err error)

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperationSet    RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation = "set"
	RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperationRemove RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation = "remove"
)

func (RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation) IsKnown added in v6.9.0 

func (r RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation) IsKnown() bool

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                                `json:"cloudflare_only"`
	JSON           rulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective) UnmarshalJSON added in v6.9.0 

func (r *RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective) UnmarshalJSON(data []byte) (err error)

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperationSet    RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation = "set"
	RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperationRemove RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation = "remove"
)

func (RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation) IsKnown() bool

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                             `json:"cloudflare_only"`
	JSON           rulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveJSON `json:"-"`
}

Set the directive.

func (*RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective) UnmarshalJSON added in v6.9.0 

func (r *RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective) UnmarshalJSON(data []byte) (err error)

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperationSet    RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation = "set"
	RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperationRemove RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation = "remove"
)

func (RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation) IsKnown() bool

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateUnion added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Union satisfied by RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective or RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective.

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                 `json:"cloudflare_only"`
	JSON           rulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration.

func (RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand) AsUnion added in v6.9.0 

func (r RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand) AsUnion() RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandUnion

AsUnion returns a RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective, RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective.

func (*RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand) UnmarshalJSON added in v6.9.0 

func (r *RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand) UnmarshalJSON(data []byte) (err error)

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperationSet    RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation = "set"
	RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperationRemove RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation = "remove"
)

func (RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation) IsKnown added in v6.9.0 

func (r RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation) IsKnown() bool

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                                `json:"cloudflare_only"`
	JSON           rulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective) UnmarshalJSON added in v6.9.0 

func (r *RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective) UnmarshalJSON(data []byte) (err error)

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperationSet    RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation = "set"
	RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperationRemove RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation = "remove"
)

func (RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation) IsKnown() bool

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                             `json:"cloudflare_only"`
	JSON           rulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveJSON `json:"-"`
}

Set the directive.

func (*RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective) UnmarshalJSON added in v6.9.0 

func (r *RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective) UnmarshalJSON(data []byte) (err error)

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperationSet    RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation = "set"
	RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperationRemove RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation = "remove"
)

func (RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation) IsKnown() bool

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandUnion added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Union satisfied by RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective or RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective.

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCache added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCache struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool `json:"cloudflare_only"`
	// This field can have the runtime type of [[]string].
	Qualifiers interface{}                                                                   `json:"qualifiers"`
	JSON       rulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration that accepts optional qualifiers (header names).

func (RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCache) AsUnion added in v6.9.0 

func (r RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCache) AsUnion() RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheUnion

AsUnion returns a RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective, RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective.

func (*RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCache) UnmarshalJSON added in v6.9.0 

func (r *RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCache) UnmarshalJSON(data []byte) (err error)

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperationSet    RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation = "set"
	RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperationRemove RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation = "remove"
)

func (RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation) IsKnown added in v6.9.0 

func (r RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation) IsKnown() bool

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                         `json:"cloudflare_only"`
	JSON           rulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective) UnmarshalJSON added in v6.9.0 

func (r *RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective) UnmarshalJSON(data []byte) (err error)

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperationSet    RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation = "set"
	RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperationRemove RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation = "remove"
)

func (RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation) IsKnown() bool

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool `json:"cloudflare_only"`
	// Optional list of header names to qualify the directive (e.g., for "private" or
	// "no-cache" directives).
	Qualifiers []string                                                                                  `json:"qualifiers"`
	JSON       rulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveJSON `json:"-"`
}

Set the directive with optional qualifiers.

func (*RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective) UnmarshalJSON added in v6.9.0 

func (r *RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective) UnmarshalJSON(data []byte) (err error)

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperationSet    RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation = "set"
	RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperationRemove RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation = "remove"
)

func (RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation) IsKnown() bool

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheUnion added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts optional qualifiers (header names).

Union satisfied by RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective or RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective.

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStore added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStore struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                          `json:"cloudflare_only"`
	JSON           rulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration.

func (RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStore) AsUnion added in v6.9.0 

func (r RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStore) AsUnion() RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreUnion

AsUnion returns a RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective, RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective.

func (*RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStore) UnmarshalJSON added in v6.9.0 

func (r *RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStore) UnmarshalJSON(data []byte) (err error)

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperationSet    RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation = "set"
	RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperationRemove RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation = "remove"
)

func (RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation) IsKnown added in v6.9.0 

func (r RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation) IsKnown() bool

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                         `json:"cloudflare_only"`
	JSON           rulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective) UnmarshalJSON added in v6.9.0 

func (r *RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective) UnmarshalJSON(data []byte) (err error)

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperationSet    RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation = "set"
	RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperationRemove RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation = "remove"
)

func (RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation) IsKnown() bool

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                      `json:"cloudflare_only"`
	JSON           rulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveJSON `json:"-"`
}

Set the directive.

func (*RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective) UnmarshalJSON added in v6.9.0 

func (r *RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective) UnmarshalJSON(data []byte) (err error)

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperationSet    RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation = "set"
	RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperationRemove RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation = "remove"
)

func (RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation) IsKnown() bool

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreUnion added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Union satisfied by RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective or RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective.

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransform added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransform struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                              `json:"cloudflare_only"`
	JSON           rulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration.

func (RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransform) AsUnion added in v6.9.0 

func (r RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransform) AsUnion() RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformUnion

AsUnion returns a RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective, RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective.

func (*RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransform) UnmarshalJSON added in v6.9.0 

func (r *RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransform) UnmarshalJSON(data []byte) (err error)

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperationSet    RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation = "set"
	RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperationRemove RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation = "remove"
)

func (RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation) IsKnown added in v6.9.0 

func (r RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation) IsKnown() bool

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                             `json:"cloudflare_only"`
	JSON           rulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective) UnmarshalJSON added in v6.9.0 

func (r *RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective) UnmarshalJSON(data []byte) (err error)

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperationSet    RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation = "set"
	RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperationRemove RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation = "remove"
)

func (RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation) IsKnown() bool

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                          `json:"cloudflare_only"`
	JSON           rulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveJSON `json:"-"`
}

Set the directive.

func (*RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective) UnmarshalJSON added in v6.9.0 

func (r *RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective) UnmarshalJSON(data []byte) (err error)

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperationSet    RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation = "set"
	RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperationRemove RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation = "remove"
)

func (RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation) IsKnown() bool

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformUnion added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Union satisfied by RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective or RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective.

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivate added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivate struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool `json:"cloudflare_only"`
	// This field can have the runtime type of [[]string].
	Qualifiers interface{}                                                                   `json:"qualifiers"`
	JSON       rulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration that accepts optional qualifiers (header names).

func (RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivate) AsUnion added in v6.9.0 

func (r RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivate) AsUnion() RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateUnion

AsUnion returns a RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective, RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective.

func (*RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivate) UnmarshalJSON added in v6.9.0 

func (r *RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivate) UnmarshalJSON(data []byte) (err error)

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperationSet    RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation = "set"
	RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperationRemove RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation = "remove"
)

func (RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation) IsKnown added in v6.9.0 

func (r RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation) IsKnown() bool

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                         `json:"cloudflare_only"`
	JSON           rulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective) UnmarshalJSON added in v6.9.0 

func (r *RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective) UnmarshalJSON(data []byte) (err error)

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperationSet    RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation = "set"
	RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperationRemove RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation = "remove"
)

func (RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation) IsKnown() bool

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool `json:"cloudflare_only"`
	// Optional list of header names to qualify the directive (e.g., for "private" or
	// "no-cache" directives).
	Qualifiers []string                                                                                  `json:"qualifiers"`
	JSON       rulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveJSON `json:"-"`
}

Set the directive with optional qualifiers.

func (*RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective) UnmarshalJSON added in v6.9.0 

func (r *RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective) UnmarshalJSON(data []byte) (err error)

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperationSet    RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation = "set"
	RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperationRemove RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation = "remove"
)

func (RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation) IsKnown() bool

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateUnion added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts optional qualifiers (header names).

Union satisfied by RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective or RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective.

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                  `json:"cloudflare_only"`
	JSON           rulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration.

func (RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate) AsUnion added in v6.9.0 

func (r RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate) AsUnion() RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateUnion

AsUnion returns a RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective, RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective.

func (*RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate) UnmarshalJSON added in v6.9.0 

func (r *RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate) UnmarshalJSON(data []byte) (err error)

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperationSet    RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation = "set"
	RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperationRemove RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation = "remove"
)

func (RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation) IsKnown added in v6.9.0 

func (r RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation) IsKnown() bool

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                                 `json:"cloudflare_only"`
	JSON           rulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective) UnmarshalJSON added in v6.9.0 

func (r *RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective) UnmarshalJSON(data []byte) (err error)

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperationSet    RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation = "set"
	RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperationRemove RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation = "remove"
)

func (RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation) IsKnown() bool

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                              `json:"cloudflare_only"`
	JSON           rulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveJSON `json:"-"`
}

Set the directive.

func (*RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective) UnmarshalJSON added in v6.9.0 

func (r *RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective) UnmarshalJSON(data []byte) (err error)

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperationSet    RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation = "set"
	RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperationRemove RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation = "remove"
)

func (RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation) IsKnown() bool

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateUnion added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Union satisfied by RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective or RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective.

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublic added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublic struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                         `json:"cloudflare_only"`
	JSON           rulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration.

func (RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublic) AsUnion added in v6.9.0 

func (r RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublic) AsUnion() RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicUnion

AsUnion returns a RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective, RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective.

func (*RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublic) UnmarshalJSON added in v6.9.0 

func (r *RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublic) UnmarshalJSON(data []byte) (err error)

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperationSet    RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation = "set"
	RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperationRemove RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation = "remove"
)

func (RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation) IsKnown added in v6.9.0 

func (r RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation) IsKnown() bool

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                        `json:"cloudflare_only"`
	JSON           rulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective) UnmarshalJSON added in v6.9.0 

func (r *RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective) UnmarshalJSON(data []byte) (err error)

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperationSet    RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation = "set"
	RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperationRemove RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation = "remove"
)

func (RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation) IsKnown() bool

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                     `json:"cloudflare_only"`
	JSON           rulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveJSON `json:"-"`
}

Set the directive.

func (*RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective) UnmarshalJSON added in v6.9.0 

func (r *RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective) UnmarshalJSON(data []byte) (err error)

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperationSet    RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation = "set"
	RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperationRemove RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation = "remove"
)

func (RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation) IsKnown() bool

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicUnion added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Union satisfied by RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective or RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective.

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxage added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxage struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool `json:"cloudflare_only"`
	// The duration value in seconds for the directive.
	Value int64                                                                         `json:"value"`
	JSON  rulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration that accepts a duration value in seconds.

func (RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxage) AsUnion added in v6.9.0 

func (r RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxage) AsUnion() RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageUnion

AsUnion returns a RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective, RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective.

func (*RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxage) UnmarshalJSON added in v6.9.0 

func (r *RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxage) UnmarshalJSON(data []byte) (err error)

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperationSet    RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation = "set"
	RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperationRemove RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation = "remove"
)

func (RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation) IsKnown added in v6.9.0 

func (r RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation) IsKnown() bool

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                         `json:"cloudflare_only"`
	JSON           rulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective) UnmarshalJSON added in v6.9.0 

func (r *RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective) UnmarshalJSON(data []byte) (err error)

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperationSet    RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation = "set"
	RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperationRemove RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation = "remove"
)

func (RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation) IsKnown() bool

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation `json:"operation" api:"required"`
	// The duration value in seconds for the directive.
	Value int64 `json:"value" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                      `json:"cloudflare_only"`
	JSON           rulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveJSON `json:"-"`
}

Set the directive with a duration value in seconds.

func (*RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective) UnmarshalJSON added in v6.9.0 

func (r *RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective) UnmarshalJSON(data []byte) (err error)

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperationSet    RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation = "set"
	RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperationRemove RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation = "remove"
)

func (RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation) IsKnown() bool

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageUnion added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts a duration value in seconds.

Union satisfied by RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective or RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective.

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfError added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfError struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool `json:"cloudflare_only"`
	// The duration value in seconds for the directive.
	Value int64                                                                              `json:"value"`
	JSON  rulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration that accepts a duration value in seconds.

func (RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfError) AsUnion added in v6.9.0 

func (r RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfError) AsUnion() RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorUnion

AsUnion returns a RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective, RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective.

func (*RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfError) UnmarshalJSON added in v6.9.0 

func (r *RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfError) UnmarshalJSON(data []byte) (err error)

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperationSet    RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation = "set"
	RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperationRemove RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation = "remove"
)

func (RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation) IsKnown added in v6.9.0 

func (r RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation) IsKnown() bool

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                              `json:"cloudflare_only"`
	JSON           rulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective) UnmarshalJSON added in v6.9.0 

func (r *RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective) UnmarshalJSON(data []byte) (err error)

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperationSet    RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation = "set"
	RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperationRemove RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation = "remove"
)

func (RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation) IsKnown() bool

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation `json:"operation" api:"required"`
	// The duration value in seconds for the directive.
	Value int64 `json:"value" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                           `json:"cloudflare_only"`
	JSON           rulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveJSON `json:"-"`
}

Set the directive with a duration value in seconds.

func (*RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective) UnmarshalJSON added in v6.9.0 

func (r *RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective) UnmarshalJSON(data []byte) (err error)

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperationSet    RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation = "set"
	RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperationRemove RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation = "remove"
)

func (RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation) IsKnown() bool

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorUnion added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts a duration value in seconds.

Union satisfied by RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective or RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective.

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool `json:"cloudflare_only"`
	// The duration value in seconds for the directive.
	Value int64                                                                                      `json:"value"`
	JSON  rulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration that accepts a duration value in seconds.

func (RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate) AsUnion added in v6.9.0 

func (r RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate) AsUnion() RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateUnion

AsUnion returns a RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective, RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective.

func (*RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate) UnmarshalJSON added in v6.9.0 

func (r *RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate) UnmarshalJSON(data []byte) (err error)

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperationSet    RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation = "set"
	RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperationRemove RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation = "remove"
)

func (RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation) IsKnown added in v6.9.0 

func (r RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation) IsKnown() bool

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                                      `json:"cloudflare_only"`
	JSON           rulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective) UnmarshalJSON added in v6.9.0 

func (r *RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective) UnmarshalJSON(data []byte) (err error)

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperationSet    RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation = "set"
	RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperationRemove RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation = "remove"
)

func (RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation) IsKnown() bool

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation `json:"operation" api:"required"`
	// The duration value in seconds for the directive.
	Value int64 `json:"value" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                                   `json:"cloudflare_only"`
	JSON           rulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveJSON `json:"-"`
}

Set the directive with a duration value in seconds.

func (*RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective) UnmarshalJSON added in v6.9.0 

func (r *RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective) UnmarshalJSON(data []byte) (err error)

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperationSet    RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation = "set"
	RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperationRemove RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation = "remove"
)

func (RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation) IsKnown() bool

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateUnion added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts a duration value in seconds.

Union satisfied by RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective or RulesetNewResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective.

type RulesetNewResponseRulesRulesetsSetCacheControlRuleExposedCredentialCheck added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleExposedCredentialCheck struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression string `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression string                                                                       `json:"username_expression" api:"required"`
	JSON               rulesetNewResponseRulesRulesetsSetCacheControlRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*RulesetNewResponseRulesRulesetsSetCacheControlRuleExposedCredentialCheck) UnmarshalJSON added in v6.9.0 

func (r *RulesetNewResponseRulesRulesetsSetCacheControlRuleExposedCredentialCheck) UnmarshalJSON(data []byte) (err error)

type RulesetNewResponseRulesRulesetsSetCacheControlRuleRatelimit added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheControlRuleRatelimit struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics []string `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period int64 `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression string `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout int64 `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod int64 `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin bool `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod int64 `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName string                                                          `json:"score_response_header_name"`
	JSON                    rulesetNewResponseRulesRulesetsSetCacheControlRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*RulesetNewResponseRulesRulesetsSetCacheControlRuleRatelimit) UnmarshalJSON added in v6.9.0 

func (r *RulesetNewResponseRulesRulesetsSetCacheControlRuleRatelimit) UnmarshalJSON(data []byte) (err error)

type RulesetNewResponseRulesRulesetsSetCacheTagsRule added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheTagsRule struct {
	// The timestamp of when the rule was last modified.
	LastUpdated time.Time `json:"last_updated" api:"required" format:"date-time"`
	// The version of the rule.
	Version string `json:"version" api:"required"`
	// The unique ID of the rule.
	ID string `json:"id"`
	// The action to perform when the rule matches.
	Action RulesetNewResponseRulesRulesetsSetCacheTagsRuleAction `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParameters `json:"action_parameters"`
	// The categories of the rule.
	Categories []string `json:"categories"`
	// An informative description of the rule.
	Description string `json:"description"`
	// Whether the rule should be executed.
	Enabled bool `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck RulesetNewResponseRulesRulesetsSetCacheTagsRuleExposedCredentialCheck `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression string `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging Logging `json:"logging"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit RulesetNewResponseRulesRulesetsSetCacheTagsRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                                              `json:"ref"`
	JSON rulesetNewResponseRulesRulesetsSetCacheTagsRuleJSON `json:"-"`
}

func (*RulesetNewResponseRulesRulesetsSetCacheTagsRule) UnmarshalJSON added in v6.9.0 

func (r *RulesetNewResponseRulesRulesetsSetCacheTagsRule) UnmarshalJSON(data []byte) (err error)

type RulesetNewResponseRulesRulesetsSetCacheTagsRuleAction added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheTagsRuleAction string

The action to perform when the rule matches. 

const (
	RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionSetCacheTags RulesetNewResponseRulesRulesetsSetCacheTagsRuleAction = "set_cache_tags"
)

func (RulesetNewResponseRulesRulesetsSetCacheTagsRuleAction) IsKnown added in v6.9.0 

func (r RulesetNewResponseRulesRulesetsSetCacheTagsRuleAction) IsKnown() bool

type RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParameters added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParameters struct {
	// The operation to perform on the cache tags.
	Operation RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation `json:"operation" api:"required"`
	// An expression that evaluates to an array of cache tag values.
	Expression string `json:"expression"`
	// This field can have the runtime type of [[]string].
	Values interface{}                                                         `json:"values"`
	JSON   rulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersJSON `json:"-"`
	// contains filtered or unexported fields
}

The parameters configuring the rule's action.

func (RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParameters) AsUnion added in v6.9.0 

func (r RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParameters) AsUnion() RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersUnion

AsUnion returns a RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues, RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression, RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues, RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression, RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues, RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression.

func (*RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParameters) UnmarshalJSON added in v6.9.0 

func (r *RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParameters) UnmarshalJSON(data []byte) (err error)

type RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression struct {
	// An expression that evaluates to an array of cache tag values.
	Expression string `json:"expression" api:"required"`
	// The operation to perform on the cache tags.
	Operation RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation `json:"operation" api:"required"`
	JSON      rulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionJSON      `json:"-"`
}

Add cache tags using an expression.

func (*RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression) UnmarshalJSON added in v6.9.0 

func (r *RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression) UnmarshalJSON(data []byte) (err error)

type RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation string

The operation to perform on the cache tags. 

const (
	RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationAdd    RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "add"
	RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationRemove RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "remove"
	RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationSet    RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "set"
)

func (RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation) IsKnown added in v6.9.0 

func (r RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation) IsKnown() bool

type RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues struct {
	// The operation to perform on the cache tags.
	Operation RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation `json:"operation" api:"required"`
	// A list of cache tag values.
	Values []string                                                                              `json:"values" api:"required"`
	JSON   rulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesJSON `json:"-"`
}

Add cache tags using a list of values.

func (*RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues) UnmarshalJSON added in v6.9.0 

func (r *RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues) UnmarshalJSON(data []byte) (err error)

type RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation string

The operation to perform on the cache tags. 

const (
	RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationAdd    RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "add"
	RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationRemove RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "remove"
	RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationSet    RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "set"
)

func (RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation) IsKnown added in v6.9.0 

func (r RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation) IsKnown() bool

type RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation string

The operation to perform on the cache tags. 

const (
	RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersOperationAdd    RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation = "add"
	RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersOperationRemove RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation = "remove"
	RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersOperationSet    RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation = "set"
)

func (RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation) IsKnown added in v6.9.0 

func (r RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation) IsKnown() bool

type RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression struct {
	// An expression that evaluates to an array of cache tag values.
	Expression string `json:"expression" api:"required"`
	// The operation to perform on the cache tags.
	Operation RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation `json:"operation" api:"required"`
	JSON      rulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionJSON      `json:"-"`
}

Remove cache tags using an expression.

func (*RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression) UnmarshalJSON added in v6.9.0 

func (r *RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression) UnmarshalJSON(data []byte) (err error)

type RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation string

The operation to perform on the cache tags. 

const (
	RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationAdd    RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "add"
	RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationRemove RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "remove"
	RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationSet    RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "set"
)

func (RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation) IsKnown added in v6.9.0 

func (r RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation) IsKnown() bool

type RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues struct {
	// The operation to perform on the cache tags.
	Operation RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation `json:"operation" api:"required"`
	// A list of cache tag values.
	Values []string                                                                                 `json:"values" api:"required"`
	JSON   rulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesJSON `json:"-"`
}

Remove cache tags using a list of values.

func (*RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues) UnmarshalJSON added in v6.9.0 

func (r *RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues) UnmarshalJSON(data []byte) (err error)

type RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation string

The operation to perform on the cache tags. 

const (
	RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationAdd    RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "add"
	RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationRemove RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "remove"
	RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationSet    RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "set"
)

func (RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation) IsKnown added in v6.9.0 

func (r RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation) IsKnown() bool

type RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression struct {
	// An expression that evaluates to an array of cache tag values.
	Expression string `json:"expression" api:"required"`
	// The operation to perform on the cache tags.
	Operation RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation `json:"operation" api:"required"`
	JSON      rulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionJSON      `json:"-"`
}

Set cache tags using an expression.

func (*RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression) UnmarshalJSON added in v6.9.0 

func (r *RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression) UnmarshalJSON(data []byte) (err error)

type RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation string

The operation to perform on the cache tags. 

const (
	RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationAdd    RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "add"
	RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationRemove RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "remove"
	RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationSet    RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "set"
)

func (RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation) IsKnown added in v6.9.0 

func (r RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation) IsKnown() bool

type RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues struct {
	// The operation to perform on the cache tags.
	Operation RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation `json:"operation" api:"required"`
	// A list of cache tag values.
	Values []string                                                                              `json:"values" api:"required"`
	JSON   rulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesJSON `json:"-"`
}

Set cache tags using a list of values.

func (*RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues) UnmarshalJSON added in v6.9.0 

func (r *RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues) UnmarshalJSON(data []byte) (err error)

type RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation string

The operation to perform on the cache tags. 

const (
	RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationAdd    RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "add"
	RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationRemove RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "remove"
	RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationSet    RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "set"
)

func (RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation) IsKnown added in v6.9.0 

func (r RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation) IsKnown() bool

type RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersUnion added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersUnion interface {
	// contains filtered or unexported methods
}

The parameters configuring the rule's action.

Union satisfied by RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues, RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression, RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues, RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression, RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues or RulesetNewResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression.

type RulesetNewResponseRulesRulesetsSetCacheTagsRuleExposedCredentialCheck added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheTagsRuleExposedCredentialCheck struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression string `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression string                                                                    `json:"username_expression" api:"required"`
	JSON               rulesetNewResponseRulesRulesetsSetCacheTagsRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*RulesetNewResponseRulesRulesetsSetCacheTagsRuleExposedCredentialCheck) UnmarshalJSON added in v6.9.0 

func (r *RulesetNewResponseRulesRulesetsSetCacheTagsRuleExposedCredentialCheck) UnmarshalJSON(data []byte) (err error)

type RulesetNewResponseRulesRulesetsSetCacheTagsRuleRatelimit added in v6.9.0 

type RulesetNewResponseRulesRulesetsSetCacheTagsRuleRatelimit struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics []string `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period int64 `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression string `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout int64 `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod int64 `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin bool `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod int64 `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName string                                                       `json:"score_response_header_name"`
	JSON                    rulesetNewResponseRulesRulesetsSetCacheTagsRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*RulesetNewResponseRulesRulesetsSetCacheTagsRuleRatelimit) UnmarshalJSON added in v6.9.0 

func (r *RulesetNewResponseRulesRulesetsSetCacheTagsRuleRatelimit) UnmarshalJSON(data []byte) (err error)

type RulesetNewResponseRulesUnion 

type RulesetNewResponseRulesUnion interface {
	// contains filtered or unexported methods
}

Union satisfied by BlockRule, RulesetNewResponseRulesRulesetsChallengeRule, CompressResponseRule, DDoSDynamicRule, ExecuteRule, ForceConnectionCloseRule, RulesetNewResponseRulesRulesetsJSChallengeRule, LogRule, LogCustomFieldRule, ManagedChallengeRule, RedirectRule, RewriteRule, RouteRule, ScoreRule, ServeErrorRule, RulesetNewResponseRulesRulesetsSetCacheControlRule, SetCacheSettingsRule, RulesetNewResponseRulesRulesetsSetCacheTagsRule, SetConfigRule or SkipRule.

type RulesetService 

type RulesetService struct {
	Options  []option.RequestOption
	Phases   *PhaseService
	Rules    *RuleService
	Versions *VersionService
}

RulesetService 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 NewRulesetService method instead.

func NewRulesetService 

func NewRulesetService(opts ...option.RequestOption) (r *RulesetService)

NewRulesetService 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 (*RulesetService) Delete 

func (r *RulesetService) Delete(ctx context.Context, rulesetID string, body RulesetDeleteParams, opts ...option.RequestOption) (err error)

Deletes all versions of an existing account or zone ruleset.

func (*RulesetService) Get 

func (r *RulesetService) Get(ctx context.Context, rulesetID string, query RulesetGetParams, opts ...option.RequestOption) (res *RulesetGetResponse, err error)

Fetches the latest version of an account or zone ruleset.

func (*RulesetService) List 

func (r *RulesetService) List(ctx context.Context, params RulesetListParams, opts ...option.RequestOption) (res *pagination.CursorPagination[RulesetListResponse], err error)

Fetches all rulesets.

func (*RulesetService) ListAutoPaging 

func (r *RulesetService) ListAutoPaging(ctx context.Context, params RulesetListParams, opts ...option.RequestOption) *pagination.CursorPaginationAutoPager[RulesetListResponse]

Fetches all rulesets.

func (*RulesetService) New 

func (r *RulesetService) New(ctx context.Context, params RulesetNewParams, opts ...option.RequestOption) (res *RulesetNewResponse, err error)

Creates a ruleset.

func (*RulesetService) Update 

func (r *RulesetService) Update(ctx context.Context, rulesetID string, params RulesetUpdateParams, opts ...option.RequestOption) (res *RulesetUpdateResponse, err error)

Updates an account or zone ruleset, creating a new version.

type RulesetUpdateParams 

type RulesetUpdateParams struct {
	// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
	AccountID param.Field[string] `path:"account_id"`
	// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
	ZoneID param.Field[string] `path:"zone_id"`
	// An informative description of the ruleset.
	Description param.Field[string] `json:"description"`
	// The kind of the ruleset.
	Kind param.Field[Kind] `json:"kind"`
	// The human-readable name of the ruleset.
	Name param.Field[string] `json:"name"`
	// The phase of the ruleset.
	Phase param.Field[Phase] `json:"phase"`
	// The list of rules in the ruleset.
	Rules param.Field[[]RulesetUpdateParamsRuleUnion] `json:"rules"`
}

func (RulesetUpdateParams) MarshalJSON 

func (r RulesetUpdateParams) MarshalJSON() (data []byte, err error)

type RulesetUpdateParamsRule 

type RulesetUpdateParamsRule struct {
	// The unique ID of the rule.
	ID param.Field[string] `json:"id"`
	// The action to perform when the rule matches.
	Action           param.Field[RulesetUpdateParamsRulesAction] `json:"action"`
	ActionParameters param.Field[interface{}]                    `json:"action_parameters"`
	Categories       param.Field[interface{}]                    `json:"categories"`
	// An informative description of the rule.
	Description param.Field[string] `json:"description"`
	// Whether the rule should be executed.
	Enabled                param.Field[bool]        `json:"enabled"`
	ExposedCredentialCheck param.Field[interface{}] `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression param.Field[string] `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging   param.Field[LoggingParam] `json:"logging"`
	Ratelimit param.Field[interface{}]  `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref param.Field[string] `json:"ref"`
}

func (RulesetUpdateParamsRule) MarshalJSON 

func (r RulesetUpdateParamsRule) MarshalJSON() (data []byte, err error)

type RulesetUpdateParamsRuleUnion 

type RulesetUpdateParamsRuleUnion interface {
	// contains filtered or unexported methods
}

Satisfied by rulesets.BlockRuleParam, rulesets.RulesetUpdateParamsRulesRulesetsChallengeRule, rulesets.CompressResponseRuleParam, rulesets.DDoSDynamicRuleParam, rulesets.ExecuteRuleParam, rulesets.ForceConnectionCloseRuleParam, rulesets.RulesetUpdateParamsRulesRulesetsJSChallengeRule, rulesets.LogRuleParam, rulesets.LogCustomFieldRuleParam, rulesets.ManagedChallengeRuleParam, rulesets.RedirectRuleParam, rulesets.RewriteRuleParam, rulesets.RouteRuleParam, rulesets.ScoreRuleParam, rulesets.ServeErrorRuleParam, rulesets.RulesetUpdateParamsRulesRulesetsSetCacheControlRule, rulesets.SetCacheSettingsRuleParam, rulesets.RulesetUpdateParamsRulesRulesetsSetCacheTagsRule, rulesets.SetConfigRuleParam, rulesets.SkipRuleParam, RulesetUpdateParamsRule.

type RulesetUpdateParamsRulesAction 

type RulesetUpdateParamsRulesAction string

The action to perform when the rule matches. 

const (
	RulesetUpdateParamsRulesActionBlock                RulesetUpdateParamsRulesAction = "block"
	RulesetUpdateParamsRulesActionChallenge            RulesetUpdateParamsRulesAction = "challenge"
	RulesetUpdateParamsRulesActionCompressResponse     RulesetUpdateParamsRulesAction = "compress_response"
	RulesetUpdateParamsRulesActionDDoSDynamic          RulesetUpdateParamsRulesAction = "ddos_dynamic"
	RulesetUpdateParamsRulesActionExecute              RulesetUpdateParamsRulesAction = "execute"
	RulesetUpdateParamsRulesActionForceConnectionClose RulesetUpdateParamsRulesAction = "force_connection_close"
	RulesetUpdateParamsRulesActionJSChallenge          RulesetUpdateParamsRulesAction = "js_challenge"
	RulesetUpdateParamsRulesActionLog                  RulesetUpdateParamsRulesAction = "log"
	RulesetUpdateParamsRulesActionLogCustomField       RulesetUpdateParamsRulesAction = "log_custom_field"
	RulesetUpdateParamsRulesActionManagedChallenge     RulesetUpdateParamsRulesAction = "managed_challenge"
	RulesetUpdateParamsRulesActionRedirect             RulesetUpdateParamsRulesAction = "redirect"
	RulesetUpdateParamsRulesActionRewrite              RulesetUpdateParamsRulesAction = "rewrite"
	RulesetUpdateParamsRulesActionRoute                RulesetUpdateParamsRulesAction = "route"
	RulesetUpdateParamsRulesActionScore                RulesetUpdateParamsRulesAction = "score"
	RulesetUpdateParamsRulesActionServeError           RulesetUpdateParamsRulesAction = "serve_error"
	RulesetUpdateParamsRulesActionSetCacheControl      RulesetUpdateParamsRulesAction = "set_cache_control"
	RulesetUpdateParamsRulesActionSetCacheSettings     RulesetUpdateParamsRulesAction = "set_cache_settings"
	RulesetUpdateParamsRulesActionSetCacheTags         RulesetUpdateParamsRulesAction = "set_cache_tags"
	RulesetUpdateParamsRulesActionSetConfig            RulesetUpdateParamsRulesAction = "set_config"
	RulesetUpdateParamsRulesActionSkip                 RulesetUpdateParamsRulesAction = "skip"
)

func (RulesetUpdateParamsRulesAction) IsKnown 

func (r RulesetUpdateParamsRulesAction) IsKnown() bool

type RulesetUpdateParamsRulesRulesetsChallengeRule 

type RulesetUpdateParamsRulesRulesetsChallengeRule struct {
	// The unique ID of the rule.
	ID param.Field[string] `json:"id"`
	// The action to perform when the rule matches.
	Action param.Field[RulesetUpdateParamsRulesRulesetsChallengeRuleAction] `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters param.Field[interface{}] `json:"action_parameters"`
	// An informative description of the rule.
	Description param.Field[string] `json:"description"`
	// Whether the rule should be executed.
	Enabled param.Field[bool] `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck param.Field[RulesetUpdateParamsRulesRulesetsChallengeRuleExposedCredentialCheck] `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression param.Field[string] `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging param.Field[LoggingParam] `json:"logging"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit param.Field[RulesetUpdateParamsRulesRulesetsChallengeRuleRatelimit] `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref param.Field[string] `json:"ref"`
}

func (RulesetUpdateParamsRulesRulesetsChallengeRule) MarshalJSON 

func (r RulesetUpdateParamsRulesRulesetsChallengeRule) MarshalJSON() (data []byte, err error)

type RulesetUpdateParamsRulesRulesetsChallengeRuleAction 

type RulesetUpdateParamsRulesRulesetsChallengeRuleAction string

The action to perform when the rule matches. 

const (
	RulesetUpdateParamsRulesRulesetsChallengeRuleActionChallenge RulesetUpdateParamsRulesRulesetsChallengeRuleAction = "challenge"
)

func (RulesetUpdateParamsRulesRulesetsChallengeRuleAction) IsKnown 

func (r RulesetUpdateParamsRulesRulesetsChallengeRuleAction) IsKnown() bool

type RulesetUpdateParamsRulesRulesetsChallengeRuleExposedCredentialCheck 

type RulesetUpdateParamsRulesRulesetsChallengeRuleExposedCredentialCheck struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression param.Field[string] `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression param.Field[string] `json:"username_expression" api:"required"`
}

Configuration for exposed credential checking.

func (RulesetUpdateParamsRulesRulesetsChallengeRuleExposedCredentialCheck) MarshalJSON 

func (r RulesetUpdateParamsRulesRulesetsChallengeRuleExposedCredentialCheck) MarshalJSON() (data []byte, err error)

type RulesetUpdateParamsRulesRulesetsChallengeRuleRatelimit 

type RulesetUpdateParamsRulesRulesetsChallengeRuleRatelimit struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics param.Field[[]string] `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period param.Field[int64] `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression param.Field[string] `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout param.Field[int64] `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod param.Field[int64] `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin param.Field[bool] `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod param.Field[int64] `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName param.Field[string] `json:"score_response_header_name"`
}

An object configuring the rule's rate limit behavior.

func (RulesetUpdateParamsRulesRulesetsChallengeRuleRatelimit) MarshalJSON 

func (r RulesetUpdateParamsRulesRulesetsChallengeRuleRatelimit) MarshalJSON() (data []byte, err error)

type RulesetUpdateParamsRulesRulesetsJSChallengeRule 

type RulesetUpdateParamsRulesRulesetsJSChallengeRule struct {
	// The unique ID of the rule.
	ID param.Field[string] `json:"id"`
	// The action to perform when the rule matches.
	Action param.Field[RulesetUpdateParamsRulesRulesetsJSChallengeRuleAction] `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters param.Field[interface{}] `json:"action_parameters"`
	// An informative description of the rule.
	Description param.Field[string] `json:"description"`
	// Whether the rule should be executed.
	Enabled param.Field[bool] `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck param.Field[RulesetUpdateParamsRulesRulesetsJSChallengeRuleExposedCredentialCheck] `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression param.Field[string] `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging param.Field[LoggingParam] `json:"logging"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit param.Field[RulesetUpdateParamsRulesRulesetsJSChallengeRuleRatelimit] `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref param.Field[string] `json:"ref"`
}

func (RulesetUpdateParamsRulesRulesetsJSChallengeRule) MarshalJSON 

func (r RulesetUpdateParamsRulesRulesetsJSChallengeRule) MarshalJSON() (data []byte, err error)

type RulesetUpdateParamsRulesRulesetsJSChallengeRuleAction 

type RulesetUpdateParamsRulesRulesetsJSChallengeRuleAction string

The action to perform when the rule matches. 

const (
	RulesetUpdateParamsRulesRulesetsJSChallengeRuleActionJSChallenge RulesetUpdateParamsRulesRulesetsJSChallengeRuleAction = "js_challenge"
)

func (RulesetUpdateParamsRulesRulesetsJSChallengeRuleAction) IsKnown 

func (r RulesetUpdateParamsRulesRulesetsJSChallengeRuleAction) IsKnown() bool

type RulesetUpdateParamsRulesRulesetsJSChallengeRuleExposedCredentialCheck 

type RulesetUpdateParamsRulesRulesetsJSChallengeRuleExposedCredentialCheck struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression param.Field[string] `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression param.Field[string] `json:"username_expression" api:"required"`
}

Configuration for exposed credential checking.

func (RulesetUpdateParamsRulesRulesetsJSChallengeRuleExposedCredentialCheck) MarshalJSON 

func (r RulesetUpdateParamsRulesRulesetsJSChallengeRuleExposedCredentialCheck) MarshalJSON() (data []byte, err error)

type RulesetUpdateParamsRulesRulesetsJSChallengeRuleRatelimit 

type RulesetUpdateParamsRulesRulesetsJSChallengeRuleRatelimit struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics param.Field[[]string] `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period param.Field[int64] `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression param.Field[string] `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout param.Field[int64] `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod param.Field[int64] `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin param.Field[bool] `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod param.Field[int64] `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName param.Field[string] `json:"score_response_header_name"`
}

An object configuring the rule's rate limit behavior.

func (RulesetUpdateParamsRulesRulesetsJSChallengeRuleRatelimit) MarshalJSON 

func (r RulesetUpdateParamsRulesRulesetsJSChallengeRuleRatelimit) MarshalJSON() (data []byte, err error)

type RulesetUpdateParamsRulesRulesetsSetCacheControlRule added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRule struct {
	// The unique ID of the rule.
	ID param.Field[string] `json:"id"`
	// The action to perform when the rule matches.
	Action param.Field[RulesetUpdateParamsRulesRulesetsSetCacheControlRuleAction] `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters param.Field[RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParameters] `json:"action_parameters"`
	// An informative description of the rule.
	Description param.Field[string] `json:"description"`
	// Whether the rule should be executed.
	Enabled param.Field[bool] `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck param.Field[RulesetUpdateParamsRulesRulesetsSetCacheControlRuleExposedCredentialCheck] `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression param.Field[string] `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging param.Field[LoggingParam] `json:"logging"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit param.Field[RulesetUpdateParamsRulesRulesetsSetCacheControlRuleRatelimit] `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref param.Field[string] `json:"ref"`
}

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRule) MarshalJSON added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheControlRule) MarshalJSON() (data []byte, err error)

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleAction added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleAction string

The action to perform when the rule matches. 

const (
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionSetCacheControl RulesetUpdateParamsRulesRulesetsSetCacheControlRuleAction = "set_cache_control"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleAction) IsKnown added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheControlRuleAction) IsKnown() bool

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParameters added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParameters struct {
	// A cache-control directive configuration.
	Immutable param.Field[RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableUnion] `json:"immutable"`
	// A cache-control directive configuration that accepts a duration value in
	// seconds.
	MaxAge param.Field[RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeUnion] `json:"max-age"`
	// A cache-control directive configuration.
	MustRevalidate param.Field[RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateUnion] `json:"must-revalidate"`
	// A cache-control directive configuration.
	MustUnderstand param.Field[RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandUnion] `json:"must-understand"`
	// A cache-control directive configuration that accepts optional qualifiers (header
	// names).
	NoCache param.Field[RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheUnion] `json:"no-cache"`
	// A cache-control directive configuration.
	NoStore param.Field[RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreUnion] `json:"no-store"`
	// A cache-control directive configuration.
	NoTransform param.Field[RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformUnion] `json:"no-transform"`
	// A cache-control directive configuration that accepts optional qualifiers (header
	// names).
	Private param.Field[RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateUnion] `json:"private"`
	// A cache-control directive configuration.
	ProxyRevalidate param.Field[RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateUnion] `json:"proxy-revalidate"`
	// A cache-control directive configuration.
	Public param.Field[RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicUnion] `json:"public"`
	// A cache-control directive configuration that accepts a duration value in
	// seconds.
	SMaxage param.Field[RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageUnion] `json:"s-maxage"`
	// A cache-control directive configuration that accepts a duration value in
	// seconds.
	StaleIfError param.Field[RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorUnion] `json:"stale-if-error"`
	// A cache-control directive configuration that accepts a duration value in
	// seconds.
	StaleWhileRevalidate param.Field[RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateUnion] `json:"stale-while-revalidate"`
}

The parameters configuring the rule's action.

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParameters) MarshalJSON added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParameters) MarshalJSON() (data []byte, err error)

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutable added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutable struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

A cache-control directive configuration.

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutable) MarshalJSON added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutable) MarshalJSON() (data []byte, err error)

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation = "set"
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation = "remove"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation) IsKnown() bool

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Remove the directive.

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective) MarshalJSON added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective) MarshalJSON() (data []byte, err error)

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation = "set"
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation = "remove"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation) IsKnown() bool

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Set the directive.

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective) MarshalJSON added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective) MarshalJSON() (data []byte, err error)

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation = "set"
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation = "remove"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation) IsKnown() bool

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableUnion added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Satisfied by rulesets.RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective, rulesets.RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective, RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutable.

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAge added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAge struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
	// The duration value in seconds for the directive.
	Value param.Field[int64] `json:"value"`
}

A cache-control directive configuration that accepts a duration value in seconds.

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAge) MarshalJSON added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAge) MarshalJSON() (data []byte, err error)

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation = "set"
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation = "remove"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation) IsKnown() bool

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Remove the directive.

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective) MarshalJSON added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective) MarshalJSON() (data []byte, err error)

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation = "set"
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation = "remove"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation) IsKnown() bool

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation] `json:"operation" api:"required"`
	// The duration value in seconds for the directive.
	Value param.Field[int64] `json:"value" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Set the directive with a duration value in seconds.

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective) MarshalJSON added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective) MarshalJSON() (data []byte, err error)

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation = "set"
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation = "remove"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation) IsKnown() bool

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeUnion added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts a duration value in seconds.

Satisfied by rulesets.RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective, rulesets.RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective, RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAge.

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

A cache-control directive configuration.

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate) MarshalJSON added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate) MarshalJSON() (data []byte, err error)

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation = "set"
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation = "remove"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation) IsKnown() bool

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Remove the directive.

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective) MarshalJSON added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective) MarshalJSON() (data []byte, err error)

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation = "set"
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation = "remove"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation) IsKnown() bool

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Set the directive.

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective) MarshalJSON added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective) MarshalJSON() (data []byte, err error)

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation = "set"
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation = "remove"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation) IsKnown() bool

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateUnion added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Satisfied by rulesets.RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective, rulesets.RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective, RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate.

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

A cache-control directive configuration.

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand) MarshalJSON added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand) MarshalJSON() (data []byte, err error)

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation = "set"
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation = "remove"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation) IsKnown() bool

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Remove the directive.

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective) MarshalJSON added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective) MarshalJSON() (data []byte, err error)

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation = "set"
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation = "remove"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation) IsKnown() bool

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Set the directive.

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective) MarshalJSON added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective) MarshalJSON() (data []byte, err error)

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation = "set"
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation = "remove"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation) IsKnown() bool

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandUnion added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Satisfied by rulesets.RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective, rulesets.RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective, RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand.

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCache added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCache struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool]        `json:"cloudflare_only"`
	Qualifiers     param.Field[interface{}] `json:"qualifiers"`
}

A cache-control directive configuration that accepts optional qualifiers (header names).

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCache) MarshalJSON added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCache) MarshalJSON() (data []byte, err error)

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation = "set"
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation = "remove"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation) IsKnown() bool

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Remove the directive.

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective) MarshalJSON added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective) MarshalJSON() (data []byte, err error)

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation = "set"
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation = "remove"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation) IsKnown() bool

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
	// Optional list of header names to qualify the directive (e.g., for "private" or
	// "no-cache" directives).
	Qualifiers param.Field[[]string] `json:"qualifiers"`
}

Set the directive with optional qualifiers.

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective) MarshalJSON added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective) MarshalJSON() (data []byte, err error)

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation = "set"
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation = "remove"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation) IsKnown() bool

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheUnion added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts optional qualifiers (header names).

Satisfied by rulesets.RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective, rulesets.RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective, RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCache.

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStore added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStore struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

A cache-control directive configuration.

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStore) MarshalJSON added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStore) MarshalJSON() (data []byte, err error)

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation = "set"
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation = "remove"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation) IsKnown() bool

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Remove the directive.

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective) MarshalJSON added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective) MarshalJSON() (data []byte, err error)

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation = "set"
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation = "remove"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation) IsKnown() bool

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Set the directive.

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective) MarshalJSON added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective) MarshalJSON() (data []byte, err error)

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation = "set"
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation = "remove"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation) IsKnown() bool

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreUnion added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Satisfied by rulesets.RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective, rulesets.RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective, RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStore.

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransform added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransform struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

A cache-control directive configuration.

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransform) MarshalJSON added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransform) MarshalJSON() (data []byte, err error)

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation = "set"
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation = "remove"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation) IsKnown() bool

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Remove the directive.

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective) MarshalJSON added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective) MarshalJSON() (data []byte, err error)

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation = "set"
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation = "remove"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation) IsKnown() bool

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Set the directive.

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective) MarshalJSON added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective) MarshalJSON() (data []byte, err error)

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation = "set"
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation = "remove"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation) IsKnown() bool

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformUnion added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Satisfied by rulesets.RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective, rulesets.RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective, RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransform.

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivate added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivate struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool]        `json:"cloudflare_only"`
	Qualifiers     param.Field[interface{}] `json:"qualifiers"`
}

A cache-control directive configuration that accepts optional qualifiers (header names).

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivate) MarshalJSON added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivate) MarshalJSON() (data []byte, err error)

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation = "set"
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation = "remove"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation) IsKnown() bool

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Remove the directive.

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective) MarshalJSON added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective) MarshalJSON() (data []byte, err error)

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation = "set"
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation = "remove"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation) IsKnown() bool

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
	// Optional list of header names to qualify the directive (e.g., for "private" or
	// "no-cache" directives).
	Qualifiers param.Field[[]string] `json:"qualifiers"`
}

Set the directive with optional qualifiers.

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective) MarshalJSON added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective) MarshalJSON() (data []byte, err error)

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation = "set"
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation = "remove"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation) IsKnown() bool

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateUnion added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts optional qualifiers (header names).

Satisfied by rulesets.RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective, rulesets.RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective, RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivate.

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

A cache-control directive configuration.

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate) MarshalJSON added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate) MarshalJSON() (data []byte, err error)

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation = "set"
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation = "remove"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation) IsKnown() bool

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Remove the directive.

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective) MarshalJSON added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective) MarshalJSON() (data []byte, err error)

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation = "set"
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation = "remove"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation) IsKnown() bool

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Set the directive.

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective) MarshalJSON added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective) MarshalJSON() (data []byte, err error)

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation = "set"
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation = "remove"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation) IsKnown() bool

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateUnion added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Satisfied by rulesets.RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective, rulesets.RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective, RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate.

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublic added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublic struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

A cache-control directive configuration.

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublic) MarshalJSON added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublic) MarshalJSON() (data []byte, err error)

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicOperation added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicOperation = "set"
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicOperation = "remove"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicOperation) IsKnown() bool

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Remove the directive.

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective) MarshalJSON added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective) MarshalJSON() (data []byte, err error)

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation = "set"
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation = "remove"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation) IsKnown() bool

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Set the directive.

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective) MarshalJSON added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective) MarshalJSON() (data []byte, err error)

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation = "set"
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation = "remove"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation) IsKnown() bool

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicUnion added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Satisfied by rulesets.RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective, rulesets.RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective, RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublic.

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxage added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxage struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
	// The duration value in seconds for the directive.
	Value param.Field[int64] `json:"value"`
}

A cache-control directive configuration that accepts a duration value in seconds.

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxage) MarshalJSON added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxage) MarshalJSON() (data []byte, err error)

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation = "set"
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation = "remove"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation) IsKnown() bool

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Remove the directive.

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective) MarshalJSON added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective) MarshalJSON() (data []byte, err error)

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation = "set"
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation = "remove"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation) IsKnown() bool

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation] `json:"operation" api:"required"`
	// The duration value in seconds for the directive.
	Value param.Field[int64] `json:"value" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Set the directive with a duration value in seconds.

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective) MarshalJSON added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective) MarshalJSON() (data []byte, err error)

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation = "set"
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation = "remove"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation) IsKnown() bool

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageUnion added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts a duration value in seconds.

Satisfied by rulesets.RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective, rulesets.RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective, RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxage.

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfError added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfError struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
	// The duration value in seconds for the directive.
	Value param.Field[int64] `json:"value"`
}

A cache-control directive configuration that accepts a duration value in seconds.

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfError) MarshalJSON added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfError) MarshalJSON() (data []byte, err error)

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation = "set"
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation = "remove"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation) IsKnown() bool

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Remove the directive.

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective) MarshalJSON added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective) MarshalJSON() (data []byte, err error)

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation = "set"
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation = "remove"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation) IsKnown() bool

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation] `json:"operation" api:"required"`
	// The duration value in seconds for the directive.
	Value param.Field[int64] `json:"value" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Set the directive with a duration value in seconds.

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective) MarshalJSON added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective) MarshalJSON() (data []byte, err error)

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation = "set"
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation = "remove"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation) IsKnown() bool

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorUnion added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts a duration value in seconds.

Satisfied by rulesets.RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective, rulesets.RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective, RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfError.

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
	// The duration value in seconds for the directive.
	Value param.Field[int64] `json:"value"`
}

A cache-control directive configuration that accepts a duration value in seconds.

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate) MarshalJSON added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate) MarshalJSON() (data []byte, err error)

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation = "set"
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation = "remove"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation) IsKnown() bool

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation] `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Remove the directive.

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective) MarshalJSON added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective) MarshalJSON() (data []byte, err error)

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation = "set"
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation = "remove"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation) IsKnown() bool

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation param.Field[RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation] `json:"operation" api:"required"`
	// The duration value in seconds for the directive.
	Value param.Field[int64] `json:"value" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly param.Field[bool] `json:"cloudflare_only"`
}

Set the directive with a duration value in seconds.

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective) MarshalJSON added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective) MarshalJSON() (data []byte, err error)

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation = "set"
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation = "remove"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation) IsKnown() bool

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateUnion added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts a duration value in seconds.

Satisfied by rulesets.RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective, rulesets.RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective, RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate.

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleExposedCredentialCheck added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleExposedCredentialCheck struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression param.Field[string] `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression param.Field[string] `json:"username_expression" api:"required"`
}

Configuration for exposed credential checking.

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleExposedCredentialCheck) MarshalJSON added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheControlRuleExposedCredentialCheck) MarshalJSON() (data []byte, err error)

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleRatelimit added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleRatelimit struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics param.Field[[]string] `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period param.Field[int64] `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression param.Field[string] `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout param.Field[int64] `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod param.Field[int64] `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin param.Field[bool] `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod param.Field[int64] `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName param.Field[string] `json:"score_response_header_name"`
}

An object configuring the rule's rate limit behavior.

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleRatelimit) MarshalJSON added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheControlRuleRatelimit) MarshalJSON() (data []byte, err error)

type RulesetUpdateParamsRulesRulesetsSetCacheTagsRule added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheTagsRule struct {
	// The unique ID of the rule.
	ID param.Field[string] `json:"id"`
	// The action to perform when the rule matches.
	Action param.Field[RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleAction] `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters param.Field[RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersUnion] `json:"action_parameters"`
	// An informative description of the rule.
	Description param.Field[string] `json:"description"`
	// Whether the rule should be executed.
	Enabled param.Field[bool] `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck param.Field[RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleExposedCredentialCheck] `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression param.Field[string] `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging param.Field[LoggingParam] `json:"logging"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit param.Field[RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleRatelimit] `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref param.Field[string] `json:"ref"`
}

func (RulesetUpdateParamsRulesRulesetsSetCacheTagsRule) MarshalJSON added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheTagsRule) MarshalJSON() (data []byte, err error)

type RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleAction added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleAction string

The action to perform when the rule matches. 

const (
	RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionSetCacheTags RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleAction = "set_cache_tags"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleAction) IsKnown added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleAction) IsKnown() bool

type RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParameters added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParameters struct {
	// The operation to perform on the cache tags.
	Operation param.Field[RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersOperation] `json:"operation" api:"required"`
	// An expression that evaluates to an array of cache tag values.
	Expression param.Field[string]      `json:"expression"`
	Values     param.Field[interface{}] `json:"values"`
}

The parameters configuring the rule's action.

func (RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParameters) MarshalJSON added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParameters) MarshalJSON() (data []byte, err error)

type RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression struct {
	// An expression that evaluates to an array of cache tag values.
	Expression param.Field[string] `json:"expression" api:"required"`
	// The operation to perform on the cache tags.
	Operation param.Field[RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation] `json:"operation" api:"required"`
}

Add cache tags using an expression.

func (RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression) MarshalJSON added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression) MarshalJSON() (data []byte, err error)

type RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation string

The operation to perform on the cache tags. 

const (
	RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationAdd    RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "add"
	RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "remove"
	RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "set"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation) IsKnown() bool

type RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues struct {
	// The operation to perform on the cache tags.
	Operation param.Field[RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation] `json:"operation" api:"required"`
	// A list of cache tag values.
	Values param.Field[[]string] `json:"values" api:"required"`
}

Add cache tags using a list of values.

func (RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues) MarshalJSON added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues) MarshalJSON() (data []byte, err error)

type RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation string

The operation to perform on the cache tags. 

const (
	RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationAdd    RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "add"
	RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "remove"
	RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "set"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation) IsKnown() bool

type RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersOperation added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersOperation string

The operation to perform on the cache tags. 

const (
	RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersOperationAdd    RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersOperation = "add"
	RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersOperation = "remove"
	RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersOperation = "set"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersOperation) IsKnown() bool

type RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression struct {
	// An expression that evaluates to an array of cache tag values.
	Expression param.Field[string] `json:"expression" api:"required"`
	// The operation to perform on the cache tags.
	Operation param.Field[RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation] `json:"operation" api:"required"`
}

Remove cache tags using an expression.

func (RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression) MarshalJSON added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression) MarshalJSON() (data []byte, err error)

type RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation string

The operation to perform on the cache tags. 

const (
	RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationAdd    RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "add"
	RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "remove"
	RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "set"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation) IsKnown() bool

type RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues struct {
	// The operation to perform on the cache tags.
	Operation param.Field[RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation] `json:"operation" api:"required"`
	// A list of cache tag values.
	Values param.Field[[]string] `json:"values" api:"required"`
}

Remove cache tags using a list of values.

func (RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues) MarshalJSON added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues) MarshalJSON() (data []byte, err error)

type RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation string

The operation to perform on the cache tags. 

const (
	RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationAdd    RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "add"
	RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "remove"
	RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "set"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation) IsKnown() bool

type RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression struct {
	// An expression that evaluates to an array of cache tag values.
	Expression param.Field[string] `json:"expression" api:"required"`
	// The operation to perform on the cache tags.
	Operation param.Field[RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation] `json:"operation" api:"required"`
}

Set cache tags using an expression.

func (RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression) MarshalJSON added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression) MarshalJSON() (data []byte, err error)

type RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation string

The operation to perform on the cache tags. 

const (
	RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationAdd    RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "add"
	RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "remove"
	RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "set"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation) IsKnown() bool

type RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues struct {
	// The operation to perform on the cache tags.
	Operation param.Field[RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation] `json:"operation" api:"required"`
	// A list of cache tag values.
	Values param.Field[[]string] `json:"values" api:"required"`
}

Set cache tags using a list of values.

func (RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues) MarshalJSON added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues) MarshalJSON() (data []byte, err error)

type RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation string

The operation to perform on the cache tags. 

const (
	RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationAdd    RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "add"
	RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "remove"
	RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "set"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation) IsKnown() bool

type RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersUnion added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersUnion interface {
	// contains filtered or unexported methods
}

The parameters configuring the rule's action.

Satisfied by rulesets.RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues, rulesets.RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression, rulesets.RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues, rulesets.RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression, rulesets.RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues, rulesets.RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression, RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParameters.

type RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleExposedCredentialCheck added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleExposedCredentialCheck struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression param.Field[string] `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression param.Field[string] `json:"username_expression" api:"required"`
}

Configuration for exposed credential checking.

func (RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleExposedCredentialCheck) MarshalJSON added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleExposedCredentialCheck) MarshalJSON() (data []byte, err error)

type RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleRatelimit added in v6.9.0 

type RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleRatelimit struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics param.Field[[]string] `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period param.Field[int64] `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression param.Field[string] `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout param.Field[int64] `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod param.Field[int64] `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin param.Field[bool] `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod param.Field[int64] `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName param.Field[string] `json:"score_response_header_name"`
}

An object configuring the rule's rate limit behavior.

func (RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleRatelimit) MarshalJSON added in v6.9.0 

func (r RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleRatelimit) MarshalJSON() (data []byte, err error)

type RulesetUpdateResponse 

type RulesetUpdateResponse struct {
	// The unique ID of the ruleset.
	ID string `json:"id" api:"required"`
	// The kind of the ruleset.
	Kind Kind `json:"kind" api:"required"`
	// The timestamp of when the ruleset was last modified.
	LastUpdated time.Time `json:"last_updated" api:"required" format:"date-time"`
	// The human-readable name of the ruleset.
	Name string `json:"name" api:"required"`
	// The phase of the ruleset.
	Phase Phase `json:"phase" api:"required"`
	// The list of rules in the ruleset.
	Rules []RulesetUpdateResponseRule `json:"rules" api:"required"`
	// The version of the ruleset.
	Version string `json:"version" api:"required"`
	// An informative description of the ruleset.
	Description string                    `json:"description"`
	JSON        rulesetUpdateResponseJSON `json:"-"`
}

A ruleset object.

func (*RulesetUpdateResponse) UnmarshalJSON 

func (r *RulesetUpdateResponse) UnmarshalJSON(data []byte) (err error)

type RulesetUpdateResponseEnvelope 

type RulesetUpdateResponseEnvelope struct {
	// A list of error messages.
	Errors []RulesetUpdateResponseEnvelopeErrors `json:"errors" api:"required"`
	// A list of warning messages.
	Messages []RulesetUpdateResponseEnvelopeMessages `json:"messages" api:"required"`
	// A ruleset object.
	Result RulesetUpdateResponse `json:"result" api:"required"`
	// Whether the API call was successful.
	Success RulesetUpdateResponseEnvelopeSuccess `json:"success" api:"required"`
	JSON    rulesetUpdateResponseEnvelopeJSON    `json:"-"`
}

A response object.

func (*RulesetUpdateResponseEnvelope) UnmarshalJSON 

func (r *RulesetUpdateResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type RulesetUpdateResponseEnvelopeErrors 

type RulesetUpdateResponseEnvelopeErrors struct {
	// A text description of this message.
	Message string `json:"message" api:"required"`
	// A unique code for this message.
	Code int64 `json:"code"`
	// The source of this message.
	Source RulesetUpdateResponseEnvelopeErrorsSource `json:"source"`
	JSON   rulesetUpdateResponseEnvelopeErrorsJSON   `json:"-"`
}

A message.

func (*RulesetUpdateResponseEnvelopeErrors) UnmarshalJSON 

func (r *RulesetUpdateResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type RulesetUpdateResponseEnvelopeErrorsSource 

type RulesetUpdateResponseEnvelopeErrorsSource struct {
	// A JSON pointer to the field that is the source of the message.
	Pointer string                                        `json:"pointer" api:"required"`
	JSON    rulesetUpdateResponseEnvelopeErrorsSourceJSON `json:"-"`
}

The source of this message.

func (*RulesetUpdateResponseEnvelopeErrorsSource) UnmarshalJSON 

func (r *RulesetUpdateResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)

type RulesetUpdateResponseEnvelopeMessages 

type RulesetUpdateResponseEnvelopeMessages struct {
	// A text description of this message.
	Message string `json:"message" api:"required"`
	// A unique code for this message.
	Code int64 `json:"code"`
	// The source of this message.
	Source RulesetUpdateResponseEnvelopeMessagesSource `json:"source"`
	JSON   rulesetUpdateResponseEnvelopeMessagesJSON   `json:"-"`
}

A message.

func (*RulesetUpdateResponseEnvelopeMessages) UnmarshalJSON 

func (r *RulesetUpdateResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type RulesetUpdateResponseEnvelopeMessagesSource 

type RulesetUpdateResponseEnvelopeMessagesSource struct {
	// A JSON pointer to the field that is the source of the message.
	Pointer string                                          `json:"pointer" api:"required"`
	JSON    rulesetUpdateResponseEnvelopeMessagesSourceJSON `json:"-"`
}

The source of this message.

func (*RulesetUpdateResponseEnvelopeMessagesSource) UnmarshalJSON 

func (r *RulesetUpdateResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)

type RulesetUpdateResponseEnvelopeSuccess 

type RulesetUpdateResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	RulesetUpdateResponseEnvelopeSuccessTrue RulesetUpdateResponseEnvelopeSuccess = true
)

func (RulesetUpdateResponseEnvelopeSuccess) IsKnown 

func (r RulesetUpdateResponseEnvelopeSuccess) IsKnown() bool

type RulesetUpdateResponseRule 

type RulesetUpdateResponseRule struct {
	// The timestamp of when the rule was last modified.
	LastUpdated time.Time `json:"last_updated" api:"required" format:"date-time"`
	// The version of the rule.
	Version string `json:"version" api:"required"`
	// The unique ID of the rule.
	ID string `json:"id"`
	// The action to perform when the rule matches.
	Action RulesetUpdateResponseRulesAction `json:"action"`
	// This field can have the runtime type of [BlockRuleActionParameters],
	// [interface{}], [CompressResponseRuleActionParameters],
	// [ExecuteRuleActionParameters], [LogCustomFieldRuleActionParameters],
	// [RedirectRuleActionParameters], [RewriteRuleActionParameters],
	// [RouteRuleActionParameters], [ScoreRuleActionParameters],
	// [ServeErrorRuleActionParameters],
	// [RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParameters],
	// [SetCacheSettingsRuleActionParameters],
	// [RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParameters],
	// [SetConfigRuleActionParameters], [SkipRuleActionParameters].
	ActionParameters interface{} `json:"action_parameters"`
	// This field can have the runtime type of [[]string].
	Categories interface{} `json:"categories"`
	// An informative description of the rule.
	Description string `json:"description"`
	// Whether the rule should be executed.
	Enabled bool `json:"enabled"`
	// This field can have the runtime type of [BlockRuleExposedCredentialCheck],
	// [RulesetUpdateResponseRulesRulesetsChallengeRuleExposedCredentialCheck],
	// [CompressResponseRuleExposedCredentialCheck],
	// [DDoSDynamicRuleExposedCredentialCheck], [ExecuteRuleExposedCredentialCheck],
	// [ForceConnectionCloseRuleExposedCredentialCheck],
	// [RulesetUpdateResponseRulesRulesetsJSChallengeRuleExposedCredentialCheck],
	// [LogRuleExposedCredentialCheck], [LogCustomFieldRuleExposedCredentialCheck],
	// [ManagedChallengeRuleExposedCredentialCheck],
	// [RedirectRuleExposedCredentialCheck], [RewriteRuleExposedCredentialCheck],
	// [RouteRuleExposedCredentialCheck], [ScoreRuleExposedCredentialCheck],
	// [ServeErrorRuleExposedCredentialCheck],
	// [RulesetUpdateResponseRulesRulesetsSetCacheControlRuleExposedCredentialCheck],
	// [SetCacheSettingsRuleExposedCredentialCheck],
	// [RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleExposedCredentialCheck],
	// [SetConfigRuleExposedCredentialCheck], [SkipRuleExposedCredentialCheck].
	ExposedCredentialCheck interface{} `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression string `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging Logging `json:"logging"`
	// This field can have the runtime type of [BlockRuleRatelimit],
	// [RulesetUpdateResponseRulesRulesetsChallengeRuleRatelimit],
	// [CompressResponseRuleRatelimit], [DDoSDynamicRuleRatelimit],
	// [ExecuteRuleRatelimit], [ForceConnectionCloseRuleRatelimit],
	// [RulesetUpdateResponseRulesRulesetsJSChallengeRuleRatelimit],
	// [LogRuleRatelimit], [LogCustomFieldRuleRatelimit],
	// [ManagedChallengeRuleRatelimit], [RedirectRuleRatelimit],
	// [RewriteRuleRatelimit], [RouteRuleRatelimit], [ScoreRuleRatelimit],
	// [ServeErrorRuleRatelimit],
	// [RulesetUpdateResponseRulesRulesetsSetCacheControlRuleRatelimit],
	// [SetCacheSettingsRuleRatelimit],
	// [RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleRatelimit],
	// [SetConfigRuleRatelimit], [SkipRuleRatelimit].
	Ratelimit interface{} `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                        `json:"ref"`
	JSON rulesetUpdateResponseRuleJSON `json:"-"`
	// contains filtered or unexported fields
}

func (RulesetUpdateResponseRule) AsUnion 

func (r RulesetUpdateResponseRule) AsUnion() RulesetUpdateResponseRulesUnion

AsUnion returns a RulesetUpdateResponseRulesUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are BlockRule, RulesetUpdateResponseRulesRulesetsChallengeRule, CompressResponseRule, DDoSDynamicRule, ExecuteRule, ForceConnectionCloseRule, RulesetUpdateResponseRulesRulesetsJSChallengeRule, LogRule, LogCustomFieldRule, ManagedChallengeRule, RedirectRule, RewriteRule, RouteRule, ScoreRule, ServeErrorRule, RulesetUpdateResponseRulesRulesetsSetCacheControlRule, SetCacheSettingsRule, RulesetUpdateResponseRulesRulesetsSetCacheTagsRule, SetConfigRule, SkipRule.

func (*RulesetUpdateResponseRule) UnmarshalJSON 

func (r *RulesetUpdateResponseRule) UnmarshalJSON(data []byte) (err error)

type RulesetUpdateResponseRulesAction 

type RulesetUpdateResponseRulesAction string

The action to perform when the rule matches. 

const (
	RulesetUpdateResponseRulesActionBlock                RulesetUpdateResponseRulesAction = "block"
	RulesetUpdateResponseRulesActionChallenge            RulesetUpdateResponseRulesAction = "challenge"
	RulesetUpdateResponseRulesActionCompressResponse     RulesetUpdateResponseRulesAction = "compress_response"
	RulesetUpdateResponseRulesActionDDoSDynamic          RulesetUpdateResponseRulesAction = "ddos_dynamic"
	RulesetUpdateResponseRulesActionExecute              RulesetUpdateResponseRulesAction = "execute"
	RulesetUpdateResponseRulesActionForceConnectionClose RulesetUpdateResponseRulesAction = "force_connection_close"
	RulesetUpdateResponseRulesActionJSChallenge          RulesetUpdateResponseRulesAction = "js_challenge"
	RulesetUpdateResponseRulesActionLog                  RulesetUpdateResponseRulesAction = "log"
	RulesetUpdateResponseRulesActionLogCustomField       RulesetUpdateResponseRulesAction = "log_custom_field"
	RulesetUpdateResponseRulesActionManagedChallenge     RulesetUpdateResponseRulesAction = "managed_challenge"
	RulesetUpdateResponseRulesActionRedirect             RulesetUpdateResponseRulesAction = "redirect"
	RulesetUpdateResponseRulesActionRewrite              RulesetUpdateResponseRulesAction = "rewrite"
	RulesetUpdateResponseRulesActionRoute                RulesetUpdateResponseRulesAction = "route"
	RulesetUpdateResponseRulesActionScore                RulesetUpdateResponseRulesAction = "score"
	RulesetUpdateResponseRulesActionServeError           RulesetUpdateResponseRulesAction = "serve_error"
	RulesetUpdateResponseRulesActionSetCacheControl      RulesetUpdateResponseRulesAction = "set_cache_control"
	RulesetUpdateResponseRulesActionSetCacheSettings     RulesetUpdateResponseRulesAction = "set_cache_settings"
	RulesetUpdateResponseRulesActionSetCacheTags         RulesetUpdateResponseRulesAction = "set_cache_tags"
	RulesetUpdateResponseRulesActionSetConfig            RulesetUpdateResponseRulesAction = "set_config"
	RulesetUpdateResponseRulesActionSkip                 RulesetUpdateResponseRulesAction = "skip"
)

func (RulesetUpdateResponseRulesAction) IsKnown 

func (r RulesetUpdateResponseRulesAction) IsKnown() bool

type RulesetUpdateResponseRulesRulesetsChallengeRule 

type RulesetUpdateResponseRulesRulesetsChallengeRule struct {
	// The timestamp of when the rule was last modified.
	LastUpdated time.Time `json:"last_updated" api:"required" format:"date-time"`
	// The version of the rule.
	Version string `json:"version" api:"required"`
	// The unique ID of the rule.
	ID string `json:"id"`
	// The action to perform when the rule matches.
	Action RulesetUpdateResponseRulesRulesetsChallengeRuleAction `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters interface{} `json:"action_parameters"`
	// The categories of the rule.
	Categories []string `json:"categories"`
	// An informative description of the rule.
	Description string `json:"description"`
	// Whether the rule should be executed.
	Enabled bool `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck RulesetUpdateResponseRulesRulesetsChallengeRuleExposedCredentialCheck `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression string `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging Logging `json:"logging"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit RulesetUpdateResponseRulesRulesetsChallengeRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                                              `json:"ref"`
	JSON rulesetUpdateResponseRulesRulesetsChallengeRuleJSON `json:"-"`
}

func (*RulesetUpdateResponseRulesRulesetsChallengeRule) UnmarshalJSON 

func (r *RulesetUpdateResponseRulesRulesetsChallengeRule) UnmarshalJSON(data []byte) (err error)

type RulesetUpdateResponseRulesRulesetsChallengeRuleAction 

type RulesetUpdateResponseRulesRulesetsChallengeRuleAction string

The action to perform when the rule matches. 

const (
	RulesetUpdateResponseRulesRulesetsChallengeRuleActionChallenge RulesetUpdateResponseRulesRulesetsChallengeRuleAction = "challenge"
)

func (RulesetUpdateResponseRulesRulesetsChallengeRuleAction) IsKnown 

func (r RulesetUpdateResponseRulesRulesetsChallengeRuleAction) IsKnown() bool

type RulesetUpdateResponseRulesRulesetsChallengeRuleExposedCredentialCheck 

type RulesetUpdateResponseRulesRulesetsChallengeRuleExposedCredentialCheck struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression string `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression string                                                                    `json:"username_expression" api:"required"`
	JSON               rulesetUpdateResponseRulesRulesetsChallengeRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*RulesetUpdateResponseRulesRulesetsChallengeRuleExposedCredentialCheck) UnmarshalJSON 

func (r *RulesetUpdateResponseRulesRulesetsChallengeRuleExposedCredentialCheck) UnmarshalJSON(data []byte) (err error)

type RulesetUpdateResponseRulesRulesetsChallengeRuleRatelimit 

type RulesetUpdateResponseRulesRulesetsChallengeRuleRatelimit struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics []string `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period int64 `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression string `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout int64 `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod int64 `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin bool `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod int64 `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName string                                                       `json:"score_response_header_name"`
	JSON                    rulesetUpdateResponseRulesRulesetsChallengeRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*RulesetUpdateResponseRulesRulesetsChallengeRuleRatelimit) UnmarshalJSON 

func (r *RulesetUpdateResponseRulesRulesetsChallengeRuleRatelimit) UnmarshalJSON(data []byte) (err error)

type RulesetUpdateResponseRulesRulesetsJSChallengeRule 

type RulesetUpdateResponseRulesRulesetsJSChallengeRule struct {
	// The timestamp of when the rule was last modified.
	LastUpdated time.Time `json:"last_updated" api:"required" format:"date-time"`
	// The version of the rule.
	Version string `json:"version" api:"required"`
	// The unique ID of the rule.
	ID string `json:"id"`
	// The action to perform when the rule matches.
	Action RulesetUpdateResponseRulesRulesetsJSChallengeRuleAction `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters interface{} `json:"action_parameters"`
	// The categories of the rule.
	Categories []string `json:"categories"`
	// An informative description of the rule.
	Description string `json:"description"`
	// Whether the rule should be executed.
	Enabled bool `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck RulesetUpdateResponseRulesRulesetsJSChallengeRuleExposedCredentialCheck `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression string `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging Logging `json:"logging"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit RulesetUpdateResponseRulesRulesetsJSChallengeRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                                                `json:"ref"`
	JSON rulesetUpdateResponseRulesRulesetsJSChallengeRuleJSON `json:"-"`
}

func (*RulesetUpdateResponseRulesRulesetsJSChallengeRule) UnmarshalJSON 

func (r *RulesetUpdateResponseRulesRulesetsJSChallengeRule) UnmarshalJSON(data []byte) (err error)

type RulesetUpdateResponseRulesRulesetsJSChallengeRuleAction 

type RulesetUpdateResponseRulesRulesetsJSChallengeRuleAction string

The action to perform when the rule matches. 

const (
	RulesetUpdateResponseRulesRulesetsJSChallengeRuleActionJSChallenge RulesetUpdateResponseRulesRulesetsJSChallengeRuleAction = "js_challenge"
)

func (RulesetUpdateResponseRulesRulesetsJSChallengeRuleAction) IsKnown 

func (r RulesetUpdateResponseRulesRulesetsJSChallengeRuleAction) IsKnown() bool

type RulesetUpdateResponseRulesRulesetsJSChallengeRuleExposedCredentialCheck 

type RulesetUpdateResponseRulesRulesetsJSChallengeRuleExposedCredentialCheck struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression string `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression string                                                                      `json:"username_expression" api:"required"`
	JSON               rulesetUpdateResponseRulesRulesetsJSChallengeRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*RulesetUpdateResponseRulesRulesetsJSChallengeRuleExposedCredentialCheck) UnmarshalJSON 

func (r *RulesetUpdateResponseRulesRulesetsJSChallengeRuleExposedCredentialCheck) UnmarshalJSON(data []byte) (err error)

type RulesetUpdateResponseRulesRulesetsJSChallengeRuleRatelimit 

type RulesetUpdateResponseRulesRulesetsJSChallengeRuleRatelimit struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics []string `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period int64 `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression string `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout int64 `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod int64 `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin bool `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod int64 `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName string                                                         `json:"score_response_header_name"`
	JSON                    rulesetUpdateResponseRulesRulesetsJSChallengeRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*RulesetUpdateResponseRulesRulesetsJSChallengeRuleRatelimit) UnmarshalJSON 

func (r *RulesetUpdateResponseRulesRulesetsJSChallengeRuleRatelimit) UnmarshalJSON(data []byte) (err error)

type RulesetUpdateResponseRulesRulesetsSetCacheControlRule added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRule struct {
	// The timestamp of when the rule was last modified.
	LastUpdated time.Time `json:"last_updated" api:"required" format:"date-time"`
	// The version of the rule.
	Version string `json:"version" api:"required"`
	// The unique ID of the rule.
	ID string `json:"id"`
	// The action to perform when the rule matches.
	Action RulesetUpdateResponseRulesRulesetsSetCacheControlRuleAction `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParameters `json:"action_parameters"`
	// The categories of the rule.
	Categories []string `json:"categories"`
	// An informative description of the rule.
	Description string `json:"description"`
	// Whether the rule should be executed.
	Enabled bool `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck RulesetUpdateResponseRulesRulesetsSetCacheControlRuleExposedCredentialCheck `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression string `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging Logging `json:"logging"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit RulesetUpdateResponseRulesRulesetsSetCacheControlRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                                                    `json:"ref"`
	JSON rulesetUpdateResponseRulesRulesetsSetCacheControlRuleJSON `json:"-"`
}

func (*RulesetUpdateResponseRulesRulesetsSetCacheControlRule) UnmarshalJSON added in v6.9.0 

func (r *RulesetUpdateResponseRulesRulesetsSetCacheControlRule) UnmarshalJSON(data []byte) (err error)

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleAction added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleAction string

The action to perform when the rule matches. 

const (
	RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionSetCacheControl RulesetUpdateResponseRulesRulesetsSetCacheControlRuleAction = "set_cache_control"
)

func (RulesetUpdateResponseRulesRulesetsSetCacheControlRuleAction) IsKnown added in v6.9.0 

func (r RulesetUpdateResponseRulesRulesetsSetCacheControlRuleAction) IsKnown() bool

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParameters added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParameters struct {
	// A cache-control directive configuration.
	Immutable RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutable `json:"immutable"`
	// A cache-control directive configuration that accepts a duration value in
	// seconds.
	MaxAge RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAge `json:"max-age"`
	// A cache-control directive configuration.
	MustRevalidate RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate `json:"must-revalidate"`
	// A cache-control directive configuration.
	MustUnderstand RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand `json:"must-understand"`
	// A cache-control directive configuration that accepts optional qualifiers (header
	// names).
	NoCache RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCache `json:"no-cache"`
	// A cache-control directive configuration.
	NoStore RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStore `json:"no-store"`
	// A cache-control directive configuration.
	NoTransform RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransform `json:"no-transform"`
	// A cache-control directive configuration that accepts optional qualifiers (header
	// names).
	Private RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivate `json:"private"`
	// A cache-control directive configuration.
	ProxyRevalidate RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate `json:"proxy-revalidate"`
	// A cache-control directive configuration.
	Public RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublic `json:"public"`
	// A cache-control directive configuration that accepts a duration value in
	// seconds.
	SMaxage RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxage `json:"s-maxage"`
	// A cache-control directive configuration that accepts a duration value in
	// seconds.
	StaleIfError RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfError `json:"stale-if-error"`
	// A cache-control directive configuration that accepts a duration value in
	// seconds.
	StaleWhileRevalidate RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate `json:"stale-while-revalidate"`
	JSON                 rulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersJSON                 `json:"-"`
}

The parameters configuring the rule's action.

func (*RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParameters) UnmarshalJSON added in v6.9.0 

func (r *RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParameters) UnmarshalJSON(data []byte) (err error)

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutable added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutable struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                               `json:"cloudflare_only"`
	JSON           rulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration.

func (RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutable) AsUnion added in v6.9.0 

func (r RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutable) AsUnion() RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableUnion

AsUnion returns a RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective, RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective.

func (*RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutable) UnmarshalJSON added in v6.9.0 

func (r *RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutable) UnmarshalJSON(data []byte) (err error)

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperationSet    RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation = "set"
	RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperationRemove RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation = "remove"
)

func (RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation) IsKnown() bool

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                              `json:"cloudflare_only"`
	JSON           rulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective) UnmarshalJSON added in v6.9.0 

func (r *RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective) UnmarshalJSON(data []byte) (err error)

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperationSet    RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation = "set"
	RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperationRemove RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation = "remove"
)

func (RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation) IsKnown() bool

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                           `json:"cloudflare_only"`
	JSON           rulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveJSON `json:"-"`
}

Set the directive.

func (*RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective) UnmarshalJSON added in v6.9.0 

func (r *RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective) UnmarshalJSON(data []byte) (err error)

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperationSet    RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation = "set"
	RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperationRemove RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation = "remove"
)

func (RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation) IsKnown() bool

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableUnion added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Union satisfied by RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective or RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective.

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAge added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAge struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool `json:"cloudflare_only"`
	// The duration value in seconds for the directive.
	Value int64                                                                           `json:"value"`
	JSON  rulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration that accepts a duration value in seconds.

func (RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAge) AsUnion added in v6.9.0 

func (r RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAge) AsUnion() RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeUnion

AsUnion returns a RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective, RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective.

func (*RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAge) UnmarshalJSON added in v6.9.0 

func (r *RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAge) UnmarshalJSON(data []byte) (err error)

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperationSet    RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation = "set"
	RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperationRemove RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation = "remove"
)

func (RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation) IsKnown() bool

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                           `json:"cloudflare_only"`
	JSON           rulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective) UnmarshalJSON added in v6.9.0 

func (r *RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective) UnmarshalJSON(data []byte) (err error)

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperationSet    RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation = "set"
	RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperationRemove RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation = "remove"
)

func (RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation) IsKnown() bool

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation `json:"operation" api:"required"`
	// The duration value in seconds for the directive.
	Value int64 `json:"value" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                        `json:"cloudflare_only"`
	JSON           rulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveJSON `json:"-"`
}

Set the directive with a duration value in seconds.

func (*RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective) UnmarshalJSON added in v6.9.0 

func (r *RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective) UnmarshalJSON(data []byte) (err error)

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperationSet    RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation = "set"
	RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperationRemove RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation = "remove"
)

func (RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation) IsKnown() bool

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeUnion added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts a duration value in seconds.

Union satisfied by RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective or RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective.

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                    `json:"cloudflare_only"`
	JSON           rulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration.

func (RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate) AsUnion added in v6.9.0 

func (r RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate) AsUnion() RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateUnion

AsUnion returns a RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective, RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective.

func (*RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate) UnmarshalJSON added in v6.9.0 

func (r *RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate) UnmarshalJSON(data []byte) (err error)

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperationSet    RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation = "set"
	RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperationRemove RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation = "remove"
)

func (RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation) IsKnown() bool

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                                   `json:"cloudflare_only"`
	JSON           rulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective) UnmarshalJSON added in v6.9.0 

func (r *RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective) UnmarshalJSON(data []byte) (err error)

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperationSet    RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation = "set"
	RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperationRemove RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation = "remove"
)

func (RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation) IsKnown() bool

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                                `json:"cloudflare_only"`
	JSON           rulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveJSON `json:"-"`
}

Set the directive.

func (*RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective) UnmarshalJSON added in v6.9.0 

func (r *RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective) UnmarshalJSON(data []byte) (err error)

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperationSet    RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation = "set"
	RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperationRemove RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation = "remove"
)

func (RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation) IsKnown() bool

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateUnion added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Union satisfied by RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective or RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective.

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                    `json:"cloudflare_only"`
	JSON           rulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration.

func (RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand) AsUnion added in v6.9.0 

func (r RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand) AsUnion() RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandUnion

AsUnion returns a RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective, RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective.

func (*RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand) UnmarshalJSON added in v6.9.0 

func (r *RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand) UnmarshalJSON(data []byte) (err error)

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperationSet    RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation = "set"
	RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperationRemove RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation = "remove"
)

func (RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation) IsKnown() bool

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                                   `json:"cloudflare_only"`
	JSON           rulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective) UnmarshalJSON added in v6.9.0 

func (r *RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective) UnmarshalJSON(data []byte) (err error)

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperationSet    RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation = "set"
	RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperationRemove RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation = "remove"
)

func (RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation) IsKnown() bool

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                                `json:"cloudflare_only"`
	JSON           rulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveJSON `json:"-"`
}

Set the directive.

func (*RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective) UnmarshalJSON added in v6.9.0 

func (r *RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective) UnmarshalJSON(data []byte) (err error)

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperationSet    RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation = "set"
	RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperationRemove RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation = "remove"
)

func (RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation) IsKnown() bool

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandUnion added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Union satisfied by RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective or RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective.

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCache added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCache struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool `json:"cloudflare_only"`
	// This field can have the runtime type of [[]string].
	Qualifiers interface{}                                                                      `json:"qualifiers"`
	JSON       rulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration that accepts optional qualifiers (header names).

func (RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCache) AsUnion added in v6.9.0 

func (r RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCache) AsUnion() RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheUnion

AsUnion returns a RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective, RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective.

func (*RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCache) UnmarshalJSON added in v6.9.0 

func (r *RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCache) UnmarshalJSON(data []byte) (err error)

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperationSet    RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation = "set"
	RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperationRemove RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation = "remove"
)

func (RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation) IsKnown() bool

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                            `json:"cloudflare_only"`
	JSON           rulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective) UnmarshalJSON added in v6.9.0 

func (r *RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective) UnmarshalJSON(data []byte) (err error)

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperationSet    RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation = "set"
	RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperationRemove RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation = "remove"
)

func (RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation) IsKnown() bool

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool `json:"cloudflare_only"`
	// Optional list of header names to qualify the directive (e.g., for "private" or
	// "no-cache" directives).
	Qualifiers []string                                                                                     `json:"qualifiers"`
	JSON       rulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveJSON `json:"-"`
}

Set the directive with optional qualifiers.

func (*RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective) UnmarshalJSON added in v6.9.0 

func (r *RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective) UnmarshalJSON(data []byte) (err error)

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperationSet    RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation = "set"
	RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperationRemove RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation = "remove"
)

func (RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation) IsKnown() bool

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheUnion added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts optional qualifiers (header names).

Union satisfied by RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective or RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective.

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStore added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStore struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                             `json:"cloudflare_only"`
	JSON           rulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration.

func (RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStore) AsUnion added in v6.9.0 

func (r RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStore) AsUnion() RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreUnion

AsUnion returns a RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective, RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective.

func (*RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStore) UnmarshalJSON added in v6.9.0 

func (r *RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStore) UnmarshalJSON(data []byte) (err error)

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperationSet    RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation = "set"
	RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperationRemove RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation = "remove"
)

func (RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation) IsKnown() bool

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                            `json:"cloudflare_only"`
	JSON           rulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective) UnmarshalJSON added in v6.9.0 

func (r *RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective) UnmarshalJSON(data []byte) (err error)

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperationSet    RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation = "set"
	RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperationRemove RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation = "remove"
)

func (RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation) IsKnown() bool

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                         `json:"cloudflare_only"`
	JSON           rulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveJSON `json:"-"`
}

Set the directive.

func (*RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective) UnmarshalJSON added in v6.9.0 

func (r *RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective) UnmarshalJSON(data []byte) (err error)

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperationSet    RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation = "set"
	RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperationRemove RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation = "remove"
)

func (RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation) IsKnown() bool

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreUnion added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Union satisfied by RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective or RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective.

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransform added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransform struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                 `json:"cloudflare_only"`
	JSON           rulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration.

func (RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransform) AsUnion added in v6.9.0 

func (r RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransform) AsUnion() RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformUnion

AsUnion returns a RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective, RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective.

func (*RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransform) UnmarshalJSON added in v6.9.0 

func (r *RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransform) UnmarshalJSON(data []byte) (err error)

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperationSet    RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation = "set"
	RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperationRemove RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation = "remove"
)

func (RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation) IsKnown() bool

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                                `json:"cloudflare_only"`
	JSON           rulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective) UnmarshalJSON added in v6.9.0 

func (r *RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective) UnmarshalJSON(data []byte) (err error)

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperationSet    RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation = "set"
	RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperationRemove RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation = "remove"
)

func (RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation) IsKnown() bool

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                             `json:"cloudflare_only"`
	JSON           rulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveJSON `json:"-"`
}

Set the directive.

func (*RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective) UnmarshalJSON added in v6.9.0 

func (r *RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective) UnmarshalJSON(data []byte) (err error)

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperationSet    RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation = "set"
	RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperationRemove RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation = "remove"
)

func (RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation) IsKnown() bool

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformUnion added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Union satisfied by RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective or RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective.

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivate added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivate struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool `json:"cloudflare_only"`
	// This field can have the runtime type of [[]string].
	Qualifiers interface{}                                                                      `json:"qualifiers"`
	JSON       rulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration that accepts optional qualifiers (header names).

func (RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivate) AsUnion added in v6.9.0 

func (r RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivate) AsUnion() RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateUnion

AsUnion returns a RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective, RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective.

func (*RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivate) UnmarshalJSON added in v6.9.0 

func (r *RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivate) UnmarshalJSON(data []byte) (err error)

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperationSet    RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation = "set"
	RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperationRemove RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation = "remove"
)

func (RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation) IsKnown() bool

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                            `json:"cloudflare_only"`
	JSON           rulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective) UnmarshalJSON added in v6.9.0 

func (r *RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective) UnmarshalJSON(data []byte) (err error)

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperationSet    RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation = "set"
	RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperationRemove RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation = "remove"
)

func (RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation) IsKnown() bool

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool `json:"cloudflare_only"`
	// Optional list of header names to qualify the directive (e.g., for "private" or
	// "no-cache" directives).
	Qualifiers []string                                                                                     `json:"qualifiers"`
	JSON       rulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveJSON `json:"-"`
}

Set the directive with optional qualifiers.

func (*RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective) UnmarshalJSON added in v6.9.0 

func (r *RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective) UnmarshalJSON(data []byte) (err error)

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperationSet    RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation = "set"
	RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperationRemove RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation = "remove"
)

func (RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation) IsKnown() bool

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateUnion added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts optional qualifiers (header names).

Union satisfied by RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective or RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective.

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                     `json:"cloudflare_only"`
	JSON           rulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration.

func (RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate) AsUnion added in v6.9.0 

func (r RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate) AsUnion() RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateUnion

AsUnion returns a RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective, RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective.

func (*RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate) UnmarshalJSON added in v6.9.0 

func (r *RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate) UnmarshalJSON(data []byte) (err error)

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperationSet    RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation = "set"
	RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperationRemove RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation = "remove"
)

func (RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation) IsKnown() bool

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                                    `json:"cloudflare_only"`
	JSON           rulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective) UnmarshalJSON added in v6.9.0 

func (r *RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective) UnmarshalJSON(data []byte) (err error)

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperationSet    RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation = "set"
	RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperationRemove RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation = "remove"
)

func (RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation) IsKnown() bool

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                                 `json:"cloudflare_only"`
	JSON           rulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveJSON `json:"-"`
}

Set the directive.

func (*RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective) UnmarshalJSON added in v6.9.0 

func (r *RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective) UnmarshalJSON(data []byte) (err error)

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperationSet    RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation = "set"
	RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperationRemove RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation = "remove"
)

func (RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation) IsKnown() bool

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateUnion added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Union satisfied by RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective or RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective.

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublic added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublic struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                            `json:"cloudflare_only"`
	JSON           rulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration.

func (RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublic) AsUnion added in v6.9.0 

func (r RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublic) AsUnion() RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicUnion

AsUnion returns a RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective, RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective.

func (*RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublic) UnmarshalJSON added in v6.9.0 

func (r *RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublic) UnmarshalJSON(data []byte) (err error)

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperationSet    RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation = "set"
	RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperationRemove RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation = "remove"
)

func (RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation) IsKnown() bool

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                           `json:"cloudflare_only"`
	JSON           rulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective) UnmarshalJSON added in v6.9.0 

func (r *RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective) UnmarshalJSON(data []byte) (err error)

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperationSet    RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation = "set"
	RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperationRemove RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation = "remove"
)

func (RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation) IsKnown() bool

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                        `json:"cloudflare_only"`
	JSON           rulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveJSON `json:"-"`
}

Set the directive.

func (*RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective) UnmarshalJSON added in v6.9.0 

func (r *RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective) UnmarshalJSON(data []byte) (err error)

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperationSet    RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation = "set"
	RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperationRemove RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation = "remove"
)

func (RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation) IsKnown() bool

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicUnion added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Union satisfied by RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective or RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective.

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxage added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxage struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool `json:"cloudflare_only"`
	// The duration value in seconds for the directive.
	Value int64                                                                            `json:"value"`
	JSON  rulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration that accepts a duration value in seconds.

func (RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxage) AsUnion added in v6.9.0 

func (r RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxage) AsUnion() RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageUnion

AsUnion returns a RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective, RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective.

func (*RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxage) UnmarshalJSON added in v6.9.0 

func (r *RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxage) UnmarshalJSON(data []byte) (err error)

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperationSet    RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation = "set"
	RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperationRemove RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation = "remove"
)

func (RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation) IsKnown() bool

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                            `json:"cloudflare_only"`
	JSON           rulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective) UnmarshalJSON added in v6.9.0 

func (r *RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective) UnmarshalJSON(data []byte) (err error)

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperationSet    RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation = "set"
	RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperationRemove RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation = "remove"
)

func (RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation) IsKnown() bool

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation `json:"operation" api:"required"`
	// The duration value in seconds for the directive.
	Value int64 `json:"value" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                         `json:"cloudflare_only"`
	JSON           rulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveJSON `json:"-"`
}

Set the directive with a duration value in seconds.

func (*RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective) UnmarshalJSON added in v6.9.0 

func (r *RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective) UnmarshalJSON(data []byte) (err error)

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperationSet    RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation = "set"
	RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperationRemove RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation = "remove"
)

func (RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation) IsKnown() bool

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageUnion added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts a duration value in seconds.

Union satisfied by RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective or RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective.

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfError added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfError struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool `json:"cloudflare_only"`
	// The duration value in seconds for the directive.
	Value int64                                                                                 `json:"value"`
	JSON  rulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration that accepts a duration value in seconds.

func (RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfError) AsUnion added in v6.9.0 

func (r RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfError) AsUnion() RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorUnion

AsUnion returns a RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective, RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective.

func (*RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfError) UnmarshalJSON added in v6.9.0 

func (r *RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfError) UnmarshalJSON(data []byte) (err error)

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperationSet    RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation = "set"
	RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperationRemove RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation = "remove"
)

func (RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation) IsKnown() bool

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                                 `json:"cloudflare_only"`
	JSON           rulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective) UnmarshalJSON added in v6.9.0 

func (r *RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective) UnmarshalJSON(data []byte) (err error)

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperationSet    RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation = "set"
	RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperationRemove RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation = "remove"
)

func (RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation) IsKnown() bool

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation `json:"operation" api:"required"`
	// The duration value in seconds for the directive.
	Value int64 `json:"value" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                              `json:"cloudflare_only"`
	JSON           rulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveJSON `json:"-"`
}

Set the directive with a duration value in seconds.

func (*RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective) UnmarshalJSON added in v6.9.0 

func (r *RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective) UnmarshalJSON(data []byte) (err error)

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperationSet    RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation = "set"
	RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperationRemove RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation = "remove"
)

func (RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation) IsKnown() bool

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorUnion added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts a duration value in seconds.

Union satisfied by RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective or RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective.

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool `json:"cloudflare_only"`
	// The duration value in seconds for the directive.
	Value int64                                                                                         `json:"value"`
	JSON  rulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration that accepts a duration value in seconds.

func (RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate) AsUnion added in v6.9.0 

func (r RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate) AsUnion() RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateUnion

AsUnion returns a RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective, RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective.

func (*RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate) UnmarshalJSON added in v6.9.0 

func (r *RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate) UnmarshalJSON(data []byte) (err error)

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperationSet    RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation = "set"
	RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperationRemove RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation = "remove"
)

func (RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation) IsKnown() bool

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                                         `json:"cloudflare_only"`
	JSON           rulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective) UnmarshalJSON added in v6.9.0 

func (r *RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective) UnmarshalJSON(data []byte) (err error)

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperationSet    RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation = "set"
	RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperationRemove RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation = "remove"
)

func (RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation) IsKnown() bool

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation `json:"operation" api:"required"`
	// The duration value in seconds for the directive.
	Value int64 `json:"value" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                                      `json:"cloudflare_only"`
	JSON           rulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveJSON `json:"-"`
}

Set the directive with a duration value in seconds.

func (*RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective) UnmarshalJSON added in v6.9.0 

func (r *RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective) UnmarshalJSON(data []byte) (err error)

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperationSet    RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation = "set"
	RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperationRemove RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation = "remove"
)

func (RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation) IsKnown() bool

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateUnion added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts a duration value in seconds.

Union satisfied by RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective or RulesetUpdateResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective.

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleExposedCredentialCheck added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleExposedCredentialCheck struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression string `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression string                                                                          `json:"username_expression" api:"required"`
	JSON               rulesetUpdateResponseRulesRulesetsSetCacheControlRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*RulesetUpdateResponseRulesRulesetsSetCacheControlRuleExposedCredentialCheck) UnmarshalJSON added in v6.9.0 

func (r *RulesetUpdateResponseRulesRulesetsSetCacheControlRuleExposedCredentialCheck) UnmarshalJSON(data []byte) (err error)

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleRatelimit added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheControlRuleRatelimit struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics []string `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period int64 `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression string `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout int64 `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod int64 `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin bool `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod int64 `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName string                                                             `json:"score_response_header_name"`
	JSON                    rulesetUpdateResponseRulesRulesetsSetCacheControlRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*RulesetUpdateResponseRulesRulesetsSetCacheControlRuleRatelimit) UnmarshalJSON added in v6.9.0 

func (r *RulesetUpdateResponseRulesRulesetsSetCacheControlRuleRatelimit) UnmarshalJSON(data []byte) (err error)

type RulesetUpdateResponseRulesRulesetsSetCacheTagsRule added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheTagsRule struct {
	// The timestamp of when the rule was last modified.
	LastUpdated time.Time `json:"last_updated" api:"required" format:"date-time"`
	// The version of the rule.
	Version string `json:"version" api:"required"`
	// The unique ID of the rule.
	ID string `json:"id"`
	// The action to perform when the rule matches.
	Action RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleAction `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParameters `json:"action_parameters"`
	// The categories of the rule.
	Categories []string `json:"categories"`
	// An informative description of the rule.
	Description string `json:"description"`
	// Whether the rule should be executed.
	Enabled bool `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleExposedCredentialCheck `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression string `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging Logging `json:"logging"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                                                 `json:"ref"`
	JSON rulesetUpdateResponseRulesRulesetsSetCacheTagsRuleJSON `json:"-"`
}

func (*RulesetUpdateResponseRulesRulesetsSetCacheTagsRule) UnmarshalJSON added in v6.9.0 

func (r *RulesetUpdateResponseRulesRulesetsSetCacheTagsRule) UnmarshalJSON(data []byte) (err error)

type RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleAction added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleAction string

The action to perform when the rule matches. 

const (
	RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionSetCacheTags RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleAction = "set_cache_tags"
)

func (RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleAction) IsKnown added in v6.9.0 

func (r RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleAction) IsKnown() bool

type RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParameters added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParameters struct {
	// The operation to perform on the cache tags.
	Operation RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation `json:"operation" api:"required"`
	// An expression that evaluates to an array of cache tag values.
	Expression string `json:"expression"`
	// This field can have the runtime type of [[]string].
	Values interface{}                                                            `json:"values"`
	JSON   rulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersJSON `json:"-"`
	// contains filtered or unexported fields
}

The parameters configuring the rule's action.

func (RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParameters) AsUnion added in v6.9.0 

func (r RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParameters) AsUnion() RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersUnion

AsUnion returns a RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues, RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression, RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues, RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression, RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues, RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression.

func (*RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParameters) UnmarshalJSON added in v6.9.0 

func (r *RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParameters) UnmarshalJSON(data []byte) (err error)

type RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression struct {
	// An expression that evaluates to an array of cache tag values.
	Expression string `json:"expression" api:"required"`
	// The operation to perform on the cache tags.
	Operation RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation `json:"operation" api:"required"`
	JSON      rulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionJSON      `json:"-"`
}

Add cache tags using an expression.

func (*RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression) UnmarshalJSON added in v6.9.0 

func (r *RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression) UnmarshalJSON(data []byte) (err error)

type RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation string

The operation to perform on the cache tags. 

const (
	RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationAdd    RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "add"
	RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationRemove RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "remove"
	RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationSet    RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "set"
)

func (RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation) IsKnown() bool

type RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues struct {
	// The operation to perform on the cache tags.
	Operation RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation `json:"operation" api:"required"`
	// A list of cache tag values.
	Values []string                                                                                 `json:"values" api:"required"`
	JSON   rulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesJSON `json:"-"`
}

Add cache tags using a list of values.

func (*RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues) UnmarshalJSON added in v6.9.0 

func (r *RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues) UnmarshalJSON(data []byte) (err error)

type RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation string

The operation to perform on the cache tags. 

const (
	RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationAdd    RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "add"
	RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationRemove RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "remove"
	RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationSet    RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "set"
)

func (RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation) IsKnown() bool

type RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation string

The operation to perform on the cache tags. 

const (
	RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersOperationAdd    RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation = "add"
	RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersOperationRemove RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation = "remove"
	RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersOperationSet    RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation = "set"
)

func (RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation) IsKnown() bool

type RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression struct {
	// An expression that evaluates to an array of cache tag values.
	Expression string `json:"expression" api:"required"`
	// The operation to perform on the cache tags.
	Operation RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation `json:"operation" api:"required"`
	JSON      rulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionJSON      `json:"-"`
}

Remove cache tags using an expression.

func (*RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression) UnmarshalJSON added in v6.9.0 

func (r *RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression) UnmarshalJSON(data []byte) (err error)

type RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation string

The operation to perform on the cache tags. 

const (
	RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationAdd    RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "add"
	RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationRemove RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "remove"
	RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationSet    RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "set"
)

func (RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation) IsKnown() bool

type RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues struct {
	// The operation to perform on the cache tags.
	Operation RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation `json:"operation" api:"required"`
	// A list of cache tag values.
	Values []string                                                                                    `json:"values" api:"required"`
	JSON   rulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesJSON `json:"-"`
}

Remove cache tags using a list of values.

func (*RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues) UnmarshalJSON added in v6.9.0 

func (r *RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues) UnmarshalJSON(data []byte) (err error)

type RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation string

The operation to perform on the cache tags. 

const (
	RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationAdd    RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "add"
	RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationRemove RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "remove"
	RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationSet    RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "set"
)

func (RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation) IsKnown() bool

type RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression struct {
	// An expression that evaluates to an array of cache tag values.
	Expression string `json:"expression" api:"required"`
	// The operation to perform on the cache tags.
	Operation RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation `json:"operation" api:"required"`
	JSON      rulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionJSON      `json:"-"`
}

Set cache tags using an expression.

func (*RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression) UnmarshalJSON added in v6.9.0 

func (r *RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression) UnmarshalJSON(data []byte) (err error)

type RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation string

The operation to perform on the cache tags. 

const (
	RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationAdd    RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "add"
	RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationRemove RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "remove"
	RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationSet    RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "set"
)

func (RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation) IsKnown() bool

type RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues struct {
	// The operation to perform on the cache tags.
	Operation RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation `json:"operation" api:"required"`
	// A list of cache tag values.
	Values []string                                                                                 `json:"values" api:"required"`
	JSON   rulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesJSON `json:"-"`
}

Set cache tags using a list of values.

func (*RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues) UnmarshalJSON added in v6.9.0 

func (r *RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues) UnmarshalJSON(data []byte) (err error)

type RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation string

The operation to perform on the cache tags. 

const (
	RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationAdd    RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "add"
	RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationRemove RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "remove"
	RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationSet    RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "set"
)

func (RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation) IsKnown added in v6.9.0 

func (r RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation) IsKnown() bool

type RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersUnion added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersUnion interface {
	// contains filtered or unexported methods
}

The parameters configuring the rule's action.

Union satisfied by RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues, RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression, RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues, RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression, RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues or RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression.

type RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleExposedCredentialCheck added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleExposedCredentialCheck struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression string `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression string                                                                       `json:"username_expression" api:"required"`
	JSON               rulesetUpdateResponseRulesRulesetsSetCacheTagsRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleExposedCredentialCheck) UnmarshalJSON added in v6.9.0 

func (r *RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleExposedCredentialCheck) UnmarshalJSON(data []byte) (err error)

type RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleRatelimit added in v6.9.0 

type RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleRatelimit struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics []string `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period int64 `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression string `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout int64 `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod int64 `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin bool `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod int64 `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName string                                                          `json:"score_response_header_name"`
	JSON                    rulesetUpdateResponseRulesRulesetsSetCacheTagsRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleRatelimit) UnmarshalJSON added in v6.9.0 

func (r *RulesetUpdateResponseRulesRulesetsSetCacheTagsRuleRatelimit) UnmarshalJSON(data []byte) (err error)

type RulesetUpdateResponseRulesUnion 

type RulesetUpdateResponseRulesUnion interface {
	// contains filtered or unexported methods
}

Union satisfied by BlockRule, RulesetUpdateResponseRulesRulesetsChallengeRule, CompressResponseRule, DDoSDynamicRule, ExecuteRule, ForceConnectionCloseRule, RulesetUpdateResponseRulesRulesetsJSChallengeRule, LogRule, LogCustomFieldRule, ManagedChallengeRule, RedirectRule, RewriteRule, RouteRule, ScoreRule, ServeErrorRule, RulesetUpdateResponseRulesRulesetsSetCacheControlRule, SetCacheSettingsRule, RulesetUpdateResponseRulesRulesetsSetCacheTagsRule, SetConfigRule or SkipRule.

type ScoreRule 

type ScoreRule struct {
	// The timestamp of when the rule was last modified.
	LastUpdated time.Time `json:"last_updated" api:"required" format:"date-time"`
	// The version of the rule.
	Version string `json:"version" api:"required"`
	// The unique ID of the rule.
	ID string `json:"id"`
	// The action to perform when the rule matches.
	Action ScoreRuleAction `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters ScoreRuleActionParameters `json:"action_parameters"`
	// The categories of the rule.
	Categories []string `json:"categories"`
	// An informative description of the rule.
	Description string `json:"description"`
	// Whether the rule should be executed.
	Enabled bool `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck ScoreRuleExposedCredentialCheck `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression string `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging Logging `json:"logging"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit ScoreRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string        `json:"ref"`
	JSON scoreRuleJSON `json:"-"`
}

func (*ScoreRule) UnmarshalJSON 

func (r *ScoreRule) UnmarshalJSON(data []byte) (err error)

type ScoreRuleAction 

type ScoreRuleAction string

The action to perform when the rule matches. 

const (
	ScoreRuleActionScore ScoreRuleAction = "score"
)

func (ScoreRuleAction) IsKnown 

func (r ScoreRuleAction) IsKnown() bool

type ScoreRuleActionParameters 

type ScoreRuleActionParameters struct {
	// A delta to change the score by, which can be either positive or negative.
	Increment int64                         `json:"increment" api:"required"`
	JSON      scoreRuleActionParametersJSON `json:"-"`
}

The parameters configuring the rule's action.

func (*ScoreRuleActionParameters) UnmarshalJSON 

func (r *ScoreRuleActionParameters) UnmarshalJSON(data []byte) (err error)

type ScoreRuleActionParametersParam 

type ScoreRuleActionParametersParam struct {
	// A delta to change the score by, which can be either positive or negative.
	Increment param.Field[int64] `json:"increment" api:"required"`
}

The parameters configuring the rule's action.

func (ScoreRuleActionParametersParam) MarshalJSON 

func (r ScoreRuleActionParametersParam) MarshalJSON() (data []byte, err error)

type ScoreRuleExposedCredentialCheck 

type ScoreRuleExposedCredentialCheck struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression string `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression string                              `json:"username_expression" api:"required"`
	JSON               scoreRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*ScoreRuleExposedCredentialCheck) UnmarshalJSON 

func (r *ScoreRuleExposedCredentialCheck) UnmarshalJSON(data []byte) (err error)

type ScoreRuleExposedCredentialCheckParam 

type ScoreRuleExposedCredentialCheckParam struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression param.Field[string] `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression param.Field[string] `json:"username_expression" api:"required"`
}

Configuration for exposed credential checking.

func (ScoreRuleExposedCredentialCheckParam) MarshalJSON 

func (r ScoreRuleExposedCredentialCheckParam) MarshalJSON() (data []byte, err error)

type ScoreRuleParam 

type ScoreRuleParam struct {
	// The unique ID of the rule.
	ID param.Field[string] `json:"id"`
	// The action to perform when the rule matches.
	Action param.Field[ScoreRuleAction] `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters param.Field[ScoreRuleActionParametersParam] `json:"action_parameters"`
	// An informative description of the rule.
	Description param.Field[string] `json:"description"`
	// Whether the rule should be executed.
	Enabled param.Field[bool] `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck param.Field[ScoreRuleExposedCredentialCheckParam] `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression param.Field[string] `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging param.Field[LoggingParam] `json:"logging"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit param.Field[ScoreRuleRatelimitParam] `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref param.Field[string] `json:"ref"`
}

func (ScoreRuleParam) MarshalJSON 

func (r ScoreRuleParam) MarshalJSON() (data []byte, err error)

type ScoreRuleRatelimit 

type ScoreRuleRatelimit struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics []string `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period int64 `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression string `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout int64 `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod int64 `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin bool `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod int64 `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName string                 `json:"score_response_header_name"`
	JSON                    scoreRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*ScoreRuleRatelimit) UnmarshalJSON 

func (r *ScoreRuleRatelimit) UnmarshalJSON(data []byte) (err error)

type ScoreRuleRatelimitParam 

type ScoreRuleRatelimitParam struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics param.Field[[]string] `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period param.Field[int64] `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression param.Field[string] `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout param.Field[int64] `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod param.Field[int64] `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin param.Field[bool] `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod param.Field[int64] `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName param.Field[string] `json:"score_response_header_name"`
}

An object configuring the rule's rate limit behavior.

func (ScoreRuleRatelimitParam) MarshalJSON 

func (r ScoreRuleRatelimitParam) MarshalJSON() (data []byte, err error)

type ServeErrorRule 

type ServeErrorRule struct {
	// The timestamp of when the rule was last modified.
	LastUpdated time.Time `json:"last_updated" api:"required" format:"date-time"`
	// The version of the rule.
	Version string `json:"version" api:"required"`
	// The unique ID of the rule.
	ID string `json:"id"`
	// The action to perform when the rule matches.
	Action ServeErrorRuleAction `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters ServeErrorRuleActionParameters `json:"action_parameters"`
	// The categories of the rule.
	Categories []string `json:"categories"`
	// An informative description of the rule.
	Description string `json:"description"`
	// Whether the rule should be executed.
	Enabled bool `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck ServeErrorRuleExposedCredentialCheck `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression string `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging Logging `json:"logging"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit ServeErrorRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string             `json:"ref"`
	JSON serveErrorRuleJSON `json:"-"`
}

func (*ServeErrorRule) UnmarshalJSON 

func (r *ServeErrorRule) UnmarshalJSON(data []byte) (err error)

type ServeErrorRuleAction 

type ServeErrorRuleAction string

The action to perform when the rule matches. 

const (
	ServeErrorRuleActionServeError ServeErrorRuleAction = "serve_error"
)

func (ServeErrorRuleAction) IsKnown 

func (r ServeErrorRuleAction) IsKnown() bool

type ServeErrorRuleActionParameters 

type ServeErrorRuleActionParameters struct {
	// The name of a custom asset to serve as the error response.
	AssetName string `json:"asset_name"`
	// The response content.
	Content string `json:"content"`
	// The content type header to set with the error response.
	ContentType ServeErrorRuleActionParametersContentType `json:"content_type"`
	// The status code to use for the error.
	StatusCode int64                              `json:"status_code"`
	JSON       serveErrorRuleActionParametersJSON `json:"-"`
	// contains filtered or unexported fields
}

The parameters configuring the rule's action.

func (ServeErrorRuleActionParameters) AsUnion 

func (r ServeErrorRuleActionParameters) AsUnion() ServeErrorRuleActionParametersUnion

AsUnion returns a ServeErrorRuleActionParametersUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are ServeErrorRuleActionParametersActionParametersContent, ServeErrorRuleActionParametersActionParametersAsset.

func (*ServeErrorRuleActionParameters) UnmarshalJSON 

func (r *ServeErrorRuleActionParameters) UnmarshalJSON(data []byte) (err error)

type ServeErrorRuleActionParametersActionParametersAsset 

type ServeErrorRuleActionParametersActionParametersAsset struct {
	// The name of a custom asset to serve as the error response.
	AssetName string `json:"asset_name" api:"required"`
	// The content type header to set with the error response.
	ContentType ServeErrorRuleActionParametersActionParametersAssetContentType `json:"content_type"`
	// The status code to use for the error.
	StatusCode int64                                                   `json:"status_code"`
	JSON       serveErrorRuleActionParametersActionParametersAssetJSON `json:"-"`
}

func (*ServeErrorRuleActionParametersActionParametersAsset) UnmarshalJSON 

func (r *ServeErrorRuleActionParametersActionParametersAsset) UnmarshalJSON(data []byte) (err error)

type ServeErrorRuleActionParametersActionParametersAssetContentType 

type ServeErrorRuleActionParametersActionParametersAssetContentType string

The content type header to set with the error response. 

const (
	ServeErrorRuleActionParametersActionParametersAssetContentTypeApplicationJson ServeErrorRuleActionParametersActionParametersAssetContentType = "application/json"
	ServeErrorRuleActionParametersActionParametersAssetContentTypeTextHTML        ServeErrorRuleActionParametersActionParametersAssetContentType = "text/html"
	ServeErrorRuleActionParametersActionParametersAssetContentTypeTextPlain       ServeErrorRuleActionParametersActionParametersAssetContentType = "text/plain"
	ServeErrorRuleActionParametersActionParametersAssetContentTypeTextXml         ServeErrorRuleActionParametersActionParametersAssetContentType = "text/xml"
)

func (ServeErrorRuleActionParametersActionParametersAssetContentType) IsKnown 

func (r ServeErrorRuleActionParametersActionParametersAssetContentType) IsKnown() bool

type ServeErrorRuleActionParametersActionParametersAssetParam 

type ServeErrorRuleActionParametersActionParametersAssetParam struct {
	// The name of a custom asset to serve as the error response.
	AssetName param.Field[string] `json:"asset_name" api:"required"`
	// The content type header to set with the error response.
	ContentType param.Field[ServeErrorRuleActionParametersActionParametersAssetContentType] `json:"content_type"`
	// The status code to use for the error.
	StatusCode param.Field[int64] `json:"status_code"`
}

func (ServeErrorRuleActionParametersActionParametersAssetParam) MarshalJSON 

func (r ServeErrorRuleActionParametersActionParametersAssetParam) MarshalJSON() (data []byte, err error)

type ServeErrorRuleActionParametersActionParametersContent 

type ServeErrorRuleActionParametersActionParametersContent struct {
	// The response content.
	Content string `json:"content" api:"required"`
	// The content type header to set with the error response.
	ContentType ServeErrorRuleActionParametersActionParametersContentContentType `json:"content_type"`
	// The status code to use for the error.
	StatusCode int64                                                     `json:"status_code"`
	JSON       serveErrorRuleActionParametersActionParametersContentJSON `json:"-"`
}

func (*ServeErrorRuleActionParametersActionParametersContent) UnmarshalJSON 

func (r *ServeErrorRuleActionParametersActionParametersContent) UnmarshalJSON(data []byte) (err error)

type ServeErrorRuleActionParametersActionParametersContentContentType 

type ServeErrorRuleActionParametersActionParametersContentContentType string

The content type header to set with the error response. 

const (
	ServeErrorRuleActionParametersActionParametersContentContentTypeApplicationJson ServeErrorRuleActionParametersActionParametersContentContentType = "application/json"
	ServeErrorRuleActionParametersActionParametersContentContentTypeTextHTML        ServeErrorRuleActionParametersActionParametersContentContentType = "text/html"
	ServeErrorRuleActionParametersActionParametersContentContentTypeTextPlain       ServeErrorRuleActionParametersActionParametersContentContentType = "text/plain"
	ServeErrorRuleActionParametersActionParametersContentContentTypeTextXml         ServeErrorRuleActionParametersActionParametersContentContentType = "text/xml"
)

func (ServeErrorRuleActionParametersActionParametersContentContentType) IsKnown 

func (r ServeErrorRuleActionParametersActionParametersContentContentType) IsKnown() bool

type ServeErrorRuleActionParametersActionParametersContentParam 

type ServeErrorRuleActionParametersActionParametersContentParam struct {
	// The response content.
	Content param.Field[string] `json:"content" api:"required"`
	// The content type header to set with the error response.
	ContentType param.Field[ServeErrorRuleActionParametersActionParametersContentContentType] `json:"content_type"`
	// The status code to use for the error.
	StatusCode param.Field[int64] `json:"status_code"`
}

func (ServeErrorRuleActionParametersActionParametersContentParam) MarshalJSON 

func (r ServeErrorRuleActionParametersActionParametersContentParam) MarshalJSON() (data []byte, err error)

type ServeErrorRuleActionParametersContentType 

type ServeErrorRuleActionParametersContentType string

The content type header to set with the error response. 

const (
	ServeErrorRuleActionParametersContentTypeApplicationJson ServeErrorRuleActionParametersContentType = "application/json"
	ServeErrorRuleActionParametersContentTypeTextHTML        ServeErrorRuleActionParametersContentType = "text/html"
	ServeErrorRuleActionParametersContentTypeTextPlain       ServeErrorRuleActionParametersContentType = "text/plain"
	ServeErrorRuleActionParametersContentTypeTextXml         ServeErrorRuleActionParametersContentType = "text/xml"
)

func (ServeErrorRuleActionParametersContentType) IsKnown 

func (r ServeErrorRuleActionParametersContentType) IsKnown() bool

type ServeErrorRuleActionParametersParam 

type ServeErrorRuleActionParametersParam struct {
	// The name of a custom asset to serve as the error response.
	AssetName param.Field[string] `json:"asset_name"`
	// The response content.
	Content param.Field[string] `json:"content"`
	// The content type header to set with the error response.
	ContentType param.Field[ServeErrorRuleActionParametersContentType] `json:"content_type"`
	// The status code to use for the error.
	StatusCode param.Field[int64] `json:"status_code"`
}

The parameters configuring the rule's action.

func (ServeErrorRuleActionParametersParam) MarshalJSON 

func (r ServeErrorRuleActionParametersParam) MarshalJSON() (data []byte, err error)

type ServeErrorRuleActionParametersUnion 

type ServeErrorRuleActionParametersUnion interface {
	// contains filtered or unexported methods
}

The parameters configuring the rule's action.

Union satisfied by ServeErrorRuleActionParametersActionParametersContent or ServeErrorRuleActionParametersActionParametersAsset.

type ServeErrorRuleActionParametersUnionParam 

type ServeErrorRuleActionParametersUnionParam interface {
	// contains filtered or unexported methods
}

The parameters configuring the rule's action.

Satisfied by rulesets.ServeErrorRuleActionParametersActionParametersContentParam, rulesets.ServeErrorRuleActionParametersActionParametersAssetParam, ServeErrorRuleActionParametersParam.

type ServeErrorRuleExposedCredentialCheck 

type ServeErrorRuleExposedCredentialCheck struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression string `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression string                                   `json:"username_expression" api:"required"`
	JSON               serveErrorRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*ServeErrorRuleExposedCredentialCheck) UnmarshalJSON 

func (r *ServeErrorRuleExposedCredentialCheck) UnmarshalJSON(data []byte) (err error)

type ServeErrorRuleExposedCredentialCheckParam 

type ServeErrorRuleExposedCredentialCheckParam struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression param.Field[string] `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression param.Field[string] `json:"username_expression" api:"required"`
}

Configuration for exposed credential checking.

func (ServeErrorRuleExposedCredentialCheckParam) MarshalJSON 

func (r ServeErrorRuleExposedCredentialCheckParam) MarshalJSON() (data []byte, err error)

type ServeErrorRuleParam 

type ServeErrorRuleParam struct {
	// The unique ID of the rule.
	ID param.Field[string] `json:"id"`
	// The action to perform when the rule matches.
	Action param.Field[ServeErrorRuleAction] `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters param.Field[ServeErrorRuleActionParametersUnionParam] `json:"action_parameters"`
	// An informative description of the rule.
	Description param.Field[string] `json:"description"`
	// Whether the rule should be executed.
	Enabled param.Field[bool] `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck param.Field[ServeErrorRuleExposedCredentialCheckParam] `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression param.Field[string] `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging param.Field[LoggingParam] `json:"logging"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit param.Field[ServeErrorRuleRatelimitParam] `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref param.Field[string] `json:"ref"`
}

func (ServeErrorRuleParam) MarshalJSON 

func (r ServeErrorRuleParam) MarshalJSON() (data []byte, err error)

type ServeErrorRuleRatelimit 

type ServeErrorRuleRatelimit struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics []string `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period int64 `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression string `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout int64 `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod int64 `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin bool `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod int64 `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName string                      `json:"score_response_header_name"`
	JSON                    serveErrorRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*ServeErrorRuleRatelimit) UnmarshalJSON 

func (r *ServeErrorRuleRatelimit) UnmarshalJSON(data []byte) (err error)

type ServeErrorRuleRatelimitParam 

type ServeErrorRuleRatelimitParam struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics param.Field[[]string] `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period param.Field[int64] `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression param.Field[string] `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout param.Field[int64] `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod param.Field[int64] `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin param.Field[bool] `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod param.Field[int64] `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName param.Field[string] `json:"score_response_header_name"`
}

An object configuring the rule's rate limit behavior.

func (ServeErrorRuleRatelimitParam) MarshalJSON 

func (r ServeErrorRuleRatelimitParam) MarshalJSON() (data []byte, err error)

type SetCacheSettingsRule 

type SetCacheSettingsRule struct {
	// The timestamp of when the rule was last modified.
	LastUpdated time.Time `json:"last_updated" api:"required" format:"date-time"`
	// The version of the rule.
	Version string `json:"version" api:"required"`
	// The unique ID of the rule.
	ID string `json:"id"`
	// The action to perform when the rule matches.
	Action SetCacheSettingsRuleAction `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters SetCacheSettingsRuleActionParameters `json:"action_parameters"`
	// The categories of the rule.
	Categories []string `json:"categories"`
	// An informative description of the rule.
	Description string `json:"description"`
	// Whether the rule should be executed.
	Enabled bool `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck SetCacheSettingsRuleExposedCredentialCheck `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression string `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging Logging `json:"logging"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit SetCacheSettingsRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                   `json:"ref"`
	JSON setCacheSettingsRuleJSON `json:"-"`
}

func (*SetCacheSettingsRule) UnmarshalJSON 

func (r *SetCacheSettingsRule) UnmarshalJSON(data []byte) (err error)

type SetCacheSettingsRuleAction 

type SetCacheSettingsRuleAction string

The action to perform when the rule matches. 

const (
	SetCacheSettingsRuleActionSetCacheSettings SetCacheSettingsRuleAction = "set_cache_settings"
)

func (SetCacheSettingsRuleAction) IsKnown 

func (r SetCacheSettingsRuleAction) IsKnown() bool

type SetCacheSettingsRuleActionParameters 

type SetCacheSettingsRuleActionParameters struct {
	// A list of additional ports that caching should be enabled on.
	AdditionalCacheablePorts []int64 `json:"additional_cacheable_ports"`
	// How long client browsers should cache the response. Cloudflare cache purge will
	// not purge content cached on client browsers, so high browser TTLs may lead to
	// stale content.
	BrowserTTL SetCacheSettingsRuleActionParametersBrowserTTL `json:"browser_ttl"`
	// Whether the request's response from the origin is eligible for caching. Caching
	// itself will still depend on the cache control header and your other caching
	// configurations.
	Cache bool `json:"cache"`
	// Which components of the request are included in or excluded from the cache key
	// Cloudflare uses to store the response in cache.
	CacheKey SetCacheSettingsRuleActionParametersCacheKey `json:"cache_key"`
	// Settings to determine whether the request's response from origin is eligible for
	// Cache Reserve (requires a Cache Reserve add-on plan).
	CacheReserve SetCacheSettingsRuleActionParametersCacheReserve `json:"cache_reserve"`
	// How long the Cloudflare edge network should cache the response.
	EdgeTTL SetCacheSettingsRuleActionParametersEdgeTTL `json:"edge_ttl"`
	// Whether Cloudflare will aim to strictly adhere to RFC 7234.
	OriginCacheControl bool `json:"origin_cache_control"`
	// Whether to generate Cloudflare error pages for issues from the origin server.
	OriginErrorPagePassthru bool `json:"origin_error_page_passthru"`
	// A timeout value between two successive read operations to use for your origin
	// server. Historically, the timeout value between two read options from Cloudflare
	// to an origin server is 100 seconds. If you are attempting to reduce HTTP 524
	// errors because of timeouts from an origin server, try increasing this timeout
	// value.
	ReadTimeout int64 `json:"read_timeout"`
	// Whether Cloudflare should respect strong ETag (entity tag) headers. If false,
	// Cloudflare converts strong ETag headers to weak ETag headers.
	RespectStrongEtags bool `json:"respect_strong_etags"`
	// When to serve stale content from cache.
	ServeStale SetCacheSettingsRuleActionParametersServeStale `json:"serve_stale"`
	// Configuration for shared dictionary compression. When set, Cloudflare injects
	// Use-As-Dictionary headers on matching cacheable responses.
	SharedDictionary SetCacheSettingsRuleActionParametersSharedDictionary `json:"shared_dictionary"`
	// Whether to strip ETag headers from the origin response before caching.
	StripEtags bool `json:"strip_etags"`
	// Whether to strip Last-Modified headers from the origin response before caching.
	StripLastModified bool `json:"strip_last_modified"`
	// Whether to strip Set-Cookie headers from the origin response before caching.
	StripSetCookie bool                                     `json:"strip_set_cookie"`
	JSON           setCacheSettingsRuleActionParametersJSON `json:"-"`
}

The parameters configuring the rule's action.

func (*SetCacheSettingsRuleActionParameters) UnmarshalJSON 

func (r *SetCacheSettingsRuleActionParameters) UnmarshalJSON(data []byte) (err error)

type SetCacheSettingsRuleActionParametersBrowserTTL 

type SetCacheSettingsRuleActionParametersBrowserTTL struct {
	// The browser TTL mode.
	Mode SetCacheSettingsRuleActionParametersBrowserTTLMode `json:"mode" api:"required"`
	// The browser TTL (in seconds) if you choose the "override_origin" mode.
	Default int64                                              `json:"default"`
	JSON    setCacheSettingsRuleActionParametersBrowserTTLJSON `json:"-"`
}

How long client browsers should cache the response. Cloudflare cache purge will not purge content cached on client browsers, so high browser TTLs may lead to stale content.

func (*SetCacheSettingsRuleActionParametersBrowserTTL) UnmarshalJSON 

func (r *SetCacheSettingsRuleActionParametersBrowserTTL) UnmarshalJSON(data []byte) (err error)

type SetCacheSettingsRuleActionParametersBrowserTTLMode 

type SetCacheSettingsRuleActionParametersBrowserTTLMode string

The browser TTL mode. 

const (
	SetCacheSettingsRuleActionParametersBrowserTTLModeRespectOrigin   SetCacheSettingsRuleActionParametersBrowserTTLMode = "respect_origin"
	SetCacheSettingsRuleActionParametersBrowserTTLModeBypassByDefault SetCacheSettingsRuleActionParametersBrowserTTLMode = "bypass_by_default"
	SetCacheSettingsRuleActionParametersBrowserTTLModeOverrideOrigin  SetCacheSettingsRuleActionParametersBrowserTTLMode = "override_origin"
	SetCacheSettingsRuleActionParametersBrowserTTLModeBypass          SetCacheSettingsRuleActionParametersBrowserTTLMode = "bypass"
)

func (SetCacheSettingsRuleActionParametersBrowserTTLMode) IsKnown 

func (r SetCacheSettingsRuleActionParametersBrowserTTLMode) IsKnown() bool

type SetCacheSettingsRuleActionParametersBrowserTTLParam 

type SetCacheSettingsRuleActionParametersBrowserTTLParam struct {
	// The browser TTL mode.
	Mode param.Field[SetCacheSettingsRuleActionParametersBrowserTTLMode] `json:"mode" api:"required"`
	// The browser TTL (in seconds) if you choose the "override_origin" mode.
	Default param.Field[int64] `json:"default"`
}

How long client browsers should cache the response. Cloudflare cache purge will not purge content cached on client browsers, so high browser TTLs may lead to stale content.

func (SetCacheSettingsRuleActionParametersBrowserTTLParam) MarshalJSON 

func (r SetCacheSettingsRuleActionParametersBrowserTTLParam) MarshalJSON() (data []byte, err error)

type SetCacheSettingsRuleActionParametersCacheKey 

type SetCacheSettingsRuleActionParametersCacheKey struct {
	// Whether to separate cached content based on the visitor's device type.
	CacheByDeviceType bool `json:"cache_by_device_type"`
	// Whether to protect from web cache deception attacks, while allowing static
	// assets to be cached.
	CacheDeceptionArmor bool `json:"cache_deception_armor"`
	// Which components of the request are included or excluded from the cache key.
	CustomKey SetCacheSettingsRuleActionParametersCacheKeyCustomKey `json:"custom_key"`
	// Whether to treat requests with the same query parameters the same, regardless of
	// the order those query parameters are in.
	IgnoreQueryStringsOrder bool                                             `json:"ignore_query_strings_order"`
	JSON                    setCacheSettingsRuleActionParametersCacheKeyJSON `json:"-"`
}

Which components of the request are included in or excluded from the cache key Cloudflare uses to store the response in cache.

func (*SetCacheSettingsRuleActionParametersCacheKey) UnmarshalJSON 

func (r *SetCacheSettingsRuleActionParametersCacheKey) UnmarshalJSON(data []byte) (err error)

type SetCacheSettingsRuleActionParametersCacheKeyCustomKey 

type SetCacheSettingsRuleActionParametersCacheKeyCustomKey struct {
	// Which cookies to include in the cache key.
	Cookie SetCacheSettingsRuleActionParametersCacheKeyCustomKeyCookie `json:"cookie"`
	// Which headers to include in the cache key.
	Header SetCacheSettingsRuleActionParametersCacheKeyCustomKeyHeader `json:"header"`
	// How to use the host in the cache key.
	Host SetCacheSettingsRuleActionParametersCacheKeyCustomKeyHost `json:"host"`
	// Which query string parameters to include in or exclude from the cache key.
	QueryString SetCacheSettingsRuleActionParametersCacheKeyCustomKeyQueryString `json:"query_string"`
	// How to use characteristics of the request user agent in the cache key.
	User SetCacheSettingsRuleActionParametersCacheKeyCustomKeyUser `json:"user"`
	JSON setCacheSettingsRuleActionParametersCacheKeyCustomKeyJSON `json:"-"`
}

Which components of the request are included or excluded from the cache key.

func (*SetCacheSettingsRuleActionParametersCacheKeyCustomKey) UnmarshalJSON 

func (r *SetCacheSettingsRuleActionParametersCacheKeyCustomKey) UnmarshalJSON(data []byte) (err error)

type SetCacheSettingsRuleActionParametersCacheKeyCustomKeyCookie 

type SetCacheSettingsRuleActionParametersCacheKeyCustomKeyCookie struct {
	// A list of cookies to check for the presence of. The presence of these cookies is
	// included in the cache key.
	CheckPresence []string `json:"check_presence"`
	// A list of cookies to include in the cache key.
	Include []string                                                        `json:"include"`
	JSON    setCacheSettingsRuleActionParametersCacheKeyCustomKeyCookieJSON `json:"-"`
}

Which cookies to include in the cache key.

func (*SetCacheSettingsRuleActionParametersCacheKeyCustomKeyCookie) UnmarshalJSON 

func (r *SetCacheSettingsRuleActionParametersCacheKeyCustomKeyCookie) UnmarshalJSON(data []byte) (err error)

type SetCacheSettingsRuleActionParametersCacheKeyCustomKeyCookieParam 

type SetCacheSettingsRuleActionParametersCacheKeyCustomKeyCookieParam struct {
	// A list of cookies to check for the presence of. The presence of these cookies is
	// included in the cache key.
	CheckPresence param.Field[[]string] `json:"check_presence"`
	// A list of cookies to include in the cache key.
	Include param.Field[[]string] `json:"include"`
}

Which cookies to include in the cache key.

func (SetCacheSettingsRuleActionParametersCacheKeyCustomKeyCookieParam) MarshalJSON 

func (r SetCacheSettingsRuleActionParametersCacheKeyCustomKeyCookieParam) MarshalJSON() (data []byte, err error)

type SetCacheSettingsRuleActionParametersCacheKeyCustomKeyHeader 

type SetCacheSettingsRuleActionParametersCacheKeyCustomKeyHeader struct {
	// A list of headers to check for the presence of. The presence of these headers is
	// included in the cache key.
	CheckPresence []string `json:"check_presence"`
	// A mapping of header names to a list of values. If a header is present in the
	// request and contains any of the values provided, its value is included in the
	// cache key.
	Contains map[string][]string `json:"contains"`
	// Whether to exclude the origin header in the cache key.
	ExcludeOrigin bool `json:"exclude_origin"`
	// A list of headers to include in the cache key.
	Include []string                                                        `json:"include"`
	JSON    setCacheSettingsRuleActionParametersCacheKeyCustomKeyHeaderJSON `json:"-"`
}

Which headers to include in the cache key.

func (*SetCacheSettingsRuleActionParametersCacheKeyCustomKeyHeader) UnmarshalJSON 

func (r *SetCacheSettingsRuleActionParametersCacheKeyCustomKeyHeader) UnmarshalJSON(data []byte) (err error)

type SetCacheSettingsRuleActionParametersCacheKeyCustomKeyHeaderParam 

type SetCacheSettingsRuleActionParametersCacheKeyCustomKeyHeaderParam struct {
	// A list of headers to check for the presence of. The presence of these headers is
	// included in the cache key.
	CheckPresence param.Field[[]string] `json:"check_presence"`
	// A mapping of header names to a list of values. If a header is present in the
	// request and contains any of the values provided, its value is included in the
	// cache key.
	Contains param.Field[map[string][]string] `json:"contains"`
	// Whether to exclude the origin header in the cache key.
	ExcludeOrigin param.Field[bool] `json:"exclude_origin"`
	// A list of headers to include in the cache key.
	Include param.Field[[]string] `json:"include"`
}

Which headers to include in the cache key.

func (SetCacheSettingsRuleActionParametersCacheKeyCustomKeyHeaderParam) MarshalJSON 

func (r SetCacheSettingsRuleActionParametersCacheKeyCustomKeyHeaderParam) MarshalJSON() (data []byte, err error)

type SetCacheSettingsRuleActionParametersCacheKeyCustomKeyHost 

type SetCacheSettingsRuleActionParametersCacheKeyCustomKeyHost struct {
	// Whether to use the resolved host in the cache key.
	Resolved bool                                                          `json:"resolved"`
	JSON     setCacheSettingsRuleActionParametersCacheKeyCustomKeyHostJSON `json:"-"`
}

How to use the host in the cache key.

func (*SetCacheSettingsRuleActionParametersCacheKeyCustomKeyHost) UnmarshalJSON 

func (r *SetCacheSettingsRuleActionParametersCacheKeyCustomKeyHost) UnmarshalJSON(data []byte) (err error)

type SetCacheSettingsRuleActionParametersCacheKeyCustomKeyHostParam 

type SetCacheSettingsRuleActionParametersCacheKeyCustomKeyHostParam struct {
	// Whether to use the resolved host in the cache key.
	Resolved param.Field[bool] `json:"resolved"`
}

How to use the host in the cache key.

func (SetCacheSettingsRuleActionParametersCacheKeyCustomKeyHostParam) MarshalJSON 

func (r SetCacheSettingsRuleActionParametersCacheKeyCustomKeyHostParam) MarshalJSON() (data []byte, err error)

type SetCacheSettingsRuleActionParametersCacheKeyCustomKeyParam 

type SetCacheSettingsRuleActionParametersCacheKeyCustomKeyParam struct {
	// Which cookies to include in the cache key.
	Cookie param.Field[SetCacheSettingsRuleActionParametersCacheKeyCustomKeyCookieParam] `json:"cookie"`
	// Which headers to include in the cache key.
	Header param.Field[SetCacheSettingsRuleActionParametersCacheKeyCustomKeyHeaderParam] `json:"header"`
	// How to use the host in the cache key.
	Host param.Field[SetCacheSettingsRuleActionParametersCacheKeyCustomKeyHostParam] `json:"host"`
	// Which query string parameters to include in or exclude from the cache key.
	QueryString param.Field[SetCacheSettingsRuleActionParametersCacheKeyCustomKeyQueryStringParam] `json:"query_string"`
	// How to use characteristics of the request user agent in the cache key.
	User param.Field[SetCacheSettingsRuleActionParametersCacheKeyCustomKeyUserParam] `json:"user"`
}

Which components of the request are included or excluded from the cache key.

func (SetCacheSettingsRuleActionParametersCacheKeyCustomKeyParam) MarshalJSON 

func (r SetCacheSettingsRuleActionParametersCacheKeyCustomKeyParam) MarshalJSON() (data []byte, err error)

type SetCacheSettingsRuleActionParametersCacheKeyCustomKeyQueryString 

type SetCacheSettingsRuleActionParametersCacheKeyCustomKeyQueryString struct {
	// Which query string parameters to exclude from the cache key.
	Exclude SetCacheSettingsRuleActionParametersCacheKeyCustomKeyQueryStringExclude `json:"exclude"`
	// Which query string parameters to include in the cache key.
	Include SetCacheSettingsRuleActionParametersCacheKeyCustomKeyQueryStringInclude `json:"include"`
	JSON    setCacheSettingsRuleActionParametersCacheKeyCustomKeyQueryStringJSON    `json:"-"`
}

Which query string parameters to include in or exclude from the cache key.

func (*SetCacheSettingsRuleActionParametersCacheKeyCustomKeyQueryString) UnmarshalJSON 

func (r *SetCacheSettingsRuleActionParametersCacheKeyCustomKeyQueryString) UnmarshalJSON(data []byte) (err error)

type SetCacheSettingsRuleActionParametersCacheKeyCustomKeyQueryStringExclude 

type SetCacheSettingsRuleActionParametersCacheKeyCustomKeyQueryStringExclude struct {
	// Whether to exclude all query string parameters from the cache key.
	All SetCacheSettingsRuleActionParametersCacheKeyCustomKeyQueryStringExcludeAll `json:"all"`
	// A list of query string parameters to exclude from the cache key.
	List []string                                                                    `json:"list"`
	JSON setCacheSettingsRuleActionParametersCacheKeyCustomKeyQueryStringExcludeJSON `json:"-"`
}

Which query string parameters to exclude from the cache key.

func (*SetCacheSettingsRuleActionParametersCacheKeyCustomKeyQueryStringExclude) UnmarshalJSON 

func (r *SetCacheSettingsRuleActionParametersCacheKeyCustomKeyQueryStringExclude) UnmarshalJSON(data []byte) (err error)

type SetCacheSettingsRuleActionParametersCacheKeyCustomKeyQueryStringExcludeAll 

type SetCacheSettingsRuleActionParametersCacheKeyCustomKeyQueryStringExcludeAll bool

Whether to exclude all query string parameters from the cache key. 

const (
	SetCacheSettingsRuleActionParametersCacheKeyCustomKeyQueryStringExcludeAllTrue SetCacheSettingsRuleActionParametersCacheKeyCustomKeyQueryStringExcludeAll = true
)

func (SetCacheSettingsRuleActionParametersCacheKeyCustomKeyQueryStringExcludeAll) IsKnown 

func (r SetCacheSettingsRuleActionParametersCacheKeyCustomKeyQueryStringExcludeAll) IsKnown() bool

type SetCacheSettingsRuleActionParametersCacheKeyCustomKeyQueryStringExcludeParam 

type SetCacheSettingsRuleActionParametersCacheKeyCustomKeyQueryStringExcludeParam struct {
	// Whether to exclude all query string parameters from the cache key.
	All param.Field[SetCacheSettingsRuleActionParametersCacheKeyCustomKeyQueryStringExcludeAll] `json:"all"`
	// A list of query string parameters to exclude from the cache key.
	List param.Field[[]string] `json:"list"`
}

Which query string parameters to exclude from the cache key.

func (SetCacheSettingsRuleActionParametersCacheKeyCustomKeyQueryStringExcludeParam) MarshalJSON 

func (r SetCacheSettingsRuleActionParametersCacheKeyCustomKeyQueryStringExcludeParam) MarshalJSON() (data []byte, err error)

type SetCacheSettingsRuleActionParametersCacheKeyCustomKeyQueryStringInclude 

type SetCacheSettingsRuleActionParametersCacheKeyCustomKeyQueryStringInclude struct {
	// Whether to include all query string parameters in the cache key.
	All SetCacheSettingsRuleActionParametersCacheKeyCustomKeyQueryStringIncludeAll `json:"all"`
	// A list of query string parameters to include in the cache key.
	List []string                                                                    `json:"list"`
	JSON setCacheSettingsRuleActionParametersCacheKeyCustomKeyQueryStringIncludeJSON `json:"-"`
}

Which query string parameters to include in the cache key.

func (*SetCacheSettingsRuleActionParametersCacheKeyCustomKeyQueryStringInclude) UnmarshalJSON 

func (r *SetCacheSettingsRuleActionParametersCacheKeyCustomKeyQueryStringInclude) UnmarshalJSON(data []byte) (err error)

type SetCacheSettingsRuleActionParametersCacheKeyCustomKeyQueryStringIncludeAll 

type SetCacheSettingsRuleActionParametersCacheKeyCustomKeyQueryStringIncludeAll bool

Whether to include all query string parameters in the cache key. 

const (
	SetCacheSettingsRuleActionParametersCacheKeyCustomKeyQueryStringIncludeAllTrue SetCacheSettingsRuleActionParametersCacheKeyCustomKeyQueryStringIncludeAll = true
)

func (SetCacheSettingsRuleActionParametersCacheKeyCustomKeyQueryStringIncludeAll) IsKnown 

func (r SetCacheSettingsRuleActionParametersCacheKeyCustomKeyQueryStringIncludeAll) IsKnown() bool

type SetCacheSettingsRuleActionParametersCacheKeyCustomKeyQueryStringIncludeParam 

type SetCacheSettingsRuleActionParametersCacheKeyCustomKeyQueryStringIncludeParam struct {
	// Whether to include all query string parameters in the cache key.
	All param.Field[SetCacheSettingsRuleActionParametersCacheKeyCustomKeyQueryStringIncludeAll] `json:"all"`
	// A list of query string parameters to include in the cache key.
	List param.Field[[]string] `json:"list"`
}

Which query string parameters to include in the cache key.

func (SetCacheSettingsRuleActionParametersCacheKeyCustomKeyQueryStringIncludeParam) MarshalJSON 

func (r SetCacheSettingsRuleActionParametersCacheKeyCustomKeyQueryStringIncludeParam) MarshalJSON() (data []byte, err error)

type SetCacheSettingsRuleActionParametersCacheKeyCustomKeyQueryStringParam 

type SetCacheSettingsRuleActionParametersCacheKeyCustomKeyQueryStringParam struct {
	// Which query string parameters to exclude from the cache key.
	Exclude param.Field[SetCacheSettingsRuleActionParametersCacheKeyCustomKeyQueryStringExcludeParam] `json:"exclude"`
	// Which query string parameters to include in the cache key.
	Include param.Field[SetCacheSettingsRuleActionParametersCacheKeyCustomKeyQueryStringIncludeParam] `json:"include"`
}

Which query string parameters to include in or exclude from the cache key.

func (SetCacheSettingsRuleActionParametersCacheKeyCustomKeyQueryStringParam) MarshalJSON 

func (r SetCacheSettingsRuleActionParametersCacheKeyCustomKeyQueryStringParam) MarshalJSON() (data []byte, err error)

type SetCacheSettingsRuleActionParametersCacheKeyCustomKeyUser 

type SetCacheSettingsRuleActionParametersCacheKeyCustomKeyUser struct {
	// Whether to use the user agent's device type in the cache key.
	DeviceType bool `json:"device_type"`
	// Whether to use the user agents's country in the cache key.
	Geo bool `json:"geo"`
	// Whether to use the user agent's language in the cache key.
	Lang bool                                                          `json:"lang"`
	JSON setCacheSettingsRuleActionParametersCacheKeyCustomKeyUserJSON `json:"-"`
}

How to use characteristics of the request user agent in the cache key.

func (*SetCacheSettingsRuleActionParametersCacheKeyCustomKeyUser) UnmarshalJSON 

func (r *SetCacheSettingsRuleActionParametersCacheKeyCustomKeyUser) UnmarshalJSON(data []byte) (err error)

type SetCacheSettingsRuleActionParametersCacheKeyCustomKeyUserParam 

type SetCacheSettingsRuleActionParametersCacheKeyCustomKeyUserParam struct {
	// Whether to use the user agent's device type in the cache key.
	DeviceType param.Field[bool] `json:"device_type"`
	// Whether to use the user agents's country in the cache key.
	Geo param.Field[bool] `json:"geo"`
	// Whether to use the user agent's language in the cache key.
	Lang param.Field[bool] `json:"lang"`
}

How to use characteristics of the request user agent in the cache key.

func (SetCacheSettingsRuleActionParametersCacheKeyCustomKeyUserParam) MarshalJSON 

func (r SetCacheSettingsRuleActionParametersCacheKeyCustomKeyUserParam) MarshalJSON() (data []byte, err error)

type SetCacheSettingsRuleActionParametersCacheKeyParam 

type SetCacheSettingsRuleActionParametersCacheKeyParam struct {
	// Whether to separate cached content based on the visitor's device type.
	CacheByDeviceType param.Field[bool] `json:"cache_by_device_type"`
	// Whether to protect from web cache deception attacks, while allowing static
	// assets to be cached.
	CacheDeceptionArmor param.Field[bool] `json:"cache_deception_armor"`
	// Which components of the request are included or excluded from the cache key.
	CustomKey param.Field[SetCacheSettingsRuleActionParametersCacheKeyCustomKeyParam] `json:"custom_key"`
	// Whether to treat requests with the same query parameters the same, regardless of
	// the order those query parameters are in.
	IgnoreQueryStringsOrder param.Field[bool] `json:"ignore_query_strings_order"`
}

Which components of the request are included in or excluded from the cache key Cloudflare uses to store the response in cache.

func (SetCacheSettingsRuleActionParametersCacheKeyParam) MarshalJSON 

func (r SetCacheSettingsRuleActionParametersCacheKeyParam) MarshalJSON() (data []byte, err error)

type SetCacheSettingsRuleActionParametersCacheReserve 

type SetCacheSettingsRuleActionParametersCacheReserve struct {
	// Whether Cache Reserve is enabled. If this is true and a request meets
	// eligibility criteria, Cloudflare will write the resource to Cache Reserve.
	Eligible bool `json:"eligible" api:"required"`
	// The minimum file size eligible for storage in Cache Reserve.
	MinimumFileSize int64                                                `json:"minimum_file_size"`
	JSON            setCacheSettingsRuleActionParametersCacheReserveJSON `json:"-"`
}

Settings to determine whether the request's response from origin is eligible for Cache Reserve (requires a Cache Reserve add-on plan).

func (*SetCacheSettingsRuleActionParametersCacheReserve) UnmarshalJSON 

func (r *SetCacheSettingsRuleActionParametersCacheReserve) UnmarshalJSON(data []byte) (err error)

type SetCacheSettingsRuleActionParametersCacheReserveParam 

type SetCacheSettingsRuleActionParametersCacheReserveParam struct {
	// Whether Cache Reserve is enabled. If this is true and a request meets
	// eligibility criteria, Cloudflare will write the resource to Cache Reserve.
	Eligible param.Field[bool] `json:"eligible" api:"required"`
	// The minimum file size eligible for storage in Cache Reserve.
	MinimumFileSize param.Field[int64] `json:"minimum_file_size"`
}

Settings to determine whether the request's response from origin is eligible for Cache Reserve (requires a Cache Reserve add-on plan).

func (SetCacheSettingsRuleActionParametersCacheReserveParam) MarshalJSON 

func (r SetCacheSettingsRuleActionParametersCacheReserveParam) MarshalJSON() (data []byte, err error)

type SetCacheSettingsRuleActionParametersEdgeTTL 

type SetCacheSettingsRuleActionParametersEdgeTTL struct {
	// The edge TTL mode.
	Mode SetCacheSettingsRuleActionParametersEdgeTTLMode `json:"mode" api:"required"`
	// The edge TTL (in seconds) if you choose the "override_origin" mode.
	Default int64 `json:"default"`
	// A list of TTLs to apply to specific status codes or status code ranges.
	StatusCodeTTL []SetCacheSettingsRuleActionParametersEdgeTTLStatusCodeTTL `json:"status_code_ttl"`
	JSON          setCacheSettingsRuleActionParametersEdgeTTLJSON            `json:"-"`
}

How long the Cloudflare edge network should cache the response.

func (*SetCacheSettingsRuleActionParametersEdgeTTL) UnmarshalJSON 

func (r *SetCacheSettingsRuleActionParametersEdgeTTL) UnmarshalJSON(data []byte) (err error)

type SetCacheSettingsRuleActionParametersEdgeTTLMode 

type SetCacheSettingsRuleActionParametersEdgeTTLMode string

The edge TTL mode. 

const (
	SetCacheSettingsRuleActionParametersEdgeTTLModeRespectOrigin   SetCacheSettingsRuleActionParametersEdgeTTLMode = "respect_origin"
	SetCacheSettingsRuleActionParametersEdgeTTLModeBypassByDefault SetCacheSettingsRuleActionParametersEdgeTTLMode = "bypass_by_default"
	SetCacheSettingsRuleActionParametersEdgeTTLModeOverrideOrigin  SetCacheSettingsRuleActionParametersEdgeTTLMode = "override_origin"
)

func (SetCacheSettingsRuleActionParametersEdgeTTLMode) IsKnown 

func (r SetCacheSettingsRuleActionParametersEdgeTTLMode) IsKnown() bool

type SetCacheSettingsRuleActionParametersEdgeTTLParam 

type SetCacheSettingsRuleActionParametersEdgeTTLParam struct {
	// The edge TTL mode.
	Mode param.Field[SetCacheSettingsRuleActionParametersEdgeTTLMode] `json:"mode" api:"required"`
	// The edge TTL (in seconds) if you choose the "override_origin" mode.
	Default param.Field[int64] `json:"default"`
	// A list of TTLs to apply to specific status codes or status code ranges.
	StatusCodeTTL param.Field[[]SetCacheSettingsRuleActionParametersEdgeTTLStatusCodeTTLParam] `json:"status_code_ttl"`
}

How long the Cloudflare edge network should cache the response.

func (SetCacheSettingsRuleActionParametersEdgeTTLParam) MarshalJSON 

func (r SetCacheSettingsRuleActionParametersEdgeTTLParam) MarshalJSON() (data []byte, err error)

type SetCacheSettingsRuleActionParametersEdgeTTLStatusCodeTTL 

type SetCacheSettingsRuleActionParametersEdgeTTLStatusCodeTTL struct {
	// The time to cache the response for (in seconds). A value of 0 is equivalent to
	// setting the cache control header with the value "no-cache". A value of -1 is
	// equivalent to setting the cache control header with the value of "no-store".
	Value int64 `json:"value" api:"required"`
	// A single status code to apply the TTL to.
	StatusCode int64 `json:"status_code"`
	// A range of status codes to apply the TTL to.
	StatusCodeRange SetCacheSettingsRuleActionParametersEdgeTTLStatusCodeTTLStatusCodeRange `json:"status_code_range"`
	JSON            setCacheSettingsRuleActionParametersEdgeTTLStatusCodeTTLJSON            `json:"-"`
}

func (*SetCacheSettingsRuleActionParametersEdgeTTLStatusCodeTTL) UnmarshalJSON 

func (r *SetCacheSettingsRuleActionParametersEdgeTTLStatusCodeTTL) UnmarshalJSON(data []byte) (err error)

type SetCacheSettingsRuleActionParametersEdgeTTLStatusCodeTTLParam 

type SetCacheSettingsRuleActionParametersEdgeTTLStatusCodeTTLParam struct {
	// The time to cache the response for (in seconds). A value of 0 is equivalent to
	// setting the cache control header with the value "no-cache". A value of -1 is
	// equivalent to setting the cache control header with the value of "no-store".
	Value param.Field[int64] `json:"value" api:"required"`
	// A single status code to apply the TTL to.
	StatusCode param.Field[int64] `json:"status_code"`
	// A range of status codes to apply the TTL to.
	StatusCodeRange param.Field[SetCacheSettingsRuleActionParametersEdgeTTLStatusCodeTTLStatusCodeRangeParam] `json:"status_code_range"`
}

func (SetCacheSettingsRuleActionParametersEdgeTTLStatusCodeTTLParam) MarshalJSON 

func (r SetCacheSettingsRuleActionParametersEdgeTTLStatusCodeTTLParam) MarshalJSON() (data []byte, err error)

type SetCacheSettingsRuleActionParametersEdgeTTLStatusCodeTTLStatusCodeRange 

type SetCacheSettingsRuleActionParametersEdgeTTLStatusCodeTTLStatusCodeRange struct {
	// The lower bound of the range.
	From int64 `json:"from"`
	// The upper bound of the range.
	To   int64                                                                       `json:"to"`
	JSON setCacheSettingsRuleActionParametersEdgeTTLStatusCodeTTLStatusCodeRangeJSON `json:"-"`
}

A range of status codes to apply the TTL to.

func (*SetCacheSettingsRuleActionParametersEdgeTTLStatusCodeTTLStatusCodeRange) UnmarshalJSON 

func (r *SetCacheSettingsRuleActionParametersEdgeTTLStatusCodeTTLStatusCodeRange) UnmarshalJSON(data []byte) (err error)

type SetCacheSettingsRuleActionParametersEdgeTTLStatusCodeTTLStatusCodeRangeParam 

type SetCacheSettingsRuleActionParametersEdgeTTLStatusCodeTTLStatusCodeRangeParam struct {
	// The lower bound of the range.
	From param.Field[int64] `json:"from"`
	// The upper bound of the range.
	To param.Field[int64] `json:"to"`
}

A range of status codes to apply the TTL to.

func (SetCacheSettingsRuleActionParametersEdgeTTLStatusCodeTTLStatusCodeRangeParam) MarshalJSON 

func (r SetCacheSettingsRuleActionParametersEdgeTTLStatusCodeTTLStatusCodeRangeParam) MarshalJSON() (data []byte, err error)

type SetCacheSettingsRuleActionParametersParam 

type SetCacheSettingsRuleActionParametersParam struct {
	// A list of additional ports that caching should be enabled on.
	AdditionalCacheablePorts param.Field[[]int64] `json:"additional_cacheable_ports"`
	// How long client browsers should cache the response. Cloudflare cache purge will
	// not purge content cached on client browsers, so high browser TTLs may lead to
	// stale content.
	BrowserTTL param.Field[SetCacheSettingsRuleActionParametersBrowserTTLParam] `json:"browser_ttl"`
	// Whether the request's response from the origin is eligible for caching. Caching
	// itself will still depend on the cache control header and your other caching
	// configurations.
	Cache param.Field[bool] `json:"cache"`
	// Which components of the request are included in or excluded from the cache key
	// Cloudflare uses to store the response in cache.
	CacheKey param.Field[SetCacheSettingsRuleActionParametersCacheKeyParam] `json:"cache_key"`
	// Settings to determine whether the request's response from origin is eligible for
	// Cache Reserve (requires a Cache Reserve add-on plan).
	CacheReserve param.Field[SetCacheSettingsRuleActionParametersCacheReserveParam] `json:"cache_reserve"`
	// How long the Cloudflare edge network should cache the response.
	EdgeTTL param.Field[SetCacheSettingsRuleActionParametersEdgeTTLParam] `json:"edge_ttl"`
	// Whether Cloudflare will aim to strictly adhere to RFC 7234.
	OriginCacheControl param.Field[bool] `json:"origin_cache_control"`
	// Whether to generate Cloudflare error pages for issues from the origin server.
	OriginErrorPagePassthru param.Field[bool] `json:"origin_error_page_passthru"`
	// A timeout value between two successive read operations to use for your origin
	// server. Historically, the timeout value between two read options from Cloudflare
	// to an origin server is 100 seconds. If you are attempting to reduce HTTP 524
	// errors because of timeouts from an origin server, try increasing this timeout
	// value.
	ReadTimeout param.Field[int64] `json:"read_timeout"`
	// Whether Cloudflare should respect strong ETag (entity tag) headers. If false,
	// Cloudflare converts strong ETag headers to weak ETag headers.
	RespectStrongEtags param.Field[bool] `json:"respect_strong_etags"`
	// When to serve stale content from cache.
	ServeStale param.Field[SetCacheSettingsRuleActionParametersServeStaleParam] `json:"serve_stale"`
	// Configuration for shared dictionary compression. When set, Cloudflare injects
	// Use-As-Dictionary headers on matching cacheable responses.
	SharedDictionary param.Field[SetCacheSettingsRuleActionParametersSharedDictionaryParam] `json:"shared_dictionary"`
	// Whether to strip ETag headers from the origin response before caching.
	StripEtags param.Field[bool] `json:"strip_etags"`
	// Whether to strip Last-Modified headers from the origin response before caching.
	StripLastModified param.Field[bool] `json:"strip_last_modified"`
	// Whether to strip Set-Cookie headers from the origin response before caching.
	StripSetCookie param.Field[bool] `json:"strip_set_cookie"`
}

The parameters configuring the rule's action.

func (SetCacheSettingsRuleActionParametersParam) MarshalJSON 

func (r SetCacheSettingsRuleActionParametersParam) MarshalJSON() (data []byte, err error)

type SetCacheSettingsRuleActionParametersServeStale 

type SetCacheSettingsRuleActionParametersServeStale struct {
	// Whether Cloudflare should disable serving stale content while getting the latest
	// content from the origin.
	DisableStaleWhileUpdating bool                                               `json:"disable_stale_while_updating"`
	JSON                      setCacheSettingsRuleActionParametersServeStaleJSON `json:"-"`
}

When to serve stale content from cache.

func (*SetCacheSettingsRuleActionParametersServeStale) UnmarshalJSON 

func (r *SetCacheSettingsRuleActionParametersServeStale) UnmarshalJSON(data []byte) (err error)

type SetCacheSettingsRuleActionParametersServeStaleParam 

type SetCacheSettingsRuleActionParametersServeStaleParam struct {
	// Whether Cloudflare should disable serving stale content while getting the latest
	// content from the origin.
	DisableStaleWhileUpdating param.Field[bool] `json:"disable_stale_while_updating"`
}

When to serve stale content from cache.

func (SetCacheSettingsRuleActionParametersServeStaleParam) MarshalJSON 

func (r SetCacheSettingsRuleActionParametersServeStaleParam) MarshalJSON() (data []byte, err error)

type SetCacheSettingsRuleActionParametersSharedDictionary added in v6.9.0 

type SetCacheSettingsRuleActionParametersSharedDictionary struct {
	// URL pattern for the Use-As-Dictionary match field. This pattern specifies which
	// URLs can use this response as a dictionary.
	MatchPattern string                                                   `json:"match_pattern" api:"required"`
	JSON         setCacheSettingsRuleActionParametersSharedDictionaryJSON `json:"-"`
}

Configuration for shared dictionary compression. When set, Cloudflare injects Use-As-Dictionary headers on matching cacheable responses.

func (*SetCacheSettingsRuleActionParametersSharedDictionary) UnmarshalJSON added in v6.9.0 

func (r *SetCacheSettingsRuleActionParametersSharedDictionary) UnmarshalJSON(data []byte) (err error)

type SetCacheSettingsRuleActionParametersSharedDictionaryParam added in v6.9.0 

type SetCacheSettingsRuleActionParametersSharedDictionaryParam struct {
	// URL pattern for the Use-As-Dictionary match field. This pattern specifies which
	// URLs can use this response as a dictionary.
	MatchPattern param.Field[string] `json:"match_pattern" api:"required"`
}

Configuration for shared dictionary compression. When set, Cloudflare injects Use-As-Dictionary headers on matching cacheable responses.

func (SetCacheSettingsRuleActionParametersSharedDictionaryParam) MarshalJSON added in v6.9.0 

func (r SetCacheSettingsRuleActionParametersSharedDictionaryParam) MarshalJSON() (data []byte, err error)

type SetCacheSettingsRuleExposedCredentialCheck 

type SetCacheSettingsRuleExposedCredentialCheck struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression string `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression string                                         `json:"username_expression" api:"required"`
	JSON               setCacheSettingsRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*SetCacheSettingsRuleExposedCredentialCheck) UnmarshalJSON 

func (r *SetCacheSettingsRuleExposedCredentialCheck) UnmarshalJSON(data []byte) (err error)

type SetCacheSettingsRuleExposedCredentialCheckParam 

type SetCacheSettingsRuleExposedCredentialCheckParam struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression param.Field[string] `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression param.Field[string] `json:"username_expression" api:"required"`
}

Configuration for exposed credential checking.

func (SetCacheSettingsRuleExposedCredentialCheckParam) MarshalJSON 

func (r SetCacheSettingsRuleExposedCredentialCheckParam) MarshalJSON() (data []byte, err error)

type SetCacheSettingsRuleParam 

type SetCacheSettingsRuleParam struct {
	// The unique ID of the rule.
	ID param.Field[string] `json:"id"`
	// The action to perform when the rule matches.
	Action param.Field[SetCacheSettingsRuleAction] `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters param.Field[SetCacheSettingsRuleActionParametersParam] `json:"action_parameters"`
	// An informative description of the rule.
	Description param.Field[string] `json:"description"`
	// Whether the rule should be executed.
	Enabled param.Field[bool] `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck param.Field[SetCacheSettingsRuleExposedCredentialCheckParam] `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression param.Field[string] `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging param.Field[LoggingParam] `json:"logging"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit param.Field[SetCacheSettingsRuleRatelimitParam] `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref param.Field[string] `json:"ref"`
}

func (SetCacheSettingsRuleParam) MarshalJSON 

func (r SetCacheSettingsRuleParam) MarshalJSON() (data []byte, err error)

type SetCacheSettingsRuleRatelimit 

type SetCacheSettingsRuleRatelimit struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics []string `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period int64 `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression string `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout int64 `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod int64 `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin bool `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod int64 `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName string                            `json:"score_response_header_name"`
	JSON                    setCacheSettingsRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*SetCacheSettingsRuleRatelimit) UnmarshalJSON 

func (r *SetCacheSettingsRuleRatelimit) UnmarshalJSON(data []byte) (err error)

type SetCacheSettingsRuleRatelimitParam 

type SetCacheSettingsRuleRatelimitParam struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics param.Field[[]string] `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period param.Field[int64] `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression param.Field[string] `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout param.Field[int64] `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod param.Field[int64] `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin param.Field[bool] `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod param.Field[int64] `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName param.Field[string] `json:"score_response_header_name"`
}

An object configuring the rule's rate limit behavior.

func (SetCacheSettingsRuleRatelimitParam) MarshalJSON 

func (r SetCacheSettingsRuleRatelimitParam) MarshalJSON() (data []byte, err error)

type SetConfigRule 

type SetConfigRule struct {
	// The timestamp of when the rule was last modified.
	LastUpdated time.Time `json:"last_updated" api:"required" format:"date-time"`
	// The version of the rule.
	Version string `json:"version" api:"required"`
	// The unique ID of the rule.
	ID string `json:"id"`
	// The action to perform when the rule matches.
	Action SetConfigRuleAction `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters SetConfigRuleActionParameters `json:"action_parameters"`
	// The categories of the rule.
	Categories []string `json:"categories"`
	// An informative description of the rule.
	Description string `json:"description"`
	// Whether the rule should be executed.
	Enabled bool `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck SetConfigRuleExposedCredentialCheck `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression string `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging Logging `json:"logging"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit SetConfigRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string            `json:"ref"`
	JSON setConfigRuleJSON `json:"-"`
}

func (*SetConfigRule) UnmarshalJSON 

func (r *SetConfigRule) UnmarshalJSON(data []byte) (err error)

type SetConfigRuleAction 

type SetConfigRuleAction string

The action to perform when the rule matches. 

const (
	SetConfigRuleActionSetConfig SetConfigRuleAction = "set_config"
)

func (SetConfigRuleAction) IsKnown 

func (r SetConfigRuleAction) IsKnown() bool

type SetConfigRuleActionParameters 

type SetConfigRuleActionParameters struct {
	// Whether to enable Automatic HTTPS Rewrites.
	AutomaticHTTPSRewrites bool `json:"automatic_https_rewrites"`
	// Which file extensions to minify automatically.
	Autominify SetConfigRuleActionParametersAutominify `json:"autominify"`
	// Whether to enable Browser Integrity Check (BIC).
	BIC bool `json:"bic"`
	// Whether to enable content conversion (e.g., HTML to Markdown).
	ContentConverter bool `json:"content_converter"`
	// Whether to disable Cloudflare Apps.
	//
	// Deprecated: Cloudflare Apps are deprected.
	DisableApps SetConfigRuleActionParametersDisableApps `json:"disable_apps"`
	// Whether to disable Pay Per Crawl.
	DisablePayPerCrawl SetConfigRuleActionParametersDisablePayPerCrawl `json:"disable_pay_per_crawl"`
	// Whether to disable Real User Monitoring (RUM).
	DisableRUM SetConfigRuleActionParametersDisableRUM `json:"disable_rum"`
	// Whether to disable Zaraz.
	DisableZaraz SetConfigRuleActionParametersDisableZaraz `json:"disable_zaraz"`
	// Whether to enable Email Obfuscation.
	EmailObfuscation bool `json:"email_obfuscation"`
	// Whether to enable Cloudflare Fonts.
	Fonts bool `json:"fonts"`
	// Whether to enable Hotlink Protection.
	HotlinkProtection bool `json:"hotlink_protection"`
	// Whether to enable Mirage.
	//
	// Deprecated: Mirage is deprecated. More information at
	// https://developers.cloudflare.com/speed/optimization/images/mirage/.
	Mirage bool `json:"mirage"`
	// Whether to enable Opportunistic Encryption.
	OpportunisticEncryption bool `json:"opportunistic_encryption"`
	// The Polish level to configure.
	Polish SetConfigRuleActionParametersPolish `json:"polish"`
	// Whether to redirect verified AI training crawlers to canonical URLs found in the
	// HTML response.
	RedirectsForAITraining bool `json:"redirects_for_ai_training"`
	// The request body buffering mode.
	RequestBodyBuffering SetConfigRuleActionParametersRequestBodyBuffering `json:"request_body_buffering"`
	// The response body buffering mode.
	ResponseBodyBuffering SetConfigRuleActionParametersResponseBodyBuffering `json:"response_body_buffering"`
	// Whether to enable Rocket Loader.
	RocketLoader bool `json:"rocket_loader"`
	// The Security Level to configure.
	SecurityLevel SetConfigRuleActionParametersSecurityLevel `json:"security_level"`
	// Whether to enable Server-Side Excludes.
	ServerSideExcludes bool `json:"server_side_excludes"`
	// The SSL level to configure.
	SSL SetConfigRuleActionParametersSSL `json:"ssl"`
	// Whether to enable Signed Exchanges (SXG).
	SXG  bool                              `json:"sxg"`
	JSON setConfigRuleActionParametersJSON `json:"-"`
}

The parameters configuring the rule's action.

func (*SetConfigRuleActionParameters) UnmarshalJSON 

func (r *SetConfigRuleActionParameters) UnmarshalJSON(data []byte) (err error)

type SetConfigRuleActionParametersAutominify 

type SetConfigRuleActionParametersAutominify struct {
	// Whether to minify CSS files.
	CSS bool `json:"css"`
	// Whether to minify HTML files.
	HTML bool `json:"html"`
	// Whether to minify JavaScript files.
	JS   bool                                        `json:"js"`
	JSON setConfigRuleActionParametersAutominifyJSON `json:"-"`
}

Which file extensions to minify automatically.

func (*SetConfigRuleActionParametersAutominify) UnmarshalJSON 

func (r *SetConfigRuleActionParametersAutominify) UnmarshalJSON(data []byte) (err error)

type SetConfigRuleActionParametersAutominifyParam 

type SetConfigRuleActionParametersAutominifyParam struct {
	// Whether to minify CSS files.
	CSS param.Field[bool] `json:"css"`
	// Whether to minify HTML files.
	HTML param.Field[bool] `json:"html"`
	// Whether to minify JavaScript files.
	JS param.Field[bool] `json:"js"`
}

Which file extensions to minify automatically.

func (SetConfigRuleActionParametersAutominifyParam) MarshalJSON 

func (r SetConfigRuleActionParametersAutominifyParam) MarshalJSON() (data []byte, err error)

type SetConfigRuleActionParametersDisableApps 

type SetConfigRuleActionParametersDisableApps bool

Whether to disable Cloudflare Apps. 

const (
	SetConfigRuleActionParametersDisableAppsTrue SetConfigRuleActionParametersDisableApps = true
)

func (SetConfigRuleActionParametersDisableApps) IsKnown 

func (r SetConfigRuleActionParametersDisableApps) IsKnown() bool

type SetConfigRuleActionParametersDisablePayPerCrawl 

type SetConfigRuleActionParametersDisablePayPerCrawl bool

Whether to disable Pay Per Crawl. 

const (
	SetConfigRuleActionParametersDisablePayPerCrawlTrue SetConfigRuleActionParametersDisablePayPerCrawl = true
)

func (SetConfigRuleActionParametersDisablePayPerCrawl) IsKnown 

func (r SetConfigRuleActionParametersDisablePayPerCrawl) IsKnown() bool

type SetConfigRuleActionParametersDisableRUM 

type SetConfigRuleActionParametersDisableRUM bool

Whether to disable Real User Monitoring (RUM). 

const (
	SetConfigRuleActionParametersDisableRUMTrue SetConfigRuleActionParametersDisableRUM = true
)

func (SetConfigRuleActionParametersDisableRUM) IsKnown 

func (r SetConfigRuleActionParametersDisableRUM) IsKnown() bool

type SetConfigRuleActionParametersDisableZaraz 

type SetConfigRuleActionParametersDisableZaraz bool

Whether to disable Zaraz. 

const (
	SetConfigRuleActionParametersDisableZarazTrue SetConfigRuleActionParametersDisableZaraz = true
)

func (SetConfigRuleActionParametersDisableZaraz) IsKnown 

func (r SetConfigRuleActionParametersDisableZaraz) IsKnown() bool

type SetConfigRuleActionParametersParam 

type SetConfigRuleActionParametersParam struct {
	// Whether to enable Automatic HTTPS Rewrites.
	AutomaticHTTPSRewrites param.Field[bool] `json:"automatic_https_rewrites"`
	// Which file extensions to minify automatically.
	Autominify param.Field[SetConfigRuleActionParametersAutominifyParam] `json:"autominify"`
	// Whether to enable Browser Integrity Check (BIC).
	BIC param.Field[bool] `json:"bic"`
	// Whether to enable content conversion (e.g., HTML to Markdown).
	ContentConverter param.Field[bool] `json:"content_converter"`
	// Whether to disable Cloudflare Apps.
	//
	// Deprecated: Cloudflare Apps are deprected.
	DisableApps param.Field[SetConfigRuleActionParametersDisableApps] `json:"disable_apps"`
	// Whether to disable Pay Per Crawl.
	DisablePayPerCrawl param.Field[SetConfigRuleActionParametersDisablePayPerCrawl] `json:"disable_pay_per_crawl"`
	// Whether to disable Real User Monitoring (RUM).
	DisableRUM param.Field[SetConfigRuleActionParametersDisableRUM] `json:"disable_rum"`
	// Whether to disable Zaraz.
	DisableZaraz param.Field[SetConfigRuleActionParametersDisableZaraz] `json:"disable_zaraz"`
	// Whether to enable Email Obfuscation.
	EmailObfuscation param.Field[bool] `json:"email_obfuscation"`
	// Whether to enable Cloudflare Fonts.
	Fonts param.Field[bool] `json:"fonts"`
	// Whether to enable Hotlink Protection.
	HotlinkProtection param.Field[bool] `json:"hotlink_protection"`
	// Whether to enable Mirage.
	//
	// Deprecated: Mirage is deprecated. More information at
	// https://developers.cloudflare.com/speed/optimization/images/mirage/.
	Mirage param.Field[bool] `json:"mirage"`
	// Whether to enable Opportunistic Encryption.
	OpportunisticEncryption param.Field[bool] `json:"opportunistic_encryption"`
	// The Polish level to configure.
	Polish param.Field[SetConfigRuleActionParametersPolish] `json:"polish"`
	// Whether to redirect verified AI training crawlers to canonical URLs found in the
	// HTML response.
	RedirectsForAITraining param.Field[bool] `json:"redirects_for_ai_training"`
	// The request body buffering mode.
	RequestBodyBuffering param.Field[SetConfigRuleActionParametersRequestBodyBuffering] `json:"request_body_buffering"`
	// The response body buffering mode.
	ResponseBodyBuffering param.Field[SetConfigRuleActionParametersResponseBodyBuffering] `json:"response_body_buffering"`
	// Whether to enable Rocket Loader.
	RocketLoader param.Field[bool] `json:"rocket_loader"`
	// The Security Level to configure.
	SecurityLevel param.Field[SetConfigRuleActionParametersSecurityLevel] `json:"security_level"`
	// Whether to enable Server-Side Excludes.
	ServerSideExcludes param.Field[bool] `json:"server_side_excludes"`
	// The SSL level to configure.
	SSL param.Field[SetConfigRuleActionParametersSSL] `json:"ssl"`
	// Whether to enable Signed Exchanges (SXG).
	SXG param.Field[bool] `json:"sxg"`
}

The parameters configuring the rule's action.

func (SetConfigRuleActionParametersParam) MarshalJSON 

func (r SetConfigRuleActionParametersParam) MarshalJSON() (data []byte, err error)

type SetConfigRuleActionParametersPolish 

type SetConfigRuleActionParametersPolish string

The Polish level to configure. 

const (
	SetConfigRuleActionParametersPolishOff      SetConfigRuleActionParametersPolish = "off"
	SetConfigRuleActionParametersPolishLossless SetConfigRuleActionParametersPolish = "lossless"
	SetConfigRuleActionParametersPolishLossy    SetConfigRuleActionParametersPolish = "lossy"
	SetConfigRuleActionParametersPolishWebP     SetConfigRuleActionParametersPolish = "webp"
)

func (SetConfigRuleActionParametersPolish) IsKnown 

func (r SetConfigRuleActionParametersPolish) IsKnown() bool

type SetConfigRuleActionParametersRequestBodyBuffering added in v6.6.0 

type SetConfigRuleActionParametersRequestBodyBuffering string

The request body buffering mode. 

const (
	SetConfigRuleActionParametersRequestBodyBufferingNone     SetConfigRuleActionParametersRequestBodyBuffering = "none"
	SetConfigRuleActionParametersRequestBodyBufferingStandard SetConfigRuleActionParametersRequestBodyBuffering = "standard"
	SetConfigRuleActionParametersRequestBodyBufferingFull     SetConfigRuleActionParametersRequestBodyBuffering = "full"
)

func (SetConfigRuleActionParametersRequestBodyBuffering) IsKnown added in v6.6.0 

func (r SetConfigRuleActionParametersRequestBodyBuffering) IsKnown() bool

type SetConfigRuleActionParametersResponseBodyBuffering added in v6.6.0 

type SetConfigRuleActionParametersResponseBodyBuffering string

The response body buffering mode. 

const (
	SetConfigRuleActionParametersResponseBodyBufferingNone     SetConfigRuleActionParametersResponseBodyBuffering = "none"
	SetConfigRuleActionParametersResponseBodyBufferingStandard SetConfigRuleActionParametersResponseBodyBuffering = "standard"
)

func (SetConfigRuleActionParametersResponseBodyBuffering) IsKnown added in v6.6.0 

func (r SetConfigRuleActionParametersResponseBodyBuffering) IsKnown() bool

type SetConfigRuleActionParametersSSL 

type SetConfigRuleActionParametersSSL string

The SSL level to configure. 

const (
	SetConfigRuleActionParametersSSLOff        SetConfigRuleActionParametersSSL = "off"
	SetConfigRuleActionParametersSSLFlexible   SetConfigRuleActionParametersSSL = "flexible"
	SetConfigRuleActionParametersSSLFull       SetConfigRuleActionParametersSSL = "full"
	SetConfigRuleActionParametersSSLStrict     SetConfigRuleActionParametersSSL = "strict"
	SetConfigRuleActionParametersSSLOriginPull SetConfigRuleActionParametersSSL = "origin_pull"
)

func (SetConfigRuleActionParametersSSL) IsKnown 

func (r SetConfigRuleActionParametersSSL) IsKnown() bool

type SetConfigRuleActionParametersSecurityLevel 

type SetConfigRuleActionParametersSecurityLevel string

The Security Level to configure. 

const (
	SetConfigRuleActionParametersSecurityLevelOff            SetConfigRuleActionParametersSecurityLevel = "off"
	SetConfigRuleActionParametersSecurityLevelEssentiallyOff SetConfigRuleActionParametersSecurityLevel = "essentially_off"
	SetConfigRuleActionParametersSecurityLevelLow            SetConfigRuleActionParametersSecurityLevel = "low"
	SetConfigRuleActionParametersSecurityLevelMedium         SetConfigRuleActionParametersSecurityLevel = "medium"
	SetConfigRuleActionParametersSecurityLevelHigh           SetConfigRuleActionParametersSecurityLevel = "high"
	SetConfigRuleActionParametersSecurityLevelUnderAttack    SetConfigRuleActionParametersSecurityLevel = "under_attack"
)

func (SetConfigRuleActionParametersSecurityLevel) IsKnown 

func (r SetConfigRuleActionParametersSecurityLevel) IsKnown() bool

type SetConfigRuleExposedCredentialCheck 

type SetConfigRuleExposedCredentialCheck struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression string `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression string                                  `json:"username_expression" api:"required"`
	JSON               setConfigRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*SetConfigRuleExposedCredentialCheck) UnmarshalJSON 

func (r *SetConfigRuleExposedCredentialCheck) UnmarshalJSON(data []byte) (err error)

type SetConfigRuleExposedCredentialCheckParam 

type SetConfigRuleExposedCredentialCheckParam struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression param.Field[string] `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression param.Field[string] `json:"username_expression" api:"required"`
}

Configuration for exposed credential checking.

func (SetConfigRuleExposedCredentialCheckParam) MarshalJSON 

func (r SetConfigRuleExposedCredentialCheckParam) MarshalJSON() (data []byte, err error)

type SetConfigRuleParam 

type SetConfigRuleParam struct {
	// The unique ID of the rule.
	ID param.Field[string] `json:"id"`
	// The action to perform when the rule matches.
	Action param.Field[SetConfigRuleAction] `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters param.Field[SetConfigRuleActionParametersParam] `json:"action_parameters"`
	// An informative description of the rule.
	Description param.Field[string] `json:"description"`
	// Whether the rule should be executed.
	Enabled param.Field[bool] `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck param.Field[SetConfigRuleExposedCredentialCheckParam] `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression param.Field[string] `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging param.Field[LoggingParam] `json:"logging"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit param.Field[SetConfigRuleRatelimitParam] `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref param.Field[string] `json:"ref"`
}

func (SetConfigRuleParam) MarshalJSON 

func (r SetConfigRuleParam) MarshalJSON() (data []byte, err error)

type SetConfigRuleRatelimit 

type SetConfigRuleRatelimit struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics []string `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period int64 `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression string `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout int64 `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod int64 `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin bool `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod int64 `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName string                     `json:"score_response_header_name"`
	JSON                    setConfigRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*SetConfigRuleRatelimit) UnmarshalJSON 

func (r *SetConfigRuleRatelimit) UnmarshalJSON(data []byte) (err error)

type SetConfigRuleRatelimitParam 

type SetConfigRuleRatelimitParam struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics param.Field[[]string] `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period param.Field[int64] `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression param.Field[string] `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout param.Field[int64] `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod param.Field[int64] `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin param.Field[bool] `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod param.Field[int64] `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName param.Field[string] `json:"score_response_header_name"`
}

An object configuring the rule's rate limit behavior.

func (SetConfigRuleRatelimitParam) MarshalJSON 

func (r SetConfigRuleRatelimitParam) MarshalJSON() (data []byte, err error)

type SkipRule 

type SkipRule struct {
	// The timestamp of when the rule was last modified.
	LastUpdated time.Time `json:"last_updated" api:"required" format:"date-time"`
	// The version of the rule.
	Version string `json:"version" api:"required"`
	// The unique ID of the rule.
	ID string `json:"id"`
	// The action to perform when the rule matches.
	Action SkipRuleAction `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters SkipRuleActionParameters `json:"action_parameters"`
	// The categories of the rule.
	Categories []string `json:"categories"`
	// An informative description of the rule.
	Description string `json:"description"`
	// Whether the rule should be executed.
	Enabled bool `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck SkipRuleExposedCredentialCheck `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression string `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging Logging `json:"logging"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit SkipRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string       `json:"ref"`
	JSON skipRuleJSON `json:"-"`
}

func (*SkipRule) UnmarshalJSON 

func (r *SkipRule) UnmarshalJSON(data []byte) (err error)

type SkipRuleAction 

type SkipRuleAction string

The action to perform when the rule matches. 

const (
	SkipRuleActionSkip SkipRuleAction = "skip"
)

func (SkipRuleAction) IsKnown 

func (r SkipRuleAction) IsKnown() bool

type SkipRuleActionParameters 

type SkipRuleActionParameters struct {
	// A phase to skip the execution of. This option is only compatible with the
	// products option.
	Phase SkipRuleActionParametersPhase `json:"phase"`
	// A list of phases to skip the execution of. This option is incompatible with the
	// rulesets option.
	Phases []Phase `json:"phases"`
	// A list of legacy security products to skip the execution of.
	Products []SkipRuleActionParametersProduct `json:"products"`
	// A mapping of ruleset IDs to a list of rule IDs in that ruleset to skip the
	// execution of. This option is incompatible with the ruleset option.
	Rules map[string][]string `json:"rules"`
	// A ruleset to skip the execution of. This option is incompatible with the
	// rulesets option.
	Ruleset SkipRuleActionParametersRuleset `json:"ruleset"`
	// A list of ruleset IDs to skip the execution of. This option is incompatible with
	// the ruleset and phases options.
	Rulesets []string                     `json:"rulesets"`
	JSON     skipRuleActionParametersJSON `json:"-"`
}

The parameters configuring the rule's action.

func (*SkipRuleActionParameters) UnmarshalJSON 

func (r *SkipRuleActionParameters) UnmarshalJSON(data []byte) (err error)

type SkipRuleActionParametersParam 

type SkipRuleActionParametersParam struct {
	// A phase to skip the execution of. This option is only compatible with the
	// products option.
	Phase param.Field[SkipRuleActionParametersPhase] `json:"phase"`
	// A list of phases to skip the execution of. This option is incompatible with the
	// rulesets option.
	Phases param.Field[[]Phase] `json:"phases"`
	// A list of legacy security products to skip the execution of.
	Products param.Field[[]SkipRuleActionParametersProduct] `json:"products"`
	// A mapping of ruleset IDs to a list of rule IDs in that ruleset to skip the
	// execution of. This option is incompatible with the ruleset option.
	Rules param.Field[map[string][]string] `json:"rules"`
	// A ruleset to skip the execution of. This option is incompatible with the
	// rulesets option.
	Ruleset param.Field[SkipRuleActionParametersRuleset] `json:"ruleset"`
	// A list of ruleset IDs to skip the execution of. This option is incompatible with
	// the ruleset and phases options.
	Rulesets param.Field[[]string] `json:"rulesets"`
}

The parameters configuring the rule's action.

func (SkipRuleActionParametersParam) MarshalJSON 

func (r SkipRuleActionParametersParam) MarshalJSON() (data []byte, err error)

type SkipRuleActionParametersPhase 

type SkipRuleActionParametersPhase string

A phase to skip the execution of. This option is only compatible with the products option. 

const (
	SkipRuleActionParametersPhaseCurrent SkipRuleActionParametersPhase = "current"
)

func (SkipRuleActionParametersPhase) IsKnown 

func (r SkipRuleActionParametersPhase) IsKnown() bool

type SkipRuleActionParametersProduct 

type SkipRuleActionParametersProduct string

The name of a legacy security product to skip the execution of. 

const (
	SkipRuleActionParametersProductBIC           SkipRuleActionParametersProduct = "bic"
	SkipRuleActionParametersProductHot           SkipRuleActionParametersProduct = "hot"
	SkipRuleActionParametersProductRateLimit     SkipRuleActionParametersProduct = "rateLimit"
	SkipRuleActionParametersProductSecurityLevel SkipRuleActionParametersProduct = "securityLevel"
	SkipRuleActionParametersProductUABlock       SkipRuleActionParametersProduct = "uaBlock"
	SkipRuleActionParametersProductWAF           SkipRuleActionParametersProduct = "waf"
	SkipRuleActionParametersProductZoneLockdown  SkipRuleActionParametersProduct = "zoneLockdown"
)

func (SkipRuleActionParametersProduct) IsKnown 

func (r SkipRuleActionParametersProduct) IsKnown() bool

type SkipRuleActionParametersRuleset 

type SkipRuleActionParametersRuleset string

A ruleset to skip the execution of. This option is incompatible with the rulesets option. 

const (
	SkipRuleActionParametersRulesetCurrent SkipRuleActionParametersRuleset = "current"
)

func (SkipRuleActionParametersRuleset) IsKnown 

func (r SkipRuleActionParametersRuleset) IsKnown() bool

type SkipRuleExposedCredentialCheck 

type SkipRuleExposedCredentialCheck struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression string `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression string                             `json:"username_expression" api:"required"`
	JSON               skipRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*SkipRuleExposedCredentialCheck) UnmarshalJSON 

func (r *SkipRuleExposedCredentialCheck) UnmarshalJSON(data []byte) (err error)

type SkipRuleExposedCredentialCheckParam 

type SkipRuleExposedCredentialCheckParam struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression param.Field[string] `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression param.Field[string] `json:"username_expression" api:"required"`
}

Configuration for exposed credential checking.

func (SkipRuleExposedCredentialCheckParam) MarshalJSON 

func (r SkipRuleExposedCredentialCheckParam) MarshalJSON() (data []byte, err error)

type SkipRuleParam 

type SkipRuleParam struct {
	// The unique ID of the rule.
	ID param.Field[string] `json:"id"`
	// The action to perform when the rule matches.
	Action param.Field[SkipRuleAction] `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters param.Field[SkipRuleActionParametersParam] `json:"action_parameters"`
	// An informative description of the rule.
	Description param.Field[string] `json:"description"`
	// Whether the rule should be executed.
	Enabled param.Field[bool] `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck param.Field[SkipRuleExposedCredentialCheckParam] `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression param.Field[string] `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging param.Field[LoggingParam] `json:"logging"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit param.Field[SkipRuleRatelimitParam] `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref param.Field[string] `json:"ref"`
}

func (SkipRuleParam) MarshalJSON 

func (r SkipRuleParam) MarshalJSON() (data []byte, err error)

type SkipRuleRatelimit 

type SkipRuleRatelimit struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics []string `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period int64 `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression string `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout int64 `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod int64 `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin bool `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod int64 `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName string                `json:"score_response_header_name"`
	JSON                    skipRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*SkipRuleRatelimit) UnmarshalJSON 

func (r *SkipRuleRatelimit) UnmarshalJSON(data []byte) (err error)

type SkipRuleRatelimitParam 

type SkipRuleRatelimitParam struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics param.Field[[]string] `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period param.Field[int64] `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression param.Field[string] `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout param.Field[int64] `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod param.Field[int64] `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin param.Field[bool] `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod param.Field[int64] `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName param.Field[string] `json:"score_response_header_name"`
}

An object configuring the rule's rate limit behavior.

func (SkipRuleRatelimitParam) MarshalJSON 

func (r SkipRuleRatelimitParam) MarshalJSON() (data []byte, err error)

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.

type VersionDeleteParams 

type VersionDeleteParams struct {
	// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
	AccountID param.Field[string] `path:"account_id"`
	// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
	ZoneID param.Field[string] `path:"zone_id"`
}

type VersionGetParams 

type VersionGetParams struct {
	// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
	AccountID param.Field[string] `path:"account_id"`
	// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
	ZoneID param.Field[string] `path:"zone_id"`
}

type VersionGetResponse 

type VersionGetResponse struct {
	// The unique ID of the ruleset.
	ID string `json:"id" api:"required"`
	// The kind of the ruleset.
	Kind Kind `json:"kind" api:"required"`
	// The timestamp of when the ruleset was last modified.
	LastUpdated time.Time `json:"last_updated" api:"required" format:"date-time"`
	// The human-readable name of the ruleset.
	Name string `json:"name" api:"required"`
	// The phase of the ruleset.
	Phase Phase `json:"phase" api:"required"`
	// The list of rules in the ruleset.
	Rules []VersionGetResponseRule `json:"rules" api:"required"`
	// The version of the ruleset.
	Version string `json:"version" api:"required"`
	// An informative description of the ruleset.
	Description string                 `json:"description"`
	JSON        versionGetResponseJSON `json:"-"`
}

A ruleset object.

func (*VersionGetResponse) UnmarshalJSON 

func (r *VersionGetResponse) UnmarshalJSON(data []byte) (err error)

type VersionGetResponseEnvelope 

type VersionGetResponseEnvelope struct {
	// A list of error messages.
	Errors []VersionGetResponseEnvelopeErrors `json:"errors" api:"required"`
	// A list of warning messages.
	Messages []VersionGetResponseEnvelopeMessages `json:"messages" api:"required"`
	// A ruleset object.
	Result VersionGetResponse `json:"result" api:"required"`
	// Whether the API call was successful.
	Success VersionGetResponseEnvelopeSuccess `json:"success" api:"required"`
	JSON    versionGetResponseEnvelopeJSON    `json:"-"`
}

A response object.

func (*VersionGetResponseEnvelope) UnmarshalJSON 

func (r *VersionGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type VersionGetResponseEnvelopeErrors 

type VersionGetResponseEnvelopeErrors struct {
	// A text description of this message.
	Message string `json:"message" api:"required"`
	// A unique code for this message.
	Code int64 `json:"code"`
	// The source of this message.
	Source VersionGetResponseEnvelopeErrorsSource `json:"source"`
	JSON   versionGetResponseEnvelopeErrorsJSON   `json:"-"`
}

A message.

func (*VersionGetResponseEnvelopeErrors) UnmarshalJSON 

func (r *VersionGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)

type VersionGetResponseEnvelopeErrorsSource 

type VersionGetResponseEnvelopeErrorsSource struct {
	// A JSON pointer to the field that is the source of the message.
	Pointer string                                     `json:"pointer" api:"required"`
	JSON    versionGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}

The source of this message.

func (*VersionGetResponseEnvelopeErrorsSource) UnmarshalJSON 

func (r *VersionGetResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)

type VersionGetResponseEnvelopeMessages 

type VersionGetResponseEnvelopeMessages struct {
	// A text description of this message.
	Message string `json:"message" api:"required"`
	// A unique code for this message.
	Code int64 `json:"code"`
	// The source of this message.
	Source VersionGetResponseEnvelopeMessagesSource `json:"source"`
	JSON   versionGetResponseEnvelopeMessagesJSON   `json:"-"`
}

A message.

func (*VersionGetResponseEnvelopeMessages) UnmarshalJSON 

func (r *VersionGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)

type VersionGetResponseEnvelopeMessagesSource 

type VersionGetResponseEnvelopeMessagesSource struct {
	// A JSON pointer to the field that is the source of the message.
	Pointer string                                       `json:"pointer" api:"required"`
	JSON    versionGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}

The source of this message.

func (*VersionGetResponseEnvelopeMessagesSource) UnmarshalJSON 

func (r *VersionGetResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)

type VersionGetResponseEnvelopeSuccess 

type VersionGetResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	VersionGetResponseEnvelopeSuccessTrue VersionGetResponseEnvelopeSuccess = true
)

func (VersionGetResponseEnvelopeSuccess) IsKnown 

func (r VersionGetResponseEnvelopeSuccess) IsKnown() bool

type VersionGetResponseRule 

type VersionGetResponseRule struct {
	// The timestamp of when the rule was last modified.
	LastUpdated time.Time `json:"last_updated" api:"required" format:"date-time"`
	// The version of the rule.
	Version string `json:"version" api:"required"`
	// The unique ID of the rule.
	ID string `json:"id"`
	// The action to perform when the rule matches.
	Action VersionGetResponseRulesAction `json:"action"`
	// This field can have the runtime type of [BlockRuleActionParameters],
	// [interface{}], [CompressResponseRuleActionParameters],
	// [ExecuteRuleActionParameters], [LogCustomFieldRuleActionParameters],
	// [RedirectRuleActionParameters], [RewriteRuleActionParameters],
	// [RouteRuleActionParameters], [ScoreRuleActionParameters],
	// [ServeErrorRuleActionParameters],
	// [VersionGetResponseRulesRulesetsSetCacheControlRuleActionParameters],
	// [SetCacheSettingsRuleActionParameters],
	// [VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParameters],
	// [SetConfigRuleActionParameters], [SkipRuleActionParameters].
	ActionParameters interface{} `json:"action_parameters"`
	// This field can have the runtime type of [[]string].
	Categories interface{} `json:"categories"`
	// An informative description of the rule.
	Description string `json:"description"`
	// Whether the rule should be executed.
	Enabled bool `json:"enabled"`
	// This field can have the runtime type of [BlockRuleExposedCredentialCheck],
	// [VersionGetResponseRulesRulesetsChallengeRuleExposedCredentialCheck],
	// [CompressResponseRuleExposedCredentialCheck],
	// [DDoSDynamicRuleExposedCredentialCheck], [ExecuteRuleExposedCredentialCheck],
	// [ForceConnectionCloseRuleExposedCredentialCheck],
	// [VersionGetResponseRulesRulesetsJSChallengeRuleExposedCredentialCheck],
	// [LogRuleExposedCredentialCheck], [LogCustomFieldRuleExposedCredentialCheck],
	// [ManagedChallengeRuleExposedCredentialCheck],
	// [RedirectRuleExposedCredentialCheck], [RewriteRuleExposedCredentialCheck],
	// [RouteRuleExposedCredentialCheck], [ScoreRuleExposedCredentialCheck],
	// [ServeErrorRuleExposedCredentialCheck],
	// [VersionGetResponseRulesRulesetsSetCacheControlRuleExposedCredentialCheck],
	// [SetCacheSettingsRuleExposedCredentialCheck],
	// [VersionGetResponseRulesRulesetsSetCacheTagsRuleExposedCredentialCheck],
	// [SetConfigRuleExposedCredentialCheck], [SkipRuleExposedCredentialCheck].
	ExposedCredentialCheck interface{} `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression string `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging Logging `json:"logging"`
	// This field can have the runtime type of [BlockRuleRatelimit],
	// [VersionGetResponseRulesRulesetsChallengeRuleRatelimit],
	// [CompressResponseRuleRatelimit], [DDoSDynamicRuleRatelimit],
	// [ExecuteRuleRatelimit], [ForceConnectionCloseRuleRatelimit],
	// [VersionGetResponseRulesRulesetsJSChallengeRuleRatelimit], [LogRuleRatelimit],
	// [LogCustomFieldRuleRatelimit], [ManagedChallengeRuleRatelimit],
	// [RedirectRuleRatelimit], [RewriteRuleRatelimit], [RouteRuleRatelimit],
	// [ScoreRuleRatelimit], [ServeErrorRuleRatelimit],
	// [VersionGetResponseRulesRulesetsSetCacheControlRuleRatelimit],
	// [SetCacheSettingsRuleRatelimit],
	// [VersionGetResponseRulesRulesetsSetCacheTagsRuleRatelimit],
	// [SetConfigRuleRatelimit], [SkipRuleRatelimit].
	Ratelimit interface{} `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                     `json:"ref"`
	JSON versionGetResponseRuleJSON `json:"-"`
	// contains filtered or unexported fields
}

func (VersionGetResponseRule) AsUnion 

func (r VersionGetResponseRule) AsUnion() VersionGetResponseRulesUnion

AsUnion returns a VersionGetResponseRulesUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are BlockRule, VersionGetResponseRulesRulesetsChallengeRule, CompressResponseRule, DDoSDynamicRule, ExecuteRule, ForceConnectionCloseRule, VersionGetResponseRulesRulesetsJSChallengeRule, LogRule, LogCustomFieldRule, ManagedChallengeRule, RedirectRule, RewriteRule, RouteRule, ScoreRule, ServeErrorRule, VersionGetResponseRulesRulesetsSetCacheControlRule, SetCacheSettingsRule, VersionGetResponseRulesRulesetsSetCacheTagsRule, SetConfigRule, SkipRule.

func (*VersionGetResponseRule) UnmarshalJSON 

func (r *VersionGetResponseRule) UnmarshalJSON(data []byte) (err error)

type VersionGetResponseRulesAction 

type VersionGetResponseRulesAction string

The action to perform when the rule matches. 

const (
	VersionGetResponseRulesActionBlock                VersionGetResponseRulesAction = "block"
	VersionGetResponseRulesActionChallenge            VersionGetResponseRulesAction = "challenge"
	VersionGetResponseRulesActionCompressResponse     VersionGetResponseRulesAction = "compress_response"
	VersionGetResponseRulesActionDDoSDynamic          VersionGetResponseRulesAction = "ddos_dynamic"
	VersionGetResponseRulesActionExecute              VersionGetResponseRulesAction = "execute"
	VersionGetResponseRulesActionForceConnectionClose VersionGetResponseRulesAction = "force_connection_close"
	VersionGetResponseRulesActionJSChallenge          VersionGetResponseRulesAction = "js_challenge"
	VersionGetResponseRulesActionLog                  VersionGetResponseRulesAction = "log"
	VersionGetResponseRulesActionLogCustomField       VersionGetResponseRulesAction = "log_custom_field"
	VersionGetResponseRulesActionManagedChallenge     VersionGetResponseRulesAction = "managed_challenge"
	VersionGetResponseRulesActionRedirect             VersionGetResponseRulesAction = "redirect"
	VersionGetResponseRulesActionRewrite              VersionGetResponseRulesAction = "rewrite"
	VersionGetResponseRulesActionRoute                VersionGetResponseRulesAction = "route"
	VersionGetResponseRulesActionScore                VersionGetResponseRulesAction = "score"
	VersionGetResponseRulesActionServeError           VersionGetResponseRulesAction = "serve_error"
	VersionGetResponseRulesActionSetCacheControl      VersionGetResponseRulesAction = "set_cache_control"
	VersionGetResponseRulesActionSetCacheSettings     VersionGetResponseRulesAction = "set_cache_settings"
	VersionGetResponseRulesActionSetCacheTags         VersionGetResponseRulesAction = "set_cache_tags"
	VersionGetResponseRulesActionSetConfig            VersionGetResponseRulesAction = "set_config"
	VersionGetResponseRulesActionSkip                 VersionGetResponseRulesAction = "skip"
)

func (VersionGetResponseRulesAction) IsKnown 

func (r VersionGetResponseRulesAction) IsKnown() bool

type VersionGetResponseRulesRulesetsChallengeRule 

type VersionGetResponseRulesRulesetsChallengeRule struct {
	// The timestamp of when the rule was last modified.
	LastUpdated time.Time `json:"last_updated" api:"required" format:"date-time"`
	// The version of the rule.
	Version string `json:"version" api:"required"`
	// The unique ID of the rule.
	ID string `json:"id"`
	// The action to perform when the rule matches.
	Action VersionGetResponseRulesRulesetsChallengeRuleAction `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters interface{} `json:"action_parameters"`
	// The categories of the rule.
	Categories []string `json:"categories"`
	// An informative description of the rule.
	Description string `json:"description"`
	// Whether the rule should be executed.
	Enabled bool `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck VersionGetResponseRulesRulesetsChallengeRuleExposedCredentialCheck `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression string `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging Logging `json:"logging"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit VersionGetResponseRulesRulesetsChallengeRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                                           `json:"ref"`
	JSON versionGetResponseRulesRulesetsChallengeRuleJSON `json:"-"`
}

func (*VersionGetResponseRulesRulesetsChallengeRule) UnmarshalJSON 

func (r *VersionGetResponseRulesRulesetsChallengeRule) UnmarshalJSON(data []byte) (err error)

type VersionGetResponseRulesRulesetsChallengeRuleAction 

type VersionGetResponseRulesRulesetsChallengeRuleAction string

The action to perform when the rule matches. 

const (
	VersionGetResponseRulesRulesetsChallengeRuleActionChallenge VersionGetResponseRulesRulesetsChallengeRuleAction = "challenge"
)

func (VersionGetResponseRulesRulesetsChallengeRuleAction) IsKnown 

func (r VersionGetResponseRulesRulesetsChallengeRuleAction) IsKnown() bool

type VersionGetResponseRulesRulesetsChallengeRuleExposedCredentialCheck 

type VersionGetResponseRulesRulesetsChallengeRuleExposedCredentialCheck struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression string `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression string                                                                 `json:"username_expression" api:"required"`
	JSON               versionGetResponseRulesRulesetsChallengeRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*VersionGetResponseRulesRulesetsChallengeRuleExposedCredentialCheck) UnmarshalJSON 

func (r *VersionGetResponseRulesRulesetsChallengeRuleExposedCredentialCheck) UnmarshalJSON(data []byte) (err error)

type VersionGetResponseRulesRulesetsChallengeRuleRatelimit 

type VersionGetResponseRulesRulesetsChallengeRuleRatelimit struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics []string `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period int64 `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression string `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout int64 `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod int64 `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin bool `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod int64 `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName string                                                    `json:"score_response_header_name"`
	JSON                    versionGetResponseRulesRulesetsChallengeRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*VersionGetResponseRulesRulesetsChallengeRuleRatelimit) UnmarshalJSON 

func (r *VersionGetResponseRulesRulesetsChallengeRuleRatelimit) UnmarshalJSON(data []byte) (err error)

type VersionGetResponseRulesRulesetsJSChallengeRule 

type VersionGetResponseRulesRulesetsJSChallengeRule struct {
	// The timestamp of when the rule was last modified.
	LastUpdated time.Time `json:"last_updated" api:"required" format:"date-time"`
	// The version of the rule.
	Version string `json:"version" api:"required"`
	// The unique ID of the rule.
	ID string `json:"id"`
	// The action to perform when the rule matches.
	Action VersionGetResponseRulesRulesetsJSChallengeRuleAction `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters interface{} `json:"action_parameters"`
	// The categories of the rule.
	Categories []string `json:"categories"`
	// An informative description of the rule.
	Description string `json:"description"`
	// Whether the rule should be executed.
	Enabled bool `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck VersionGetResponseRulesRulesetsJSChallengeRuleExposedCredentialCheck `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression string `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging Logging `json:"logging"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit VersionGetResponseRulesRulesetsJSChallengeRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                                             `json:"ref"`
	JSON versionGetResponseRulesRulesetsJSChallengeRuleJSON `json:"-"`
}

func (*VersionGetResponseRulesRulesetsJSChallengeRule) UnmarshalJSON 

func (r *VersionGetResponseRulesRulesetsJSChallengeRule) UnmarshalJSON(data []byte) (err error)

type VersionGetResponseRulesRulesetsJSChallengeRuleAction 

type VersionGetResponseRulesRulesetsJSChallengeRuleAction string

The action to perform when the rule matches. 

const (
	VersionGetResponseRulesRulesetsJSChallengeRuleActionJSChallenge VersionGetResponseRulesRulesetsJSChallengeRuleAction = "js_challenge"
)

func (VersionGetResponseRulesRulesetsJSChallengeRuleAction) IsKnown 

func (r VersionGetResponseRulesRulesetsJSChallengeRuleAction) IsKnown() bool

type VersionGetResponseRulesRulesetsJSChallengeRuleExposedCredentialCheck 

type VersionGetResponseRulesRulesetsJSChallengeRuleExposedCredentialCheck struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression string `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression string                                                                   `json:"username_expression" api:"required"`
	JSON               versionGetResponseRulesRulesetsJSChallengeRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*VersionGetResponseRulesRulesetsJSChallengeRuleExposedCredentialCheck) UnmarshalJSON 

func (r *VersionGetResponseRulesRulesetsJSChallengeRuleExposedCredentialCheck) UnmarshalJSON(data []byte) (err error)

type VersionGetResponseRulesRulesetsJSChallengeRuleRatelimit 

type VersionGetResponseRulesRulesetsJSChallengeRuleRatelimit struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics []string `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period int64 `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression string `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout int64 `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod int64 `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin bool `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod int64 `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName string                                                      `json:"score_response_header_name"`
	JSON                    versionGetResponseRulesRulesetsJSChallengeRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*VersionGetResponseRulesRulesetsJSChallengeRuleRatelimit) UnmarshalJSON 

func (r *VersionGetResponseRulesRulesetsJSChallengeRuleRatelimit) UnmarshalJSON(data []byte) (err error)

type VersionGetResponseRulesRulesetsSetCacheControlRule added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRule struct {
	// The timestamp of when the rule was last modified.
	LastUpdated time.Time `json:"last_updated" api:"required" format:"date-time"`
	// The version of the rule.
	Version string `json:"version" api:"required"`
	// The unique ID of the rule.
	ID string `json:"id"`
	// The action to perform when the rule matches.
	Action VersionGetResponseRulesRulesetsSetCacheControlRuleAction `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters VersionGetResponseRulesRulesetsSetCacheControlRuleActionParameters `json:"action_parameters"`
	// The categories of the rule.
	Categories []string `json:"categories"`
	// An informative description of the rule.
	Description string `json:"description"`
	// Whether the rule should be executed.
	Enabled bool `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck VersionGetResponseRulesRulesetsSetCacheControlRuleExposedCredentialCheck `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression string `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging Logging `json:"logging"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit VersionGetResponseRulesRulesetsSetCacheControlRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                                                 `json:"ref"`
	JSON versionGetResponseRulesRulesetsSetCacheControlRuleJSON `json:"-"`
}

func (*VersionGetResponseRulesRulesetsSetCacheControlRule) UnmarshalJSON added in v6.9.0 

func (r *VersionGetResponseRulesRulesetsSetCacheControlRule) UnmarshalJSON(data []byte) (err error)

type VersionGetResponseRulesRulesetsSetCacheControlRuleAction added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleAction string

The action to perform when the rule matches. 

const (
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionSetCacheControl VersionGetResponseRulesRulesetsSetCacheControlRuleAction = "set_cache_control"
)

func (VersionGetResponseRulesRulesetsSetCacheControlRuleAction) IsKnown added in v6.9.0 

func (r VersionGetResponseRulesRulesetsSetCacheControlRuleAction) IsKnown() bool

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParameters added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParameters struct {
	// A cache-control directive configuration.
	Immutable VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutable `json:"immutable"`
	// A cache-control directive configuration that accepts a duration value in
	// seconds.
	MaxAge VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAge `json:"max-age"`
	// A cache-control directive configuration.
	MustRevalidate VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate `json:"must-revalidate"`
	// A cache-control directive configuration.
	MustUnderstand VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand `json:"must-understand"`
	// A cache-control directive configuration that accepts optional qualifiers (header
	// names).
	NoCache VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCache `json:"no-cache"`
	// A cache-control directive configuration.
	NoStore VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStore `json:"no-store"`
	// A cache-control directive configuration.
	NoTransform VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransform `json:"no-transform"`
	// A cache-control directive configuration that accepts optional qualifiers (header
	// names).
	Private VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivate `json:"private"`
	// A cache-control directive configuration.
	ProxyRevalidate VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate `json:"proxy-revalidate"`
	// A cache-control directive configuration.
	Public VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublic `json:"public"`
	// A cache-control directive configuration that accepts a duration value in
	// seconds.
	SMaxage VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxage `json:"s-maxage"`
	// A cache-control directive configuration that accepts a duration value in
	// seconds.
	StaleIfError VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfError `json:"stale-if-error"`
	// A cache-control directive configuration that accepts a duration value in
	// seconds.
	StaleWhileRevalidate VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate `json:"stale-while-revalidate"`
	JSON                 versionGetResponseRulesRulesetsSetCacheControlRuleActionParametersJSON                 `json:"-"`
}

The parameters configuring the rule's action.

func (*VersionGetResponseRulesRulesetsSetCacheControlRuleActionParameters) UnmarshalJSON added in v6.9.0 

func (r *VersionGetResponseRulesRulesetsSetCacheControlRuleActionParameters) UnmarshalJSON(data []byte) (err error)

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutable added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutable struct {
	// The operation to perform on the cache-control directive.
	Operation VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                            `json:"cloudflare_only"`
	JSON           versionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration.

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutable) AsUnion added in v6.9.0 

func (r VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutable) AsUnion() VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableUnion

AsUnion returns a VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective, VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective.

func (*VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutable) UnmarshalJSON added in v6.9.0 

func (r *VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutable) UnmarshalJSON(data []byte) (err error)

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation string

The operation to perform on the cache-control directive. 

const (
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperationSet    VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation = "set"
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperationRemove VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation = "remove"
)

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation) IsKnown added in v6.9.0 

func (r VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation) IsKnown() bool

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                           `json:"cloudflare_only"`
	JSON           versionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective) UnmarshalJSON added in v6.9.0 

func (r *VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective) UnmarshalJSON(data []byte) (err error)

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperationSet    VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation = "set"
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperationRemove VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation = "remove"
)

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation) IsKnown() bool

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                        `json:"cloudflare_only"`
	JSON           versionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveJSON `json:"-"`
}

Set the directive.

func (*VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective) UnmarshalJSON added in v6.9.0 

func (r *VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective) UnmarshalJSON(data []byte) (err error)

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperationSet    VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation = "set"
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperationRemove VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation = "remove"
)

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation) IsKnown added in v6.9.0 

func (r VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation) IsKnown() bool

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableUnion added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Union satisfied by VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective or VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective.

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAge added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAge struct {
	// The operation to perform on the cache-control directive.
	Operation VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool `json:"cloudflare_only"`
	// The duration value in seconds for the directive.
	Value int64                                                                        `json:"value"`
	JSON  versionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration that accepts a duration value in seconds.

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAge) AsUnion added in v6.9.0 

func (r VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAge) AsUnion() VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeUnion

AsUnion returns a VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective, VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective.

func (*VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAge) UnmarshalJSON added in v6.9.0 

func (r *VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAge) UnmarshalJSON(data []byte) (err error)

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation string

The operation to perform on the cache-control directive. 

const (
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperationSet    VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation = "set"
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperationRemove VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation = "remove"
)

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation) IsKnown added in v6.9.0 

func (r VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation) IsKnown() bool

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                        `json:"cloudflare_only"`
	JSON           versionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective) UnmarshalJSON added in v6.9.0 

func (r *VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective) UnmarshalJSON(data []byte) (err error)

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperationSet    VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation = "set"
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperationRemove VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation = "remove"
)

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation) IsKnown() bool

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation `json:"operation" api:"required"`
	// The duration value in seconds for the directive.
	Value int64 `json:"value" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                     `json:"cloudflare_only"`
	JSON           versionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveJSON `json:"-"`
}

Set the directive with a duration value in seconds.

func (*VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective) UnmarshalJSON added in v6.9.0 

func (r *VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective) UnmarshalJSON(data []byte) (err error)

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperationSet    VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation = "set"
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperationRemove VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation = "remove"
)

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation) IsKnown added in v6.9.0 

func (r VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation) IsKnown() bool

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeUnion added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts a duration value in seconds.

Union satisfied by VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective or VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective.

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate struct {
	// The operation to perform on the cache-control directive.
	Operation VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                 `json:"cloudflare_only"`
	JSON           versionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration.

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate) AsUnion added in v6.9.0 

func (r VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate) AsUnion() VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateUnion

AsUnion returns a VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective, VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective.

func (*VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate) UnmarshalJSON added in v6.9.0 

func (r *VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate) UnmarshalJSON(data []byte) (err error)

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation string

The operation to perform on the cache-control directive. 

const (
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperationSet    VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation = "set"
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperationRemove VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation = "remove"
)

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation) IsKnown added in v6.9.0 

func (r VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation) IsKnown() bool

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                                `json:"cloudflare_only"`
	JSON           versionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective) UnmarshalJSON added in v6.9.0 

func (r *VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective) UnmarshalJSON(data []byte) (err error)

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperationSet    VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation = "set"
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperationRemove VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation = "remove"
)

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation) IsKnown() bool

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                             `json:"cloudflare_only"`
	JSON           versionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveJSON `json:"-"`
}

Set the directive.

func (*VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective) UnmarshalJSON added in v6.9.0 

func (r *VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective) UnmarshalJSON(data []byte) (err error)

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperationSet    VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation = "set"
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperationRemove VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation = "remove"
)

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation) IsKnown added in v6.9.0 

func (r VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation) IsKnown() bool

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateUnion added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Union satisfied by VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective or VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective.

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand struct {
	// The operation to perform on the cache-control directive.
	Operation VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                 `json:"cloudflare_only"`
	JSON           versionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration.

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand) AsUnion added in v6.9.0 

func (r VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand) AsUnion() VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandUnion

AsUnion returns a VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective, VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective.

func (*VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand) UnmarshalJSON added in v6.9.0 

func (r *VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand) UnmarshalJSON(data []byte) (err error)

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation string

The operation to perform on the cache-control directive. 

const (
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperationSet    VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation = "set"
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperationRemove VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation = "remove"
)

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation) IsKnown added in v6.9.0 

func (r VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation) IsKnown() bool

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                                `json:"cloudflare_only"`
	JSON           versionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective) UnmarshalJSON added in v6.9.0 

func (r *VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective) UnmarshalJSON(data []byte) (err error)

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperationSet    VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation = "set"
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperationRemove VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation = "remove"
)

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation) IsKnown() bool

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                             `json:"cloudflare_only"`
	JSON           versionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveJSON `json:"-"`
}

Set the directive.

func (*VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective) UnmarshalJSON added in v6.9.0 

func (r *VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective) UnmarshalJSON(data []byte) (err error)

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperationSet    VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation = "set"
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperationRemove VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation = "remove"
)

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation) IsKnown added in v6.9.0 

func (r VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation) IsKnown() bool

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandUnion added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Union satisfied by VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective or VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective.

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCache added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCache struct {
	// The operation to perform on the cache-control directive.
	Operation VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool `json:"cloudflare_only"`
	// This field can have the runtime type of [[]string].
	Qualifiers interface{}                                                                   `json:"qualifiers"`
	JSON       versionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration that accepts optional qualifiers (header names).

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCache) AsUnion added in v6.9.0 

func (r VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCache) AsUnion() VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheUnion

AsUnion returns a VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective, VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective.

func (*VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCache) UnmarshalJSON added in v6.9.0 

func (r *VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCache) UnmarshalJSON(data []byte) (err error)

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation string

The operation to perform on the cache-control directive. 

const (
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperationSet    VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation = "set"
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperationRemove VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation = "remove"
)

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation) IsKnown added in v6.9.0 

func (r VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation) IsKnown() bool

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                         `json:"cloudflare_only"`
	JSON           versionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective) UnmarshalJSON added in v6.9.0 

func (r *VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective) UnmarshalJSON(data []byte) (err error)

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperationSet    VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation = "set"
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperationRemove VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation = "remove"
)

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation) IsKnown() bool

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool `json:"cloudflare_only"`
	// Optional list of header names to qualify the directive (e.g., for "private" or
	// "no-cache" directives).
	Qualifiers []string                                                                                  `json:"qualifiers"`
	JSON       versionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveJSON `json:"-"`
}

Set the directive with optional qualifiers.

func (*VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective) UnmarshalJSON added in v6.9.0 

func (r *VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective) UnmarshalJSON(data []byte) (err error)

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperationSet    VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation = "set"
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperationRemove VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation = "remove"
)

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation) IsKnown added in v6.9.0 

func (r VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation) IsKnown() bool

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheUnion added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts optional qualifiers (header names).

Union satisfied by VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective or VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective.

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStore added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStore struct {
	// The operation to perform on the cache-control directive.
	Operation VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                          `json:"cloudflare_only"`
	JSON           versionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration.

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStore) AsUnion added in v6.9.0 

func (r VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStore) AsUnion() VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreUnion

AsUnion returns a VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective, VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective.

func (*VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStore) UnmarshalJSON added in v6.9.0 

func (r *VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStore) UnmarshalJSON(data []byte) (err error)

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation string

The operation to perform on the cache-control directive. 

const (
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperationSet    VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation = "set"
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperationRemove VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation = "remove"
)

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation) IsKnown added in v6.9.0 

func (r VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation) IsKnown() bool

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                         `json:"cloudflare_only"`
	JSON           versionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective) UnmarshalJSON added in v6.9.0 

func (r *VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective) UnmarshalJSON(data []byte) (err error)

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperationSet    VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation = "set"
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperationRemove VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation = "remove"
)

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation) IsKnown() bool

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                      `json:"cloudflare_only"`
	JSON           versionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveJSON `json:"-"`
}

Set the directive.

func (*VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective) UnmarshalJSON added in v6.9.0 

func (r *VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective) UnmarshalJSON(data []byte) (err error)

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperationSet    VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation = "set"
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperationRemove VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation = "remove"
)

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation) IsKnown added in v6.9.0 

func (r VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation) IsKnown() bool

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreUnion added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Union satisfied by VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective or VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective.

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransform added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransform struct {
	// The operation to perform on the cache-control directive.
	Operation VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                              `json:"cloudflare_only"`
	JSON           versionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration.

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransform) AsUnion added in v6.9.0 

func (r VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransform) AsUnion() VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformUnion

AsUnion returns a VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective, VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective.

func (*VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransform) UnmarshalJSON added in v6.9.0 

func (r *VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransform) UnmarshalJSON(data []byte) (err error)

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation string

The operation to perform on the cache-control directive. 

const (
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperationSet    VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation = "set"
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperationRemove VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation = "remove"
)

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation) IsKnown added in v6.9.0 

func (r VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation) IsKnown() bool

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                             `json:"cloudflare_only"`
	JSON           versionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective) UnmarshalJSON added in v6.9.0 

func (r *VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective) UnmarshalJSON(data []byte) (err error)

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperationSet    VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation = "set"
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperationRemove VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation = "remove"
)

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation) IsKnown() bool

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                          `json:"cloudflare_only"`
	JSON           versionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveJSON `json:"-"`
}

Set the directive.

func (*VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective) UnmarshalJSON added in v6.9.0 

func (r *VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective) UnmarshalJSON(data []byte) (err error)

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperationSet    VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation = "set"
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperationRemove VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation = "remove"
)

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation) IsKnown added in v6.9.0 

func (r VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation) IsKnown() bool

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformUnion added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Union satisfied by VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective or VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective.

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivate added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivate struct {
	// The operation to perform on the cache-control directive.
	Operation VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool `json:"cloudflare_only"`
	// This field can have the runtime type of [[]string].
	Qualifiers interface{}                                                                   `json:"qualifiers"`
	JSON       versionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration that accepts optional qualifiers (header names).

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivate) AsUnion added in v6.9.0 

func (r VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivate) AsUnion() VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateUnion

AsUnion returns a VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective, VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective.

func (*VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivate) UnmarshalJSON added in v6.9.0 

func (r *VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivate) UnmarshalJSON(data []byte) (err error)

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation string

The operation to perform on the cache-control directive. 

const (
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperationSet    VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation = "set"
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperationRemove VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation = "remove"
)

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation) IsKnown added in v6.9.0 

func (r VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation) IsKnown() bool

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                         `json:"cloudflare_only"`
	JSON           versionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective) UnmarshalJSON added in v6.9.0 

func (r *VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective) UnmarshalJSON(data []byte) (err error)

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperationSet    VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation = "set"
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperationRemove VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation = "remove"
)

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation) IsKnown() bool

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool `json:"cloudflare_only"`
	// Optional list of header names to qualify the directive (e.g., for "private" or
	// "no-cache" directives).
	Qualifiers []string                                                                                  `json:"qualifiers"`
	JSON       versionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveJSON `json:"-"`
}

Set the directive with optional qualifiers.

func (*VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective) UnmarshalJSON added in v6.9.0 

func (r *VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective) UnmarshalJSON(data []byte) (err error)

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperationSet    VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation = "set"
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperationRemove VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation = "remove"
)

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation) IsKnown added in v6.9.0 

func (r VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation) IsKnown() bool

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateUnion added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts optional qualifiers (header names).

Union satisfied by VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective or VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective.

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate struct {
	// The operation to perform on the cache-control directive.
	Operation VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                  `json:"cloudflare_only"`
	JSON           versionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration.

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate) AsUnion added in v6.9.0 

func (r VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate) AsUnion() VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateUnion

AsUnion returns a VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective, VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective.

func (*VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate) UnmarshalJSON added in v6.9.0 

func (r *VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate) UnmarshalJSON(data []byte) (err error)

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation string

The operation to perform on the cache-control directive. 

const (
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperationSet    VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation = "set"
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperationRemove VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation = "remove"
)

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation) IsKnown added in v6.9.0 

func (r VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation) IsKnown() bool

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                                 `json:"cloudflare_only"`
	JSON           versionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective) UnmarshalJSON added in v6.9.0 

func (r *VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective) UnmarshalJSON(data []byte) (err error)

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperationSet    VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation = "set"
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperationRemove VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation = "remove"
)

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation) IsKnown() bool

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                              `json:"cloudflare_only"`
	JSON           versionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveJSON `json:"-"`
}

Set the directive.

func (*VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective) UnmarshalJSON added in v6.9.0 

func (r *VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective) UnmarshalJSON(data []byte) (err error)

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperationSet    VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation = "set"
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperationRemove VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation = "remove"
)

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation) IsKnown added in v6.9.0 

func (r VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation) IsKnown() bool

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateUnion added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Union satisfied by VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective or VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective.

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublic added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublic struct {
	// The operation to perform on the cache-control directive.
	Operation VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                         `json:"cloudflare_only"`
	JSON           versionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration.

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublic) AsUnion added in v6.9.0 

func (r VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublic) AsUnion() VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicUnion

AsUnion returns a VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective, VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective.

func (*VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublic) UnmarshalJSON added in v6.9.0 

func (r *VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublic) UnmarshalJSON(data []byte) (err error)

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation string

The operation to perform on the cache-control directive. 

const (
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperationSet    VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation = "set"
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperationRemove VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation = "remove"
)

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation) IsKnown added in v6.9.0 

func (r VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation) IsKnown() bool

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                        `json:"cloudflare_only"`
	JSON           versionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective) UnmarshalJSON added in v6.9.0 

func (r *VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective) UnmarshalJSON(data []byte) (err error)

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperationSet    VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation = "set"
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperationRemove VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation = "remove"
)

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation) IsKnown() bool

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                     `json:"cloudflare_only"`
	JSON           versionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveJSON `json:"-"`
}

Set the directive.

func (*VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective) UnmarshalJSON added in v6.9.0 

func (r *VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective) UnmarshalJSON(data []byte) (err error)

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperationSet    VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation = "set"
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperationRemove VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation = "remove"
)

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation) IsKnown added in v6.9.0 

func (r VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation) IsKnown() bool

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicUnion added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration.

Union satisfied by VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective or VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective.

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxage added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxage struct {
	// The operation to perform on the cache-control directive.
	Operation VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool `json:"cloudflare_only"`
	// The duration value in seconds for the directive.
	Value int64                                                                         `json:"value"`
	JSON  versionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration that accepts a duration value in seconds.

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxage) AsUnion added in v6.9.0 

func (r VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxage) AsUnion() VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageUnion

AsUnion returns a VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective, VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective.

func (*VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxage) UnmarshalJSON added in v6.9.0 

func (r *VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxage) UnmarshalJSON(data []byte) (err error)

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation string

The operation to perform on the cache-control directive. 

const (
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperationSet    VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation = "set"
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperationRemove VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation = "remove"
)

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation) IsKnown added in v6.9.0 

func (r VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation) IsKnown() bool

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                         `json:"cloudflare_only"`
	JSON           versionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective) UnmarshalJSON added in v6.9.0 

func (r *VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective) UnmarshalJSON(data []byte) (err error)

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperationSet    VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation = "set"
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperationRemove VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation = "remove"
)

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation) IsKnown() bool

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation `json:"operation" api:"required"`
	// The duration value in seconds for the directive.
	Value int64 `json:"value" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                      `json:"cloudflare_only"`
	JSON           versionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveJSON `json:"-"`
}

Set the directive with a duration value in seconds.

func (*VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective) UnmarshalJSON added in v6.9.0 

func (r *VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective) UnmarshalJSON(data []byte) (err error)

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperationSet    VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation = "set"
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperationRemove VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation = "remove"
)

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation) IsKnown added in v6.9.0 

func (r VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation) IsKnown() bool

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageUnion added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts a duration value in seconds.

Union satisfied by VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective or VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective.

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfError added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfError struct {
	// The operation to perform on the cache-control directive.
	Operation VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool `json:"cloudflare_only"`
	// The duration value in seconds for the directive.
	Value int64                                                                              `json:"value"`
	JSON  versionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration that accepts a duration value in seconds.

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfError) AsUnion added in v6.9.0 

func (r VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfError) AsUnion() VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorUnion

AsUnion returns a VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective, VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective.

func (*VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfError) UnmarshalJSON added in v6.9.0 

func (r *VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfError) UnmarshalJSON(data []byte) (err error)

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation string

The operation to perform on the cache-control directive. 

const (
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperationSet    VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation = "set"
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperationRemove VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation = "remove"
)

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation) IsKnown added in v6.9.0 

func (r VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation) IsKnown() bool

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                              `json:"cloudflare_only"`
	JSON           versionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective) UnmarshalJSON added in v6.9.0 

func (r *VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective) UnmarshalJSON(data []byte) (err error)

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperationSet    VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation = "set"
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperationRemove VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation = "remove"
)

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation) IsKnown() bool

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation `json:"operation" api:"required"`
	// The duration value in seconds for the directive.
	Value int64 `json:"value" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                           `json:"cloudflare_only"`
	JSON           versionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveJSON `json:"-"`
}

Set the directive with a duration value in seconds.

func (*VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective) UnmarshalJSON added in v6.9.0 

func (r *VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective) UnmarshalJSON(data []byte) (err error)

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperationSet    VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation = "set"
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperationRemove VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation = "remove"
)

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation) IsKnown added in v6.9.0 

func (r VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation) IsKnown() bool

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorUnion added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts a duration value in seconds.

Union satisfied by VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective or VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective.

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate struct {
	// The operation to perform on the cache-control directive.
	Operation VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool `json:"cloudflare_only"`
	// The duration value in seconds for the directive.
	Value int64                                                                                      `json:"value"`
	JSON  versionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateJSON `json:"-"`
	// contains filtered or unexported fields
}

A cache-control directive configuration that accepts a duration value in seconds.

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate) AsUnion added in v6.9.0 

func (r VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate) AsUnion() VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateUnion

AsUnion returns a VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective, VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective.

func (*VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate) UnmarshalJSON added in v6.9.0 

func (r *VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate) UnmarshalJSON(data []byte) (err error)

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation string

The operation to perform on the cache-control directive. 

const (
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperationSet    VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation = "set"
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperationRemove VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation = "remove"
)

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation) IsKnown added in v6.9.0 

func (r VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation) IsKnown() bool

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective struct {
	// The operation to perform on the cache-control directive.
	Operation VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation `json:"operation" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                                      `json:"cloudflare_only"`
	JSON           versionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveJSON `json:"-"`
}

Remove the directive.

func (*VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective) UnmarshalJSON added in v6.9.0 

func (r *VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective) UnmarshalJSON(data []byte) (err error)

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperationSet    VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation = "set"
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperationRemove VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation = "remove"
)

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation) IsKnown added in v6.9.0 

func (r VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation) IsKnown() bool

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation `json:"operation" api:"required"`
	// The duration value in seconds for the directive.
	Value int64 `json:"value" api:"required"`
	// Whether the directive should only be applied to the Cloudflare CDN cache.
	CloudflareOnly bool                                                                                                   `json:"cloudflare_only"`
	JSON           versionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveJSON `json:"-"`
}

Set the directive with a duration value in seconds.

func (*VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective) UnmarshalJSON added in v6.9.0 

func (r *VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective) UnmarshalJSON(data []byte) (err error)

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive. 

const (
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperationSet    VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation = "set"
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperationRemove VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation = "remove"
)

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation) IsKnown added in v6.9.0 

func (r VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation) IsKnown() bool

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateUnion added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateUnion interface {
	// contains filtered or unexported methods
}

A cache-control directive configuration that accepts a duration value in seconds.

Union satisfied by VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective or VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective.

type VersionGetResponseRulesRulesetsSetCacheControlRuleExposedCredentialCheck added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleExposedCredentialCheck struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression string `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression string                                                                       `json:"username_expression" api:"required"`
	JSON               versionGetResponseRulesRulesetsSetCacheControlRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*VersionGetResponseRulesRulesetsSetCacheControlRuleExposedCredentialCheck) UnmarshalJSON added in v6.9.0 

func (r *VersionGetResponseRulesRulesetsSetCacheControlRuleExposedCredentialCheck) UnmarshalJSON(data []byte) (err error)

type VersionGetResponseRulesRulesetsSetCacheControlRuleRatelimit added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheControlRuleRatelimit struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics []string `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period int64 `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression string `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout int64 `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod int64 `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin bool `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod int64 `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName string                                                          `json:"score_response_header_name"`
	JSON                    versionGetResponseRulesRulesetsSetCacheControlRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*VersionGetResponseRulesRulesetsSetCacheControlRuleRatelimit) UnmarshalJSON added in v6.9.0 

func (r *VersionGetResponseRulesRulesetsSetCacheControlRuleRatelimit) UnmarshalJSON(data []byte) (err error)

type VersionGetResponseRulesRulesetsSetCacheTagsRule added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheTagsRule struct {
	// The timestamp of when the rule was last modified.
	LastUpdated time.Time `json:"last_updated" api:"required" format:"date-time"`
	// The version of the rule.
	Version string `json:"version" api:"required"`
	// The unique ID of the rule.
	ID string `json:"id"`
	// The action to perform when the rule matches.
	Action VersionGetResponseRulesRulesetsSetCacheTagsRuleAction `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParameters `json:"action_parameters"`
	// The categories of the rule.
	Categories []string `json:"categories"`
	// An informative description of the rule.
	Description string `json:"description"`
	// Whether the rule should be executed.
	Enabled bool `json:"enabled"`
	// Configuration for exposed credential checking.
	ExposedCredentialCheck VersionGetResponseRulesRulesetsSetCacheTagsRuleExposedCredentialCheck `json:"exposed_credential_check"`
	// The expression defining which traffic will match the rule.
	Expression string `json:"expression"`
	// An object configuring the rule's logging behavior.
	Logging Logging `json:"logging"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit VersionGetResponseRulesRulesetsSetCacheTagsRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                                              `json:"ref"`
	JSON versionGetResponseRulesRulesetsSetCacheTagsRuleJSON `json:"-"`
}

func (*VersionGetResponseRulesRulesetsSetCacheTagsRule) UnmarshalJSON added in v6.9.0 

func (r *VersionGetResponseRulesRulesetsSetCacheTagsRule) UnmarshalJSON(data []byte) (err error)

type VersionGetResponseRulesRulesetsSetCacheTagsRuleAction added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheTagsRuleAction string

The action to perform when the rule matches. 

const (
	VersionGetResponseRulesRulesetsSetCacheTagsRuleActionSetCacheTags VersionGetResponseRulesRulesetsSetCacheTagsRuleAction = "set_cache_tags"
)

func (VersionGetResponseRulesRulesetsSetCacheTagsRuleAction) IsKnown added in v6.9.0 

func (r VersionGetResponseRulesRulesetsSetCacheTagsRuleAction) IsKnown() bool

type VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParameters added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParameters struct {
	// The operation to perform on the cache tags.
	Operation VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation `json:"operation" api:"required"`
	// An expression that evaluates to an array of cache tag values.
	Expression string `json:"expression"`
	// This field can have the runtime type of [[]string].
	Values interface{}                                                         `json:"values"`
	JSON   versionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersJSON `json:"-"`
	// contains filtered or unexported fields
}

The parameters configuring the rule's action.

func (VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParameters) AsUnion added in v6.9.0 

func (r VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParameters) AsUnion() VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersUnion

AsUnion returns a VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues, VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression, VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues, VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression, VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues, VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression.

func (*VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParameters) UnmarshalJSON added in v6.9.0 

func (r *VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParameters) UnmarshalJSON(data []byte) (err error)

type VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression struct {
	// An expression that evaluates to an array of cache tag values.
	Expression string `json:"expression" api:"required"`
	// The operation to perform on the cache tags.
	Operation VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation `json:"operation" api:"required"`
	JSON      versionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionJSON      `json:"-"`
}

Add cache tags using an expression.

func (*VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression) UnmarshalJSON added in v6.9.0 

func (r *VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression) UnmarshalJSON(data []byte) (err error)

type VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation string

The operation to perform on the cache tags. 

const (
	VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationAdd    VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "add"
	VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationRemove VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "remove"
	VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationSet    VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "set"
)

func (VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation) IsKnown added in v6.9.0 

func (r VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation) IsKnown() bool

type VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues struct {
	// The operation to perform on the cache tags.
	Operation VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation `json:"operation" api:"required"`
	// A list of cache tag values.
	Values []string                                                                              `json:"values" api:"required"`
	JSON   versionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesJSON `json:"-"`
}

Add cache tags using a list of values.

func (*VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues) UnmarshalJSON added in v6.9.0 

func (r *VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues) UnmarshalJSON(data []byte) (err error)

type VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation string

The operation to perform on the cache tags. 

const (
	VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationAdd    VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "add"
	VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationRemove VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "remove"
	VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationSet    VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "set"
)

func (VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation) IsKnown added in v6.9.0 

func (r VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation) IsKnown() bool

type VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation string

The operation to perform on the cache tags. 

const (
	VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersOperationAdd    VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation = "add"
	VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersOperationRemove VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation = "remove"
	VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersOperationSet    VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation = "set"
)

func (VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation) IsKnown added in v6.9.0 

func (r VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation) IsKnown() bool

type VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression struct {
	// An expression that evaluates to an array of cache tag values.
	Expression string `json:"expression" api:"required"`
	// The operation to perform on the cache tags.
	Operation VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation `json:"operation" api:"required"`
	JSON      versionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionJSON      `json:"-"`
}

Remove cache tags using an expression.

func (*VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression) UnmarshalJSON added in v6.9.0 

func (r *VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression) UnmarshalJSON(data []byte) (err error)

type VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation string

The operation to perform on the cache tags. 

const (
	VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationAdd    VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "add"
	VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationRemove VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "remove"
	VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationSet    VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "set"
)

func (VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation) IsKnown added in v6.9.0 

func (r VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation) IsKnown() bool

type VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues struct {
	// The operation to perform on the cache tags.
	Operation VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation `json:"operation" api:"required"`
	// A list of cache tag values.
	Values []string                                                                                 `json:"values" api:"required"`
	JSON   versionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesJSON `json:"-"`
}

Remove cache tags using a list of values.

func (*VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues) UnmarshalJSON added in v6.9.0 

func (r *VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues) UnmarshalJSON(data []byte) (err error)

type VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation string

The operation to perform on the cache tags. 

const (
	VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationAdd    VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "add"
	VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationRemove VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "remove"
	VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationSet    VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "set"
)

func (VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation) IsKnown added in v6.9.0 

func (r VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation) IsKnown() bool

type VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression struct {
	// An expression that evaluates to an array of cache tag values.
	Expression string `json:"expression" api:"required"`
	// The operation to perform on the cache tags.
	Operation VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation `json:"operation" api:"required"`
	JSON      versionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionJSON      `json:"-"`
}

Set cache tags using an expression.

func (*VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression) UnmarshalJSON added in v6.9.0 

func (r *VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression) UnmarshalJSON(data []byte) (err error)

type VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation string

The operation to perform on the cache tags. 

const (
	VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationAdd    VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "add"
	VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationRemove VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "remove"
	VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationSet    VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "set"
)

func (VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation) IsKnown added in v6.9.0 

func (r VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation) IsKnown() bool

type VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues struct {
	// The operation to perform on the cache tags.
	Operation VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation `json:"operation" api:"required"`
	// A list of cache tag values.
	Values []string                                                                              `json:"values" api:"required"`
	JSON   versionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesJSON `json:"-"`
}

Set cache tags using a list of values.

func (*VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues) UnmarshalJSON added in v6.9.0 

func (r *VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues) UnmarshalJSON(data []byte) (err error)

type VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation string

The operation to perform on the cache tags. 

const (
	VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationAdd    VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "add"
	VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationRemove VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "remove"
	VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationSet    VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "set"
)

func (VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation) IsKnown added in v6.9.0 

func (r VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation) IsKnown() bool

type VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersUnion added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersUnion interface {
	// contains filtered or unexported methods
}

The parameters configuring the rule's action.

Union satisfied by VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues, VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression, VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues, VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression, VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues or VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression.

type VersionGetResponseRulesRulesetsSetCacheTagsRuleExposedCredentialCheck added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheTagsRuleExposedCredentialCheck struct {
	// An expression that selects the password used in the credentials check.
	PasswordExpression string `json:"password_expression" api:"required"`
	// An expression that selects the user ID used in the credentials check.
	UsernameExpression string                                                                    `json:"username_expression" api:"required"`
	JSON               versionGetResponseRulesRulesetsSetCacheTagsRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*VersionGetResponseRulesRulesetsSetCacheTagsRuleExposedCredentialCheck) UnmarshalJSON added in v6.9.0 

func (r *VersionGetResponseRulesRulesetsSetCacheTagsRuleExposedCredentialCheck) UnmarshalJSON(data []byte) (err error)

type VersionGetResponseRulesRulesetsSetCacheTagsRuleRatelimit added in v6.9.0 

type VersionGetResponseRulesRulesetsSetCacheTagsRuleRatelimit struct {
	// Characteristics of the request on which the rate limit counter will be
	// incremented.
	Characteristics []string `json:"characteristics" api:"required"`
	// Period in seconds over which the counter is being incremented.
	Period int64 `json:"period" api:"required"`
	// An expression that defines when the rate limit counter should be incremented. It
	// defaults to the same as the rule's expression.
	CountingExpression string `json:"counting_expression"`
	// Period of time in seconds after which the action will be disabled following its
	// first execution.
	MitigationTimeout int64 `json:"mitigation_timeout"`
	// The threshold of requests per period after which the action will be executed for
	// the first time.
	RequestsPerPeriod int64 `json:"requests_per_period"`
	// Whether counting is only performed when an origin is reached.
	RequestsToOrigin bool `json:"requests_to_origin"`
	// The score threshold per period for which the action will be executed the first
	// time.
	ScorePerPeriod int64 `json:"score_per_period"`
	// A response header name provided by the origin, which contains the score to
	// increment rate limit counter with.
	ScoreResponseHeaderName string                                                       `json:"score_response_header_name"`
	JSON                    versionGetResponseRulesRulesetsSetCacheTagsRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*VersionGetResponseRulesRulesetsSetCacheTagsRuleRatelimit) UnmarshalJSON added in v6.9.0 

func (r *VersionGetResponseRulesRulesetsSetCacheTagsRuleRatelimit) UnmarshalJSON(data []byte) (err error)

type VersionGetResponseRulesUnion 

type VersionGetResponseRulesUnion interface {
	// contains filtered or unexported methods
}

Union satisfied by BlockRule, VersionGetResponseRulesRulesetsChallengeRule, CompressResponseRule, DDoSDynamicRule, ExecuteRule, ForceConnectionCloseRule, VersionGetResponseRulesRulesetsJSChallengeRule, LogRule, LogCustomFieldRule, ManagedChallengeRule, RedirectRule, RewriteRule, RouteRule, ScoreRule, ServeErrorRule, VersionGetResponseRulesRulesetsSetCacheControlRule, SetCacheSettingsRule, VersionGetResponseRulesRulesetsSetCacheTagsRule, SetConfigRule or SkipRule.

type VersionListParams 

type VersionListParams struct {
	// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
	AccountID param.Field[string] `path:"account_id"`
	// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
	ZoneID param.Field[string] `path:"zone_id"`
}

type VersionListResponse 

type VersionListResponse struct {
	// The unique ID of the ruleset.
	ID string `json:"id" api:"required"`
	// The kind of the ruleset.
	Kind Kind `json:"kind" api:"required"`
	// The timestamp of when the ruleset was last modified.
	LastUpdated time.Time `json:"last_updated" api:"required" format:"date-time"`
	// The human-readable name of the ruleset.
	Name string `json:"name" api:"required"`
	// The phase of the ruleset.
	Phase Phase `json:"phase" api:"required"`
	// The version of the ruleset.
	Version string `json:"version" api:"required"`
	// An informative description of the ruleset.
	Description string                  `json:"description"`
	JSON        versionListResponseJSON `json:"-"`
}

A ruleset object.

func (*VersionListResponse) UnmarshalJSON 

func (r *VersionListResponse) UnmarshalJSON(data []byte) (err error)

type VersionService 

type VersionService struct {
	Options []option.RequestOption
}

VersionService 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 NewVersionService method instead.

func NewVersionService 

func NewVersionService(opts ...option.RequestOption) (r *VersionService)

NewVersionService 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 (*VersionService) Delete 

func (r *VersionService) Delete(ctx context.Context, rulesetID string, rulesetVersion string, body VersionDeleteParams, opts ...option.RequestOption) (err error)

Deletes an existing version of an account or zone ruleset.

func (*VersionService) Get 

func (r *VersionService) Get(ctx context.Context, rulesetID string, rulesetVersion string, query VersionGetParams, opts ...option.RequestOption) (res *VersionGetResponse, err error)

Fetches a specific version of an account or zone ruleset.

func (*VersionService) List 

func (r *VersionService) List(ctx context.Context, rulesetID string, query VersionListParams, opts ...option.RequestOption) (res *pagination.SinglePage[VersionListResponse], err error)

Fetches the versions of an account or zone ruleset.

func (*VersionService) ListAutoPaging 

func (r *VersionService) ListAutoPaging(ctx context.Context, rulesetID string, query VersionListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[VersionListResponse]

Fetches the versions of an account or zone ruleset.

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.