rulesets

package
v7.10.0 Latest Latest
Warning

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

Go to latest
Published: Sep 4, 2026 License: Apache-2.0 Imports: 17 Imported by: 0

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

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

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

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

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

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

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

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

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

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

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

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],
	// [PhaseGetResponseRulesRulesetsTransformResponseHTMLRuleActionParameters].
	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],
	// [PhaseGetResponseRulesRulesetsTransformResponseHTMLRuleExposedCredentialCheck].
	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],
	// [PhaseGetResponseRulesRulesetsTransformResponseHTMLRuleRatelimit].
	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) 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"
	PhaseGetResponseRulesActionTransformResponseHTML PhaseGetResponseRulesAction = "transform_response_html"
)

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

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

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

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

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

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

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

type PhaseGetResponseRulesRulesetsSetCacheControlRuleAction

type PhaseGetResponseRulesRulesetsSetCacheControlRuleAction string

The action to perform when the rule matches.

const (
	PhaseGetResponseRulesRulesetsSetCacheControlRuleActionSetCacheControl PhaseGetResponseRulesRulesetsSetCacheControlRuleAction = "set_cache_control"
)

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleAction) IsKnown

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParameters

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

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutable

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) UnmarshalJSON

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation string

The operation to perform on the cache-control directive.

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

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation) IsKnown

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective

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

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

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

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation) IsKnown

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective

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

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation string

The operation to perform on the cache-control directive.

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

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation) IsKnown

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableUnion

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

A cache-control directive configuration.

Union satisfied by PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective or PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective.

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAge

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) UnmarshalJSON

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation string

The operation to perform on the cache-control directive.

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

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation) IsKnown

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective

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

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

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

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation) IsKnown

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective

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

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation string

The operation to perform on the cache-control directive.

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

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation) IsKnown

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeUnion

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

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) UnmarshalJSON

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation string

The operation to perform on the cache-control directive.

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

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation) IsKnown

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective

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

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

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

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation) IsKnown

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective

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

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive.

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

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation) IsKnown

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateUnion

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

A cache-control directive configuration.

Union satisfied by PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective or PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective.

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand

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) UnmarshalJSON

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation string

The operation to perform on the cache-control directive.

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

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation) IsKnown

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective

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

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

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

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation) IsKnown

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective

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

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation string

The operation to perform on the cache-control directive.

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

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation) IsKnown

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandUnion

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

A cache-control directive configuration.

Union satisfied by PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective or PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective.

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCache

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) UnmarshalJSON

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation string

The operation to perform on the cache-control directive.

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

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation) IsKnown

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective

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

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

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

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation) IsKnown

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective

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

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation string

The operation to perform on the cache-control directive.

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

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation) IsKnown

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheUnion

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

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) UnmarshalJSON

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation string

The operation to perform on the cache-control directive.

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

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation) IsKnown

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective

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

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

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

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation) IsKnown

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective

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

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation string

The operation to perform on the cache-control directive.

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

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation) IsKnown

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreUnion

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

A cache-control directive configuration.

Union satisfied by PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective or PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective.

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransform

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) UnmarshalJSON

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation string

The operation to perform on the cache-control directive.

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

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation) IsKnown

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective

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

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

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

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation) IsKnown

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective

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

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation string

The operation to perform on the cache-control directive.

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

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation) IsKnown

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformUnion

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

A cache-control directive configuration.

Union satisfied by PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective or PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective.

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivate

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) UnmarshalJSON

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation string

The operation to perform on the cache-control directive.

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

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation) IsKnown

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective

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

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

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

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation) IsKnown

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective

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

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation string

The operation to perform on the cache-control directive.

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

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation) IsKnown

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateUnion

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

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) UnmarshalJSON

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation string

The operation to perform on the cache-control directive.

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

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation) IsKnown

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective

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

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

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

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation) IsKnown

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective

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

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive.

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

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation) IsKnown

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateUnion

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

A cache-control directive configuration.

Union satisfied by PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective or PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective.

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublic

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) UnmarshalJSON

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation string

The operation to perform on the cache-control directive.

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

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation) IsKnown

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective

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

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

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

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation) IsKnown

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective

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

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation string

The operation to perform on the cache-control directive.

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

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation) IsKnown

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicUnion

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

A cache-control directive configuration.

Union satisfied by PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective or PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective.

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxage

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) UnmarshalJSON

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation string

The operation to perform on the cache-control directive.

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

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation) IsKnown

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective

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

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

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

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation) IsKnown

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective

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

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation string

The operation to perform on the cache-control directive.

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

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation) IsKnown

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageUnion

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

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) UnmarshalJSON

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation string

The operation to perform on the cache-control directive.

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

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation) IsKnown

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective

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

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

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

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation) IsKnown

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective

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

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation string

The operation to perform on the cache-control directive.

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

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation) IsKnown

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorUnion

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

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) UnmarshalJSON

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation string

The operation to perform on the cache-control directive.

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

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation) IsKnown

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective

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

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

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

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation) IsKnown

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective

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

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive.

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

func (PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation) IsKnown

type PhaseGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateUnion

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

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

type PhaseGetResponseRulesRulesetsSetCacheControlRuleRatelimit

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

type PhaseGetResponseRulesRulesetsSetCacheTagsRule

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

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

type PhaseGetResponseRulesRulesetsSetCacheTagsRuleAction

type PhaseGetResponseRulesRulesetsSetCacheTagsRuleAction string

The action to perform when the rule matches.

const (
	PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionSetCacheTags PhaseGetResponseRulesRulesetsSetCacheTagsRuleAction = "set_cache_tags"
)

func (PhaseGetResponseRulesRulesetsSetCacheTagsRuleAction) IsKnown

type PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParameters

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) UnmarshalJSON

type PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression

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

type PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation

type PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation string

The operation to perform on the cache tags.

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

func (PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation) IsKnown

type PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues

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

type PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation

type PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation string

The operation to perform on the cache tags.

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

func (PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation) IsKnown

type PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation

type PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation string

The operation to perform on the cache tags.

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

func (PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation) IsKnown

type PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression

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

type PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation

type PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation string

The operation to perform on the cache tags.

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

func (PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation) IsKnown

type PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues

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

type PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation

type PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation string

The operation to perform on the cache tags.

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

func (PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation) IsKnown

type PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression

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

type PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation

type PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation string

The operation to perform on the cache tags.

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

func (PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation) IsKnown

type PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues

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

type PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation

type PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation string

The operation to perform on the cache tags.

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

func (PhaseGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation) IsKnown

type PhaseGetResponseRulesRulesetsSetCacheTagsRuleExposedCredentialCheck

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

type PhaseGetResponseRulesRulesetsSetCacheTagsRuleRatelimit

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

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

type PhaseGetResponseRulesRulesetsTransformResponseHTMLRule added in v7.7.0

type PhaseGetResponseRulesRulesetsTransformResponseHTMLRule 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 PhaseGetResponseRulesRulesetsTransformResponseHTMLRuleAction `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters PhaseGetResponseRulesRulesetsTransformResponseHTMLRuleActionParameters `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 PhaseGetResponseRulesRulesetsTransformResponseHTMLRuleExposedCredentialCheck `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 PhaseGetResponseRulesRulesetsTransformResponseHTMLRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                                                     `json:"ref"`
	JSON phaseGetResponseRulesRulesetsTransformResponseHTMLRuleJSON `json:"-"`
}

func (*PhaseGetResponseRulesRulesetsTransformResponseHTMLRule) UnmarshalJSON added in v7.7.0

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

type PhaseGetResponseRulesRulesetsTransformResponseHTMLRuleAction added in v7.7.0

type PhaseGetResponseRulesRulesetsTransformResponseHTMLRuleAction string

The action to perform when the rule matches.

const (
	PhaseGetResponseRulesRulesetsTransformResponseHTMLRuleActionTransformResponseHTML PhaseGetResponseRulesRulesetsTransformResponseHTMLRuleAction = "transform_response_html"
)

func (PhaseGetResponseRulesRulesetsTransformResponseHTMLRuleAction) IsKnown added in v7.7.0

type PhaseGetResponseRulesRulesetsTransformResponseHTMLRuleActionParameters added in v7.7.0

type PhaseGetResponseRulesRulesetsTransformResponseHTMLRuleActionParameters struct {
	// Enables the link maze transformation on the response.
	LinkMaze interface{}                                                                `json:"link_maze" api:"required"`
	JSON     phaseGetResponseRulesRulesetsTransformResponseHTMLRuleActionParametersJSON `json:"-"`
}

The parameters configuring the rule's action.

func (*PhaseGetResponseRulesRulesetsTransformResponseHTMLRuleActionParameters) UnmarshalJSON added in v7.7.0

type PhaseGetResponseRulesRulesetsTransformResponseHTMLRuleExposedCredentialCheck added in v7.7.0

type PhaseGetResponseRulesRulesetsTransformResponseHTMLRuleExposedCredentialCheck 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               phaseGetResponseRulesRulesetsTransformResponseHTMLRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*PhaseGetResponseRulesRulesetsTransformResponseHTMLRuleExposedCredentialCheck) UnmarshalJSON added in v7.7.0

type PhaseGetResponseRulesRulesetsTransformResponseHTMLRuleRatelimit added in v7.7.0

type PhaseGetResponseRulesRulesetsTransformResponseHTMLRuleRatelimit 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                    phaseGetResponseRulesRulesetsTransformResponseHTMLRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*PhaseGetResponseRulesRulesetsTransformResponseHTMLRuleRatelimit) UnmarshalJSON added in v7.7.0

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 *PhaseUpdateResponseEnvelopeResult, 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"`
	// Validates the request without persisting changes when set to `true`. Responses
	// that normally return 200 return `result: null`; endpoints that normally return
	// 204 continue to return 204.
	DryRun param.Field[bool] `query:"dry_run"`
	// 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)

func (PhaseUpdateParams) URLQuery added in v7.9.0

func (r PhaseUpdateParams) URLQuery() (v url.Values)

URLQuery serializes PhaseUpdateParams's query parameters as `url.Values`.

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 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"
	PhaseUpdateParamsRulesActionTransformResponseHTML PhaseUpdateParamsRulesAction = "transform_response_html"
)

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

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

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

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

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

type PhaseUpdateParamsRulesRulesetsSetCacheControlRule

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

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

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleAction

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleAction string

The action to perform when the rule matches.

const (
	PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionSetCacheControl PhaseUpdateParamsRulesRulesetsSetCacheControlRuleAction = "set_cache_control"
)

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleAction) IsKnown

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParameters

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

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutable

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

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation string

The operation to perform on the cache-control directive.

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

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation) IsKnown

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective

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

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

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

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation) IsKnown

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective

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

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation string

The operation to perform on the cache-control directive.

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

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation) IsKnown

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAge

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

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation string

The operation to perform on the cache-control directive.

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

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation) IsKnown

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective

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

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

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

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation) IsKnown

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective

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

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation string

The operation to perform on the cache-control directive.

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

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation) IsKnown

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeUnion

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

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

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation string

The operation to perform on the cache-control directive.

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

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation) IsKnown

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective

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

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

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

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation) IsKnown

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective

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

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive.

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

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation) IsKnown

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand

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

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation string

The operation to perform on the cache-control directive.

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

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation) IsKnown

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective

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

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

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

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation) IsKnown

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective

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

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation string

The operation to perform on the cache-control directive.

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

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation) IsKnown

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCache

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

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation string

The operation to perform on the cache-control directive.

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

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation) IsKnown

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective

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

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

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

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation) IsKnown

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective

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

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation string

The operation to perform on the cache-control directive.

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

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation) IsKnown

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheUnion

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

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

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation string

The operation to perform on the cache-control directive.

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

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation) IsKnown

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective

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

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

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

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation) IsKnown

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective

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

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation string

The operation to perform on the cache-control directive.

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

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation) IsKnown

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransform

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

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation string

The operation to perform on the cache-control directive.

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

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation) IsKnown

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective

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

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

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

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation) IsKnown

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective

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

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation string

The operation to perform on the cache-control directive.

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

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation) IsKnown

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivate

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

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation string

The operation to perform on the cache-control directive.

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

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation) IsKnown

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective

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

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

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

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation) IsKnown

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective

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

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation string

The operation to perform on the cache-control directive.

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

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation) IsKnown

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateUnion

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

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

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation string

The operation to perform on the cache-control directive.

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

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation) IsKnown

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective

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

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

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

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation) IsKnown

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective

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

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive.

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

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation) IsKnown

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublic

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

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicOperation

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicOperation string

The operation to perform on the cache-control directive.

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

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicOperation) IsKnown

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective

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

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

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

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation) IsKnown

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective

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

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation string

The operation to perform on the cache-control directive.

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

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation) IsKnown

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxage

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

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation string

The operation to perform on the cache-control directive.

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

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation) IsKnown

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective

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

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

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

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation) IsKnown

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective

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

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation string

The operation to perform on the cache-control directive.

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

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation) IsKnown

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageUnion

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

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

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation string

The operation to perform on the cache-control directive.

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

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation) IsKnown

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective

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

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

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

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation) IsKnown

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective

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

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation string

The operation to perform on the cache-control directive.

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

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation) IsKnown

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorUnion

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

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

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation string

The operation to perform on the cache-control directive.

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

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation) IsKnown

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective

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

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

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

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation) IsKnown

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective

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

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive.

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

func (PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation) IsKnown

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateUnion

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

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

type PhaseUpdateParamsRulesRulesetsSetCacheControlRuleRatelimit

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

type PhaseUpdateParamsRulesRulesetsSetCacheTagsRule

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

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

type PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleAction

type PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleAction string

The action to perform when the rule matches.

const (
	PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionSetCacheTags PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleAction = "set_cache_tags"
)

func (PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleAction) IsKnown

type PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParameters

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

type PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression

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

type PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation

type PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation string

The operation to perform on the cache tags.

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

func (PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation) IsKnown

type PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues

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

type PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation

type PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation string

The operation to perform on the cache tags.

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

func (PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation) IsKnown

type PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersOperation

type PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersOperation string

The operation to perform on the cache tags.

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

func (PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersOperation) IsKnown

type PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression

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

type PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation

type PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation string

The operation to perform on the cache tags.

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

func (PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation) IsKnown

type PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues

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

type PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation

type PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation string

The operation to perform on the cache tags.

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

func (PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation) IsKnown

type PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression

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

type PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation

type PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation string

The operation to perform on the cache tags.

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

func (PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation) IsKnown

type PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues

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

type PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation

type PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation string

The operation to perform on the cache tags.

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

func (PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation) IsKnown

type PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleExposedCredentialCheck

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

type PhaseUpdateParamsRulesRulesetsSetCacheTagsRuleRatelimit

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

type PhaseUpdateParamsRulesRulesetsTransformResponseHTMLRule added in v7.7.0

type PhaseUpdateParamsRulesRulesetsTransformResponseHTMLRule struct {
	// The unique ID of the rule.
	ID param.Field[string] `json:"id"`
	// The action to perform when the rule matches.
	Action param.Field[PhaseUpdateParamsRulesRulesetsTransformResponseHTMLRuleAction] `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters param.Field[PhaseUpdateParamsRulesRulesetsTransformResponseHTMLRuleActionParameters] `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[PhaseUpdateParamsRulesRulesetsTransformResponseHTMLRuleExposedCredentialCheck] `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[PhaseUpdateParamsRulesRulesetsTransformResponseHTMLRuleRatelimit] `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref param.Field[string] `json:"ref"`
}

func (PhaseUpdateParamsRulesRulesetsTransformResponseHTMLRule) MarshalJSON added in v7.7.0

type PhaseUpdateParamsRulesRulesetsTransformResponseHTMLRuleAction added in v7.7.0

type PhaseUpdateParamsRulesRulesetsTransformResponseHTMLRuleAction string

The action to perform when the rule matches.

const (
	PhaseUpdateParamsRulesRulesetsTransformResponseHTMLRuleActionTransformResponseHTML PhaseUpdateParamsRulesRulesetsTransformResponseHTMLRuleAction = "transform_response_html"
)

func (PhaseUpdateParamsRulesRulesetsTransformResponseHTMLRuleAction) IsKnown added in v7.7.0

type PhaseUpdateParamsRulesRulesetsTransformResponseHTMLRuleActionParameters added in v7.7.0

type PhaseUpdateParamsRulesRulesetsTransformResponseHTMLRuleActionParameters struct {
	// Enables the link maze transformation on the response.
	LinkMaze param.Field[interface{}] `json:"link_maze" api:"required"`
}

The parameters configuring the rule's action.

func (PhaseUpdateParamsRulesRulesetsTransformResponseHTMLRuleActionParameters) MarshalJSON added in v7.7.0

type PhaseUpdateParamsRulesRulesetsTransformResponseHTMLRuleExposedCredentialCheck added in v7.7.0

type PhaseUpdateParamsRulesRulesetsTransformResponseHTMLRuleExposedCredentialCheck 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 (PhaseUpdateParamsRulesRulesetsTransformResponseHTMLRuleExposedCredentialCheck) MarshalJSON added in v7.7.0

type PhaseUpdateParamsRulesRulesetsTransformResponseHTMLRuleRatelimit added in v7.7.0

type PhaseUpdateParamsRulesRulesetsTransformResponseHTMLRuleRatelimit 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 (PhaseUpdateParamsRulesRulesetsTransformResponseHTMLRuleRatelimit) MarshalJSON added in v7.7.0

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 result.
	Result PhaseUpdateResponseEnvelopeResult `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 PhaseUpdateResponseEnvelopeResult added in v7.9.0

type PhaseUpdateResponseEnvelopeResult 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 []PhaseUpdateResponseEnvelopeResultRules `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        phaseUpdateResponseEnvelopeResultJSON `json:"-"`
}

A ruleset object.

func (*PhaseUpdateResponseEnvelopeResult) UnmarshalJSON added in v7.9.0

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

type PhaseUpdateResponseEnvelopeResultRules added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRules 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 PhaseUpdateResponseEnvelopeResultRulesAction `json:"action"`
	// This field can have the runtime type of [BlockRuleActionParameters],
	// [interface{}], [CompressResponseRuleActionParameters],
	// [ExecuteRuleActionParameters], [LogCustomFieldRuleActionParameters],
	// [RedirectRuleActionParameters], [RewriteRuleActionParameters],
	// [RouteRuleActionParameters], [ScoreRuleActionParameters],
	// [ServeErrorRuleActionParameters],
	// [PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParameters],
	// [SetCacheSettingsRuleActionParameters],
	// [PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParameters],
	// [SetConfigRuleActionParameters], [SkipRuleActionParameters],
	// [PhaseUpdateResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleActionParameters].
	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],
	// [PhaseUpdateResponseEnvelopeResultRulesRulesetsChallengeRuleExposedCredentialCheck],
	// [CompressResponseRuleExposedCredentialCheck],
	// [DDoSDynamicRuleExposedCredentialCheck], [ExecuteRuleExposedCredentialCheck],
	// [ForceConnectionCloseRuleExposedCredentialCheck],
	// [PhaseUpdateResponseEnvelopeResultRulesRulesetsJSChallengeRuleExposedCredentialCheck],
	// [LogRuleExposedCredentialCheck], [LogCustomFieldRuleExposedCredentialCheck],
	// [ManagedChallengeRuleExposedCredentialCheck],
	// [RedirectRuleExposedCredentialCheck], [RewriteRuleExposedCredentialCheck],
	// [RouteRuleExposedCredentialCheck], [ScoreRuleExposedCredentialCheck],
	// [ServeErrorRuleExposedCredentialCheck],
	// [PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleExposedCredentialCheck],
	// [SetCacheSettingsRuleExposedCredentialCheck],
	// [PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleExposedCredentialCheck],
	// [SetConfigRuleExposedCredentialCheck], [SkipRuleExposedCredentialCheck],
	// [PhaseUpdateResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleExposedCredentialCheck].
	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],
	// [PhaseUpdateResponseEnvelopeResultRulesRulesetsChallengeRuleRatelimit],
	// [CompressResponseRuleRatelimit], [DDoSDynamicRuleRatelimit],
	// [ExecuteRuleRatelimit], [ForceConnectionCloseRuleRatelimit],
	// [PhaseUpdateResponseEnvelopeResultRulesRulesetsJSChallengeRuleRatelimit],
	// [LogRuleRatelimit], [LogCustomFieldRuleRatelimit],
	// [ManagedChallengeRuleRatelimit], [RedirectRuleRatelimit],
	// [RewriteRuleRatelimit], [RouteRuleRatelimit], [ScoreRuleRatelimit],
	// [ServeErrorRuleRatelimit],
	// [PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleRatelimit],
	// [SetCacheSettingsRuleRatelimit],
	// [PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleRatelimit],
	// [SetConfigRuleRatelimit], [SkipRuleRatelimit],
	// [PhaseUpdateResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleRatelimit].
	Ratelimit interface{} `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                                     `json:"ref"`
	JSON phaseUpdateResponseEnvelopeResultRulesJSON `json:"-"`
	// contains filtered or unexported fields
}

func (*PhaseUpdateResponseEnvelopeResultRules) UnmarshalJSON added in v7.9.0

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

type PhaseUpdateResponseEnvelopeResultRulesAction added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesAction string

The action to perform when the rule matches.

const (
	PhaseUpdateResponseEnvelopeResultRulesActionBlock                 PhaseUpdateResponseEnvelopeResultRulesAction = "block"
	PhaseUpdateResponseEnvelopeResultRulesActionChallenge             PhaseUpdateResponseEnvelopeResultRulesAction = "challenge"
	PhaseUpdateResponseEnvelopeResultRulesActionCompressResponse      PhaseUpdateResponseEnvelopeResultRulesAction = "compress_response"
	PhaseUpdateResponseEnvelopeResultRulesActionDDoSDynamic           PhaseUpdateResponseEnvelopeResultRulesAction = "ddos_dynamic"
	PhaseUpdateResponseEnvelopeResultRulesActionExecute               PhaseUpdateResponseEnvelopeResultRulesAction = "execute"
	PhaseUpdateResponseEnvelopeResultRulesActionForceConnectionClose  PhaseUpdateResponseEnvelopeResultRulesAction = "force_connection_close"
	PhaseUpdateResponseEnvelopeResultRulesActionJSChallenge           PhaseUpdateResponseEnvelopeResultRulesAction = "js_challenge"
	PhaseUpdateResponseEnvelopeResultRulesActionLog                   PhaseUpdateResponseEnvelopeResultRulesAction = "log"
	PhaseUpdateResponseEnvelopeResultRulesActionLogCustomField        PhaseUpdateResponseEnvelopeResultRulesAction = "log_custom_field"
	PhaseUpdateResponseEnvelopeResultRulesActionManagedChallenge      PhaseUpdateResponseEnvelopeResultRulesAction = "managed_challenge"
	PhaseUpdateResponseEnvelopeResultRulesActionRedirect              PhaseUpdateResponseEnvelopeResultRulesAction = "redirect"
	PhaseUpdateResponseEnvelopeResultRulesActionRewrite               PhaseUpdateResponseEnvelopeResultRulesAction = "rewrite"
	PhaseUpdateResponseEnvelopeResultRulesActionRoute                 PhaseUpdateResponseEnvelopeResultRulesAction = "route"
	PhaseUpdateResponseEnvelopeResultRulesActionScore                 PhaseUpdateResponseEnvelopeResultRulesAction = "score"
	PhaseUpdateResponseEnvelopeResultRulesActionServeError            PhaseUpdateResponseEnvelopeResultRulesAction = "serve_error"
	PhaseUpdateResponseEnvelopeResultRulesActionSetCacheControl       PhaseUpdateResponseEnvelopeResultRulesAction = "set_cache_control"
	PhaseUpdateResponseEnvelopeResultRulesActionSetCacheSettings      PhaseUpdateResponseEnvelopeResultRulesAction = "set_cache_settings"
	PhaseUpdateResponseEnvelopeResultRulesActionSetCacheTags          PhaseUpdateResponseEnvelopeResultRulesAction = "set_cache_tags"
	PhaseUpdateResponseEnvelopeResultRulesActionSetConfig             PhaseUpdateResponseEnvelopeResultRulesAction = "set_config"
	PhaseUpdateResponseEnvelopeResultRulesActionSkip                  PhaseUpdateResponseEnvelopeResultRulesAction = "skip"
	PhaseUpdateResponseEnvelopeResultRulesActionTransformResponseHTML PhaseUpdateResponseEnvelopeResultRulesAction = "transform_response_html"
)

func (PhaseUpdateResponseEnvelopeResultRulesAction) IsKnown added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsChallengeRule added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsChallengeRule 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 PhaseUpdateResponseEnvelopeResultRulesRulesetsChallengeRuleAction `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 PhaseUpdateResponseEnvelopeResultRulesRulesetsChallengeRuleExposedCredentialCheck `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 PhaseUpdateResponseEnvelopeResultRulesRulesetsChallengeRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                                                          `json:"ref"`
	JSON phaseUpdateResponseEnvelopeResultRulesRulesetsChallengeRuleJSON `json:"-"`
}

func (*PhaseUpdateResponseEnvelopeResultRulesRulesetsChallengeRule) UnmarshalJSON added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsChallengeRuleAction added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsChallengeRuleAction string

The action to perform when the rule matches.

const (
	PhaseUpdateResponseEnvelopeResultRulesRulesetsChallengeRuleActionChallenge PhaseUpdateResponseEnvelopeResultRulesRulesetsChallengeRuleAction = "challenge"
)

func (PhaseUpdateResponseEnvelopeResultRulesRulesetsChallengeRuleAction) IsKnown added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsChallengeRuleExposedCredentialCheck added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsChallengeRuleExposedCredentialCheck 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               phaseUpdateResponseEnvelopeResultRulesRulesetsChallengeRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*PhaseUpdateResponseEnvelopeResultRulesRulesetsChallengeRuleExposedCredentialCheck) UnmarshalJSON added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsChallengeRuleRatelimit added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsChallengeRuleRatelimit 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                    phaseUpdateResponseEnvelopeResultRulesRulesetsChallengeRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*PhaseUpdateResponseEnvelopeResultRulesRulesetsChallengeRuleRatelimit) UnmarshalJSON added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsJSChallengeRule added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsJSChallengeRule 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 PhaseUpdateResponseEnvelopeResultRulesRulesetsJSChallengeRuleAction `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 PhaseUpdateResponseEnvelopeResultRulesRulesetsJSChallengeRuleExposedCredentialCheck `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 PhaseUpdateResponseEnvelopeResultRulesRulesetsJSChallengeRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                                                            `json:"ref"`
	JSON phaseUpdateResponseEnvelopeResultRulesRulesetsJSChallengeRuleJSON `json:"-"`
}

func (*PhaseUpdateResponseEnvelopeResultRulesRulesetsJSChallengeRule) UnmarshalJSON added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsJSChallengeRuleAction added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsJSChallengeRuleAction string

The action to perform when the rule matches.

const (
	PhaseUpdateResponseEnvelopeResultRulesRulesetsJSChallengeRuleActionJSChallenge PhaseUpdateResponseEnvelopeResultRulesRulesetsJSChallengeRuleAction = "js_challenge"
)

func (PhaseUpdateResponseEnvelopeResultRulesRulesetsJSChallengeRuleAction) IsKnown added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsJSChallengeRuleExposedCredentialCheck added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsJSChallengeRuleExposedCredentialCheck 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               phaseUpdateResponseEnvelopeResultRulesRulesetsJSChallengeRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*PhaseUpdateResponseEnvelopeResultRulesRulesetsJSChallengeRuleExposedCredentialCheck) UnmarshalJSON added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsJSChallengeRuleRatelimit added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsJSChallengeRuleRatelimit 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                    phaseUpdateResponseEnvelopeResultRulesRulesetsJSChallengeRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*PhaseUpdateResponseEnvelopeResultRulesRulesetsJSChallengeRuleRatelimit) UnmarshalJSON added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRule added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRule 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 PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleAction `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParameters `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 PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleExposedCredentialCheck `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 PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                                                                `json:"ref"`
	JSON phaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleJSON `json:"-"`
}

func (*PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRule) UnmarshalJSON added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleAction added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleAction string

The action to perform when the rule matches.

const (
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionSetCacheControl PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleAction = "set_cache_control"
)

func (PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleAction) IsKnown added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParameters added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParameters struct {
	// A cache-control directive configuration.
	Immutable PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutable `json:"immutable"`
	// A cache-control directive configuration that accepts a duration value in
	// seconds.
	MaxAge PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAge `json:"max-age"`
	// A cache-control directive configuration.
	MustRevalidate PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate `json:"must-revalidate"`
	// A cache-control directive configuration.
	MustUnderstand PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand `json:"must-understand"`
	// A cache-control directive configuration that accepts optional qualifiers (header
	// names).
	NoCache PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCache `json:"no-cache"`
	// A cache-control directive configuration.
	NoStore PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStore `json:"no-store"`
	// A cache-control directive configuration.
	NoTransform PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransform `json:"no-transform"`
	// A cache-control directive configuration that accepts optional qualifiers (header
	// names).
	Private PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivate `json:"private"`
	// A cache-control directive configuration.
	ProxyRevalidate PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate `json:"proxy-revalidate"`
	// A cache-control directive configuration.
	Public PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublic `json:"public"`
	// A cache-control directive configuration that accepts a duration value in
	// seconds.
	SMaxage PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxage `json:"s-maxage"`
	// A cache-control directive configuration that accepts a duration value in
	// seconds.
	StaleIfError PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfError `json:"stale-if-error"`
	// A cache-control directive configuration that accepts a duration value in
	// seconds.
	StaleWhileRevalidate PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate `json:"stale-while-revalidate"`
	JSON                 phaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersJSON                 `json:"-"`
}

The parameters configuring the rule's action.

func (*PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParameters) UnmarshalJSON added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutable added in v7.9.0

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

A cache-control directive configuration.

func (*PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutable) UnmarshalJSON added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation string

The operation to perform on the cache-control directive.

const (
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableOperationSet    PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation = "set"
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableOperationRemove PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation = "remove"
)

func (PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation) IsKnown added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective added in v7.9.0

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

Remove the directive.

func (*PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective) UnmarshalJSON added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperationSet    PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation = "set"
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperationRemove PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation = "remove"
)

func (PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation) IsKnown added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective added in v7.9.0

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

Set the directive.

func (*PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective) UnmarshalJSON added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperationSet    PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation = "set"
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperationRemove PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation = "remove"
)

func (PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation) IsKnown added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableUnion added in v7.9.0

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

A cache-control directive configuration.

Union satisfied by PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective or PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective.

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAge added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAge struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation `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  phaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeJSON `json:"-"`
	// contains filtered or unexported fields
}

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

func (*PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAge) UnmarshalJSON added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation string

The operation to perform on the cache-control directive.

const (
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperationSet    PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation = "set"
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperationRemove PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation = "remove"
)

func (PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation) IsKnown added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective added in v7.9.0

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

Remove the directive.

func (*PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective) UnmarshalJSON added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperationSet    PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation = "set"
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperationRemove PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation = "remove"
)

func (PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation) IsKnown added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation `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           phaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveJSON `json:"-"`
}

Set the directive with a duration value in seconds.

func (*PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective) UnmarshalJSON added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperationSet    PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation = "set"
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperationRemove PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation = "remove"
)

func (PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation) IsKnown added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeUnion added in v7.9.0

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

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

Union satisfied by PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective or PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective.

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate added in v7.9.0

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

A cache-control directive configuration.

func (*PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate) UnmarshalJSON added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation string

The operation to perform on the cache-control directive.

const (
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperationSet    PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation = "set"
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperationRemove PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation = "remove"
)

func (PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation) IsKnown added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective added in v7.9.0

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

Remove the directive.

func (*PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective) UnmarshalJSON added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperationSet    PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation = "set"
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperationRemove PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation = "remove"
)

func (PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation) IsKnown added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective added in v7.9.0

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

Set the directive.

func (*PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective) UnmarshalJSON added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperationSet    PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation = "set"
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperationRemove PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation = "remove"
)

func (PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation) IsKnown added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateUnion added in v7.9.0

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

A cache-control directive configuration.

Union satisfied by PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective or PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective.

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand added in v7.9.0

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

A cache-control directive configuration.

func (*PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand) UnmarshalJSON added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation string

The operation to perform on the cache-control directive.

const (
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperationSet    PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation = "set"
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperationRemove PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation = "remove"
)

func (PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation) IsKnown added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective added in v7.9.0

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

Remove the directive.

func (*PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective) UnmarshalJSON added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperationSet    PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation = "set"
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperationRemove PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation = "remove"
)

func (PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation) IsKnown added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective added in v7.9.0

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

Set the directive.

func (*PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective) UnmarshalJSON added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperationSet    PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation = "set"
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperationRemove PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation = "remove"
)

func (PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation) IsKnown added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandUnion added in v7.9.0

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

A cache-control directive configuration.

Union satisfied by PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective or PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective.

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCache added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCache struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation `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       phaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheJSON `json:"-"`
	// contains filtered or unexported fields
}

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

func (*PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCache) UnmarshalJSON added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation string

The operation to perform on the cache-control directive.

const (
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperationSet    PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation = "set"
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperationRemove PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation = "remove"
)

func (PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation) IsKnown added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective added in v7.9.0

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

Remove the directive.

func (*PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective) UnmarshalJSON added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperationSet    PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation = "set"
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperationRemove PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation = "remove"
)

func (PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation) IsKnown added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation `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       phaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveJSON `json:"-"`
}

Set the directive with optional qualifiers.

func (*PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective) UnmarshalJSON added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperationSet    PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation = "set"
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperationRemove PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation = "remove"
)

func (PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation) IsKnown added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheUnion added in v7.9.0

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

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

Union satisfied by PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective or PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective.

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStore added in v7.9.0

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

A cache-control directive configuration.

func (*PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStore) UnmarshalJSON added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation string

The operation to perform on the cache-control directive.

const (
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperationSet    PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation = "set"
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperationRemove PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation = "remove"
)

func (PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation) IsKnown added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective added in v7.9.0

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

Remove the directive.

func (*PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective) UnmarshalJSON added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperationSet    PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation = "set"
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperationRemove PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation = "remove"
)

func (PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation) IsKnown added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective added in v7.9.0

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

Set the directive.

func (*PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective) UnmarshalJSON added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperationSet    PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation = "set"
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperationRemove PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation = "remove"
)

func (PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation) IsKnown added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreUnion added in v7.9.0

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

A cache-control directive configuration.

Union satisfied by PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective or PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective.

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransform added in v7.9.0

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

A cache-control directive configuration.

func (*PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransform) UnmarshalJSON added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation string

The operation to perform on the cache-control directive.

const (
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperationSet    PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation = "set"
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperationRemove PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation = "remove"
)

func (PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation) IsKnown added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective added in v7.9.0

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

Remove the directive.

func (*PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective) UnmarshalJSON added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperationSet    PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation = "set"
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperationRemove PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation = "remove"
)

func (PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation) IsKnown added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective added in v7.9.0

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

Set the directive.

func (*PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective) UnmarshalJSON added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperationSet    PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation = "set"
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperationRemove PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation = "remove"
)

func (PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation) IsKnown added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformUnion added in v7.9.0

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

A cache-control directive configuration.

Union satisfied by PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective or PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective.

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivate added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivate struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation `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       phaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateJSON `json:"-"`
	// contains filtered or unexported fields
}

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

func (*PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivate) UnmarshalJSON added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation string

The operation to perform on the cache-control directive.

const (
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateOperationSet    PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation = "set"
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateOperationRemove PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation = "remove"
)

func (PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation) IsKnown added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective added in v7.9.0

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

Remove the directive.

func (*PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective) UnmarshalJSON added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperationSet    PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation = "set"
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperationRemove PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation = "remove"
)

func (PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation) IsKnown added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation `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       phaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveJSON `json:"-"`
}

Set the directive with optional qualifiers.

func (*PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective) UnmarshalJSON added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperationSet    PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation = "set"
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperationRemove PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation = "remove"
)

func (PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation) IsKnown added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateUnion added in v7.9.0

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

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

Union satisfied by PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective or PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective.

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate added in v7.9.0

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

A cache-control directive configuration.

func (*PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate) UnmarshalJSON added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation string

The operation to perform on the cache-control directive.

const (
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperationSet    PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation = "set"
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperationRemove PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation = "remove"
)

func (PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation) IsKnown added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective added in v7.9.0

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

Remove the directive.

func (*PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective) UnmarshalJSON added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperationSet    PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation = "set"
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperationRemove PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation = "remove"
)

func (PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation) IsKnown added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective added in v7.9.0

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

Set the directive.

func (*PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective) UnmarshalJSON added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperationSet    PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation = "set"
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperationRemove PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation = "remove"
)

func (PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation) IsKnown added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateUnion added in v7.9.0

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

A cache-control directive configuration.

Union satisfied by PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective or PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective.

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublic added in v7.9.0

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

A cache-control directive configuration.

func (*PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublic) UnmarshalJSON added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicOperation added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicOperation string

The operation to perform on the cache-control directive.

const (
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicOperationSet    PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicOperation = "set"
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicOperationRemove PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicOperation = "remove"
)

func (PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicOperation) IsKnown added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective added in v7.9.0

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

Remove the directive.

func (*PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective) UnmarshalJSON added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperationSet    PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation = "set"
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperationRemove PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation = "remove"
)

func (PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation) IsKnown added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective added in v7.9.0

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

Set the directive.

func (*PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective) UnmarshalJSON added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperationSet    PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation = "set"
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperationRemove PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation = "remove"
)

func (PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation) IsKnown added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicUnion added in v7.9.0

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

A cache-control directive configuration.

Union satisfied by PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective or PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective.

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxage added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxage struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation `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  phaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageJSON `json:"-"`
	// contains filtered or unexported fields
}

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

func (*PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxage) UnmarshalJSON added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation string

The operation to perform on the cache-control directive.

const (
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperationSet    PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation = "set"
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperationRemove PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation = "remove"
)

func (PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation) IsKnown added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective added in v7.9.0

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

Remove the directive.

func (*PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective) UnmarshalJSON added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperationSet    PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation = "set"
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperationRemove PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation = "remove"
)

func (PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation) IsKnown added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation `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           phaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveJSON `json:"-"`
}

Set the directive with a duration value in seconds.

func (*PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective) UnmarshalJSON added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperationSet    PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation = "set"
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperationRemove PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation = "remove"
)

func (PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation) IsKnown added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageUnion added in v7.9.0

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

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

Union satisfied by PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective or PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective.

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfError added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfError struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation `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  phaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorJSON `json:"-"`
	// contains filtered or unexported fields
}

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

func (*PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfError) UnmarshalJSON added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation string

The operation to perform on the cache-control directive.

const (
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperationSet    PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation = "set"
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperationRemove PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation = "remove"
)

func (PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation) IsKnown added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective added in v7.9.0

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

Remove the directive.

func (*PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective) UnmarshalJSON added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperationSet    PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation = "set"
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperationRemove PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation = "remove"
)

func (PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation) IsKnown added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation `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           phaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveJSON `json:"-"`
}

Set the directive with a duration value in seconds.

func (*PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective) UnmarshalJSON added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperationSet    PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation = "set"
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperationRemove PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation = "remove"
)

func (PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation) IsKnown added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorUnion added in v7.9.0

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

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

Union satisfied by PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective or PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective.

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation `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  phaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateJSON `json:"-"`
	// contains filtered or unexported fields
}

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

func (*PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate) UnmarshalJSON added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation string

The operation to perform on the cache-control directive.

const (
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperationSet    PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation = "set"
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperationRemove PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation = "remove"
)

func (PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation) IsKnown added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective added in v7.9.0

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

Remove the directive.

func (*PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective) UnmarshalJSON added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperationSet    PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation = "set"
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperationRemove PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation = "remove"
)

func (PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation) IsKnown added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation `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           phaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveJSON `json:"-"`
}

Set the directive with a duration value in seconds.

func (*PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective) UnmarshalJSON added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperationSet    PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation = "set"
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperationRemove PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation = "remove"
)

func (PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation) IsKnown added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateUnion added in v7.9.0

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

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

Union satisfied by PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective or PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective.

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleExposedCredentialCheck added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleExposedCredentialCheck 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               phaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleExposedCredentialCheck) UnmarshalJSON added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleRatelimit added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleRatelimit 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                    phaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleRatelimit) UnmarshalJSON added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRule added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRule 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 PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleAction `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParameters `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 PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleExposedCredentialCheck `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 PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                                                             `json:"ref"`
	JSON phaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleJSON `json:"-"`
}

func (*PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRule) UnmarshalJSON added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleAction added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleAction string

The action to perform when the rule matches.

const (
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionSetCacheTags PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleAction = "set_cache_tags"
)

func (PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleAction) IsKnown added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParameters added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParameters struct {
	// The operation to perform on the cache tags.
	Operation PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersOperation `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   phaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersJSON `json:"-"`
	// contains filtered or unexported fields
}

The parameters configuring the rule's action.

func (*PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParameters) UnmarshalJSON added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression 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 PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation `json:"operation" api:"required"`
	JSON      phaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionJSON      `json:"-"`
}

Add cache tags using an expression.

func (*PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression) UnmarshalJSON added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation string

The operation to perform on the cache tags.

const (
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationAdd    PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "add"
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationRemove PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "remove"
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationSet    PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "set"
)

func (PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation) IsKnown added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues added in v7.9.0

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

Add cache tags using a list of values.

func (*PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues) UnmarshalJSON added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation string

The operation to perform on the cache tags.

const (
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationAdd    PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "add"
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationRemove PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "remove"
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationSet    PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "set"
)

func (PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation) IsKnown added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersOperation added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersOperation string

The operation to perform on the cache tags.

const (
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersOperationAdd    PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersOperation = "add"
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersOperationRemove PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersOperation = "remove"
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersOperationSet    PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersOperation = "set"
)

func (PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersOperation) IsKnown added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression 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 PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation `json:"operation" api:"required"`
	JSON      phaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionJSON      `json:"-"`
}

Remove cache tags using an expression.

func (*PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression) UnmarshalJSON added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation string

The operation to perform on the cache tags.

const (
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationAdd    PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "add"
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationRemove PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "remove"
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationSet    PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "set"
)

func (PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation) IsKnown added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues added in v7.9.0

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

Remove cache tags using a list of values.

func (*PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues) UnmarshalJSON added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation string

The operation to perform on the cache tags.

const (
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationAdd    PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "add"
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationRemove PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "remove"
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationSet    PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "set"
)

func (PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation) IsKnown added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression 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 PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation `json:"operation" api:"required"`
	JSON      phaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionJSON      `json:"-"`
}

Set cache tags using an expression.

func (*PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression) UnmarshalJSON added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation string

The operation to perform on the cache tags.

const (
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationAdd    PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "add"
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationRemove PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "remove"
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationSet    PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "set"
)

func (PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation) IsKnown added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues added in v7.9.0

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

Set cache tags using a list of values.

func (*PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues) UnmarshalJSON added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation string

The operation to perform on the cache tags.

const (
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationAdd    PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "add"
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationRemove PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "remove"
	PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationSet    PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "set"
)

func (PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation) IsKnown added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleExposedCredentialCheck added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleExposedCredentialCheck 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               phaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleExposedCredentialCheck) UnmarshalJSON added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleRatelimit added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleRatelimit 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                    phaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*PhaseUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleRatelimit) UnmarshalJSON added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRule added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRule 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 PhaseUpdateResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleAction `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters PhaseUpdateResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleActionParameters `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 PhaseUpdateResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleExposedCredentialCheck `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 PhaseUpdateResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                                                                      `json:"ref"`
	JSON phaseUpdateResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleJSON `json:"-"`
}

func (*PhaseUpdateResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRule) UnmarshalJSON added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleAction added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleAction string

The action to perform when the rule matches.

const (
	PhaseUpdateResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleActionTransformResponseHTML PhaseUpdateResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleAction = "transform_response_html"
)

func (PhaseUpdateResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleAction) IsKnown added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleActionParameters added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleActionParameters struct {
	// Enables the link maze transformation on the response.
	LinkMaze interface{}                                                                                 `json:"link_maze" api:"required"`
	JSON     phaseUpdateResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleActionParametersJSON `json:"-"`
}

The parameters configuring the rule's action.

func (*PhaseUpdateResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleActionParameters) UnmarshalJSON added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleExposedCredentialCheck added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleExposedCredentialCheck 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               phaseUpdateResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*PhaseUpdateResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleExposedCredentialCheck) UnmarshalJSON added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleRatelimit added in v7.9.0

type PhaseUpdateResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleRatelimit 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                    phaseUpdateResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*PhaseUpdateResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleRatelimit) UnmarshalJSON added in v7.9.0

type PhaseUpdateResponseEnvelopeSuccess

type PhaseUpdateResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	PhaseUpdateResponseEnvelopeSuccessTrue PhaseUpdateResponseEnvelopeSuccess = true
)

func (PhaseUpdateResponseEnvelopeSuccess) IsKnown

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

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],
	// [PhaseVersionGetResponseRulesRulesetsTransformResponseHTMLRuleActionParameters].
	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],
	// [PhaseVersionGetResponseRulesRulesetsTransformResponseHTMLRuleExposedCredentialCheck].
	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],
	// [PhaseVersionGetResponseRulesRulesetsTransformResponseHTMLRuleRatelimit].
	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) 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"
	PhaseVersionGetResponseRulesActionTransformResponseHTML PhaseVersionGetResponseRulesAction = "transform_response_html"
)

func (PhaseVersionGetResponseRulesAction) IsKnown

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

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

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

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

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

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

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRule

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

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleAction

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleAction string

The action to perform when the rule matches.

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionSetCacheControl PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleAction = "set_cache_control"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleAction) IsKnown

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParameters

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

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutable

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) UnmarshalJSON

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation string

The operation to perform on the cache-control directive.

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation = "set"
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation = "remove"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation) IsKnown

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective

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

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation = "set"
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation = "remove"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation) IsKnown

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective

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

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation = "set"
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation = "remove"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation) IsKnown

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableUnion

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

A cache-control directive configuration.

Union satisfied by PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective or PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective.

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAge

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) UnmarshalJSON

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation string

The operation to perform on the cache-control directive.

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation = "set"
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation = "remove"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation) IsKnown

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective

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

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation = "set"
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation = "remove"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation) IsKnown

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective

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

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation = "set"
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation = "remove"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation) IsKnown

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeUnion

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

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) UnmarshalJSON

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation string

The operation to perform on the cache-control directive.

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation = "set"
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation = "remove"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation) IsKnown

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective

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

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation = "set"
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation = "remove"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation) IsKnown

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective

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

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation = "set"
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation = "remove"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation) IsKnown

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateUnion

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

A cache-control directive configuration.

Union satisfied by PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective or PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective.

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand

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) UnmarshalJSON

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation string

The operation to perform on the cache-control directive.

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation = "set"
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation = "remove"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation) IsKnown

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective

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

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation = "set"
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation = "remove"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation) IsKnown

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective

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

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation = "set"
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation = "remove"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation) IsKnown

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandUnion

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

A cache-control directive configuration.

Union satisfied by PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective or PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective.

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCache

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) UnmarshalJSON

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation string

The operation to perform on the cache-control directive.

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation = "set"
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation = "remove"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation) IsKnown

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective

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

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation = "set"
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation = "remove"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation) IsKnown

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective

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

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation = "set"
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation = "remove"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation) IsKnown

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheUnion

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

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) UnmarshalJSON

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation string

The operation to perform on the cache-control directive.

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation = "set"
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation = "remove"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation) IsKnown

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective

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

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation = "set"
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation = "remove"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation) IsKnown

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective

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

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation = "set"
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation = "remove"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation) IsKnown

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreUnion

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

A cache-control directive configuration.

Union satisfied by PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective or PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective.

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransform

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) UnmarshalJSON

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation string

The operation to perform on the cache-control directive.

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation = "set"
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation = "remove"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation) IsKnown

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective

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

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation = "set"
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation = "remove"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation) IsKnown

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective

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

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation = "set"
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation = "remove"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation) IsKnown

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformUnion

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

A cache-control directive configuration.

Union satisfied by PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective or PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective.

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivate

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) UnmarshalJSON

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation string

The operation to perform on the cache-control directive.

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation = "set"
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation = "remove"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation) IsKnown

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective

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

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation = "set"
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation = "remove"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation) IsKnown

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective

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

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation = "set"
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation = "remove"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation) IsKnown

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateUnion

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

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) UnmarshalJSON

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation string

The operation to perform on the cache-control directive.

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation = "set"
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation = "remove"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation) IsKnown

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective

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

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation = "set"
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation = "remove"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation) IsKnown

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective

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

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation = "set"
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation = "remove"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation) IsKnown

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateUnion

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

A cache-control directive configuration.

Union satisfied by PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective or PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective.

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublic

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) UnmarshalJSON

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation string

The operation to perform on the cache-control directive.

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation = "set"
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation = "remove"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation) IsKnown

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective

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

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation = "set"
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation = "remove"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation) IsKnown

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective

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

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation = "set"
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation = "remove"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation) IsKnown

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicUnion

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

A cache-control directive configuration.

Union satisfied by PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective or PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective.

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxage

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) UnmarshalJSON

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation string

The operation to perform on the cache-control directive.

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation = "set"
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation = "remove"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation) IsKnown

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective

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

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation = "set"
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation = "remove"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation) IsKnown

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective

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

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation = "set"
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation = "remove"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation) IsKnown

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageUnion

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

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) UnmarshalJSON

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation string

The operation to perform on the cache-control directive.

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation = "set"
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation = "remove"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation) IsKnown

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective

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

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation = "set"
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation = "remove"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation) IsKnown

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective

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

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation = "set"
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation = "remove"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation) IsKnown

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorUnion

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

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) UnmarshalJSON

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation string

The operation to perform on the cache-control directive.

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation = "set"
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation = "remove"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation) IsKnown

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective

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

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation = "set"
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation = "remove"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation) IsKnown

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective

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

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation = "set"
	PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation = "remove"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation) IsKnown

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateUnion

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

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

type PhaseVersionGetResponseRulesRulesetsSetCacheControlRuleRatelimit

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

type PhaseVersionGetResponseRulesRulesetsSetCacheTagsRule

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

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

type PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleAction

type PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleAction string

The action to perform when the rule matches.

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionSetCacheTags PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleAction = "set_cache_tags"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleAction) IsKnown

type PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParameters

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) UnmarshalJSON

type PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression

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

type PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation

type PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation string

The operation to perform on the cache tags.

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationAdd    PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "add"
	PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "remove"
	PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "set"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation) IsKnown

type PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues

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

type PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation

type PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation string

The operation to perform on the cache tags.

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationAdd    PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "add"
	PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "remove"
	PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "set"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation) IsKnown

type PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation

type PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation string

The operation to perform on the cache tags.

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersOperationAdd    PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation = "add"
	PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation = "remove"
	PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation = "set"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation) IsKnown

type PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression

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

type PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation

type PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation string

The operation to perform on the cache tags.

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationAdd    PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "add"
	PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "remove"
	PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "set"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation) IsKnown

type PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues

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

type PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation

type PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation string

The operation to perform on the cache tags.

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationAdd    PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "add"
	PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "remove"
	PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "set"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation) IsKnown

type PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression

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

type PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation

type PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation string

The operation to perform on the cache tags.

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationAdd    PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "add"
	PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "remove"
	PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "set"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation) IsKnown

type PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues

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

type PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation

type PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation string

The operation to perform on the cache tags.

const (
	PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationAdd    PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "add"
	PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationRemove PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "remove"
	PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationSet    PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "set"
)

func (PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation) IsKnown

type PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleExposedCredentialCheck

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

type PhaseVersionGetResponseRulesRulesetsSetCacheTagsRuleRatelimit

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

type PhaseVersionGetResponseRulesRulesetsTransformResponseHTMLRule added in v7.7.0

type PhaseVersionGetResponseRulesRulesetsTransformResponseHTMLRule 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 PhaseVersionGetResponseRulesRulesetsTransformResponseHTMLRuleAction `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters PhaseVersionGetResponseRulesRulesetsTransformResponseHTMLRuleActionParameters `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 PhaseVersionGetResponseRulesRulesetsTransformResponseHTMLRuleExposedCredentialCheck `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 PhaseVersionGetResponseRulesRulesetsTransformResponseHTMLRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                                                            `json:"ref"`
	JSON phaseVersionGetResponseRulesRulesetsTransformResponseHTMLRuleJSON `json:"-"`
}

func (*PhaseVersionGetResponseRulesRulesetsTransformResponseHTMLRule) UnmarshalJSON added in v7.7.0

type PhaseVersionGetResponseRulesRulesetsTransformResponseHTMLRuleAction added in v7.7.0

type PhaseVersionGetResponseRulesRulesetsTransformResponseHTMLRuleAction string

The action to perform when the rule matches.

const (
	PhaseVersionGetResponseRulesRulesetsTransformResponseHTMLRuleActionTransformResponseHTML PhaseVersionGetResponseRulesRulesetsTransformResponseHTMLRuleAction = "transform_response_html"
)

func (PhaseVersionGetResponseRulesRulesetsTransformResponseHTMLRuleAction) IsKnown added in v7.7.0

type PhaseVersionGetResponseRulesRulesetsTransformResponseHTMLRuleActionParameters added in v7.7.0

type PhaseVersionGetResponseRulesRulesetsTransformResponseHTMLRuleActionParameters struct {
	// Enables the link maze transformation on the response.
	LinkMaze interface{}                                                                       `json:"link_maze" api:"required"`
	JSON     phaseVersionGetResponseRulesRulesetsTransformResponseHTMLRuleActionParametersJSON `json:"-"`
}

The parameters configuring the rule's action.

func (*PhaseVersionGetResponseRulesRulesetsTransformResponseHTMLRuleActionParameters) UnmarshalJSON added in v7.7.0

type PhaseVersionGetResponseRulesRulesetsTransformResponseHTMLRuleExposedCredentialCheck added in v7.7.0

type PhaseVersionGetResponseRulesRulesetsTransformResponseHTMLRuleExposedCredentialCheck 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               phaseVersionGetResponseRulesRulesetsTransformResponseHTMLRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*PhaseVersionGetResponseRulesRulesetsTransformResponseHTMLRuleExposedCredentialCheck) UnmarshalJSON added in v7.7.0

type PhaseVersionGetResponseRulesRulesetsTransformResponseHTMLRuleRatelimit added in v7.7.0

type PhaseVersionGetResponseRulesRulesetsTransformResponseHTMLRuleRatelimit 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                    phaseVersionGetResponseRulesRulesetsTransformResponseHTMLRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*PhaseVersionGetResponseRulesRulesetsTransformResponseHTMLRuleRatelimit) UnmarshalJSON added in v7.7.0

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

Fetches the versions of an account or zone entry point ruleset.

func (*PhaseVersionService) ListAutoPaging

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

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) 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

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

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

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

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

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

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

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

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

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

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

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"`
	// Validates the request without persisting changes when set to `true`. Responses
	// that normally return 200 return `result: null`; endpoints that normally return
	// 204 continue to return 204.
	DryRun param.Field[bool] `query:"dry_run"`
}

func (RuleDeleteParams) URLQuery added in v7.9.0

func (r RuleDeleteParams) URLQuery() (v url.Values)

URLQuery serializes RuleDeleteParams's query parameters as `url.Values`.

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 result.
	Result RuleDeleteResponseEnvelopeResult `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 RuleDeleteResponseEnvelopeResult added in v7.9.0

type RuleDeleteResponseEnvelopeResult 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 []RuleDeleteResponseEnvelopeResultRules `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        ruleDeleteResponseEnvelopeResultJSON `json:"-"`
}

A ruleset object.

func (*RuleDeleteResponseEnvelopeResult) UnmarshalJSON added in v7.9.0

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

type RuleDeleteResponseEnvelopeResultRules added in v7.9.0

type RuleDeleteResponseEnvelopeResultRules 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 RuleDeleteResponseEnvelopeResultRulesAction `json:"action"`
	// This field can have the runtime type of [BlockRuleActionParameters],
	// [interface{}], [CompressResponseRuleActionParameters],
	// [ExecuteRuleActionParameters], [LogCustomFieldRuleActionParameters],
	// [RedirectRuleActionParameters], [RewriteRuleActionParameters],
	// [RouteRuleActionParameters], [ScoreRuleActionParameters],
	// [ServeErrorRuleActionParameters],
	// [RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParameters],
	// [SetCacheSettingsRuleActionParameters],
	// [RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParameters],
	// [SetConfigRuleActionParameters], [SkipRuleActionParameters],
	// [RuleDeleteResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleActionParameters].
	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],
	// [RuleDeleteResponseEnvelopeResultRulesRulesetsChallengeRuleExposedCredentialCheck],
	// [CompressResponseRuleExposedCredentialCheck],
	// [DDoSDynamicRuleExposedCredentialCheck], [ExecuteRuleExposedCredentialCheck],
	// [ForceConnectionCloseRuleExposedCredentialCheck],
	// [RuleDeleteResponseEnvelopeResultRulesRulesetsJSChallengeRuleExposedCredentialCheck],
	// [LogRuleExposedCredentialCheck], [LogCustomFieldRuleExposedCredentialCheck],
	// [ManagedChallengeRuleExposedCredentialCheck],
	// [RedirectRuleExposedCredentialCheck], [RewriteRuleExposedCredentialCheck],
	// [RouteRuleExposedCredentialCheck], [ScoreRuleExposedCredentialCheck],
	// [ServeErrorRuleExposedCredentialCheck],
	// [RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleExposedCredentialCheck],
	// [SetCacheSettingsRuleExposedCredentialCheck],
	// [RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleExposedCredentialCheck],
	// [SetConfigRuleExposedCredentialCheck], [SkipRuleExposedCredentialCheck],
	// [RuleDeleteResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleExposedCredentialCheck].
	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],
	// [RuleDeleteResponseEnvelopeResultRulesRulesetsChallengeRuleRatelimit],
	// [CompressResponseRuleRatelimit], [DDoSDynamicRuleRatelimit],
	// [ExecuteRuleRatelimit], [ForceConnectionCloseRuleRatelimit],
	// [RuleDeleteResponseEnvelopeResultRulesRulesetsJSChallengeRuleRatelimit],
	// [LogRuleRatelimit], [LogCustomFieldRuleRatelimit],
	// [ManagedChallengeRuleRatelimit], [RedirectRuleRatelimit],
	// [RewriteRuleRatelimit], [RouteRuleRatelimit], [ScoreRuleRatelimit],
	// [ServeErrorRuleRatelimit],
	// [RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleRatelimit],
	// [SetCacheSettingsRuleRatelimit],
	// [RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleRatelimit],
	// [SetConfigRuleRatelimit], [SkipRuleRatelimit],
	// [RuleDeleteResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleRatelimit].
	Ratelimit interface{} `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                                    `json:"ref"`
	JSON ruleDeleteResponseEnvelopeResultRulesJSON `json:"-"`
	// contains filtered or unexported fields
}

func (*RuleDeleteResponseEnvelopeResultRules) UnmarshalJSON added in v7.9.0

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

type RuleDeleteResponseEnvelopeResultRulesAction added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesAction string

The action to perform when the rule matches.

const (
	RuleDeleteResponseEnvelopeResultRulesActionBlock                 RuleDeleteResponseEnvelopeResultRulesAction = "block"
	RuleDeleteResponseEnvelopeResultRulesActionChallenge             RuleDeleteResponseEnvelopeResultRulesAction = "challenge"
	RuleDeleteResponseEnvelopeResultRulesActionCompressResponse      RuleDeleteResponseEnvelopeResultRulesAction = "compress_response"
	RuleDeleteResponseEnvelopeResultRulesActionDDoSDynamic           RuleDeleteResponseEnvelopeResultRulesAction = "ddos_dynamic"
	RuleDeleteResponseEnvelopeResultRulesActionExecute               RuleDeleteResponseEnvelopeResultRulesAction = "execute"
	RuleDeleteResponseEnvelopeResultRulesActionForceConnectionClose  RuleDeleteResponseEnvelopeResultRulesAction = "force_connection_close"
	RuleDeleteResponseEnvelopeResultRulesActionJSChallenge           RuleDeleteResponseEnvelopeResultRulesAction = "js_challenge"
	RuleDeleteResponseEnvelopeResultRulesActionLog                   RuleDeleteResponseEnvelopeResultRulesAction = "log"
	RuleDeleteResponseEnvelopeResultRulesActionLogCustomField        RuleDeleteResponseEnvelopeResultRulesAction = "log_custom_field"
	RuleDeleteResponseEnvelopeResultRulesActionManagedChallenge      RuleDeleteResponseEnvelopeResultRulesAction = "managed_challenge"
	RuleDeleteResponseEnvelopeResultRulesActionRedirect              RuleDeleteResponseEnvelopeResultRulesAction = "redirect"
	RuleDeleteResponseEnvelopeResultRulesActionRewrite               RuleDeleteResponseEnvelopeResultRulesAction = "rewrite"
	RuleDeleteResponseEnvelopeResultRulesActionRoute                 RuleDeleteResponseEnvelopeResultRulesAction = "route"
	RuleDeleteResponseEnvelopeResultRulesActionScore                 RuleDeleteResponseEnvelopeResultRulesAction = "score"
	RuleDeleteResponseEnvelopeResultRulesActionServeError            RuleDeleteResponseEnvelopeResultRulesAction = "serve_error"
	RuleDeleteResponseEnvelopeResultRulesActionSetCacheControl       RuleDeleteResponseEnvelopeResultRulesAction = "set_cache_control"
	RuleDeleteResponseEnvelopeResultRulesActionSetCacheSettings      RuleDeleteResponseEnvelopeResultRulesAction = "set_cache_settings"
	RuleDeleteResponseEnvelopeResultRulesActionSetCacheTags          RuleDeleteResponseEnvelopeResultRulesAction = "set_cache_tags"
	RuleDeleteResponseEnvelopeResultRulesActionSetConfig             RuleDeleteResponseEnvelopeResultRulesAction = "set_config"
	RuleDeleteResponseEnvelopeResultRulesActionSkip                  RuleDeleteResponseEnvelopeResultRulesAction = "skip"
	RuleDeleteResponseEnvelopeResultRulesActionTransformResponseHTML RuleDeleteResponseEnvelopeResultRulesAction = "transform_response_html"
)

func (RuleDeleteResponseEnvelopeResultRulesAction) IsKnown added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsChallengeRule added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsChallengeRule 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 RuleDeleteResponseEnvelopeResultRulesRulesetsChallengeRuleAction `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 RuleDeleteResponseEnvelopeResultRulesRulesetsChallengeRuleExposedCredentialCheck `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 RuleDeleteResponseEnvelopeResultRulesRulesetsChallengeRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                                                         `json:"ref"`
	JSON ruleDeleteResponseEnvelopeResultRulesRulesetsChallengeRuleJSON `json:"-"`
}

func (*RuleDeleteResponseEnvelopeResultRulesRulesetsChallengeRule) UnmarshalJSON added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsChallengeRuleAction added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsChallengeRuleAction string

The action to perform when the rule matches.

const (
	RuleDeleteResponseEnvelopeResultRulesRulesetsChallengeRuleActionChallenge RuleDeleteResponseEnvelopeResultRulesRulesetsChallengeRuleAction = "challenge"
)

func (RuleDeleteResponseEnvelopeResultRulesRulesetsChallengeRuleAction) IsKnown added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsChallengeRuleExposedCredentialCheck added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsChallengeRuleExposedCredentialCheck 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               ruleDeleteResponseEnvelopeResultRulesRulesetsChallengeRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*RuleDeleteResponseEnvelopeResultRulesRulesetsChallengeRuleExposedCredentialCheck) UnmarshalJSON added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsChallengeRuleRatelimit added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsChallengeRuleRatelimit 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                    ruleDeleteResponseEnvelopeResultRulesRulesetsChallengeRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*RuleDeleteResponseEnvelopeResultRulesRulesetsChallengeRuleRatelimit) UnmarshalJSON added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsJSChallengeRule added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsJSChallengeRule 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 RuleDeleteResponseEnvelopeResultRulesRulesetsJSChallengeRuleAction `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 RuleDeleteResponseEnvelopeResultRulesRulesetsJSChallengeRuleExposedCredentialCheck `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 RuleDeleteResponseEnvelopeResultRulesRulesetsJSChallengeRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                                                           `json:"ref"`
	JSON ruleDeleteResponseEnvelopeResultRulesRulesetsJSChallengeRuleJSON `json:"-"`
}

func (*RuleDeleteResponseEnvelopeResultRulesRulesetsJSChallengeRule) UnmarshalJSON added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsJSChallengeRuleAction added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsJSChallengeRuleAction string

The action to perform when the rule matches.

const (
	RuleDeleteResponseEnvelopeResultRulesRulesetsJSChallengeRuleActionJSChallenge RuleDeleteResponseEnvelopeResultRulesRulesetsJSChallengeRuleAction = "js_challenge"
)

func (RuleDeleteResponseEnvelopeResultRulesRulesetsJSChallengeRuleAction) IsKnown added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsJSChallengeRuleExposedCredentialCheck added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsJSChallengeRuleExposedCredentialCheck 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               ruleDeleteResponseEnvelopeResultRulesRulesetsJSChallengeRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*RuleDeleteResponseEnvelopeResultRulesRulesetsJSChallengeRuleExposedCredentialCheck) UnmarshalJSON added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsJSChallengeRuleRatelimit added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsJSChallengeRuleRatelimit 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                    ruleDeleteResponseEnvelopeResultRulesRulesetsJSChallengeRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*RuleDeleteResponseEnvelopeResultRulesRulesetsJSChallengeRuleRatelimit) UnmarshalJSON added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRule added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRule 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 RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleAction `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParameters `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 RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleExposedCredentialCheck `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 RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                                                               `json:"ref"`
	JSON ruleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleJSON `json:"-"`
}

func (*RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRule) UnmarshalJSON added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleAction added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleAction string

The action to perform when the rule matches.

const (
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionSetCacheControl RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleAction = "set_cache_control"
)

func (RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleAction) IsKnown added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParameters added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParameters struct {
	// A cache-control directive configuration.
	Immutable RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutable `json:"immutable"`
	// A cache-control directive configuration that accepts a duration value in
	// seconds.
	MaxAge RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAge `json:"max-age"`
	// A cache-control directive configuration.
	MustRevalidate RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate `json:"must-revalidate"`
	// A cache-control directive configuration.
	MustUnderstand RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand `json:"must-understand"`
	// A cache-control directive configuration that accepts optional qualifiers (header
	// names).
	NoCache RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCache `json:"no-cache"`
	// A cache-control directive configuration.
	NoStore RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStore `json:"no-store"`
	// A cache-control directive configuration.
	NoTransform RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransform `json:"no-transform"`
	// A cache-control directive configuration that accepts optional qualifiers (header
	// names).
	Private RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivate `json:"private"`
	// A cache-control directive configuration.
	ProxyRevalidate RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate `json:"proxy-revalidate"`
	// A cache-control directive configuration.
	Public RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublic `json:"public"`
	// A cache-control directive configuration that accepts a duration value in
	// seconds.
	SMaxage RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxage `json:"s-maxage"`
	// A cache-control directive configuration that accepts a duration value in
	// seconds.
	StaleIfError RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfError `json:"stale-if-error"`
	// A cache-control directive configuration that accepts a duration value in
	// seconds.
	StaleWhileRevalidate RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate `json:"stale-while-revalidate"`
	JSON                 ruleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersJSON                 `json:"-"`
}

The parameters configuring the rule's action.

func (*RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParameters) UnmarshalJSON added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutable added in v7.9.0

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

A cache-control directive configuration.

func (*RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutable) UnmarshalJSON added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation string

The operation to perform on the cache-control directive.

const (
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableOperationSet    RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation = "set"
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableOperationRemove RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation = "remove"
)

func (RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation) IsKnown added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective added in v7.9.0

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

Remove the directive.

func (*RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective) UnmarshalJSON added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperationSet    RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation = "set"
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperationRemove RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation = "remove"
)

func (RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation) IsKnown added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective added in v7.9.0

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

Set the directive.

func (*RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective) UnmarshalJSON added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperationSet    RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation = "set"
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperationRemove RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation = "remove"
)

func (RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation) IsKnown added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableUnion added in v7.9.0

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

A cache-control directive configuration.

Union satisfied by RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective or RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective.

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAge added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAge struct {
	// The operation to perform on the cache-control directive.
	Operation RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation `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  ruleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeJSON `json:"-"`
	// contains filtered or unexported fields
}

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

func (*RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAge) UnmarshalJSON added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation string

The operation to perform on the cache-control directive.

const (
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperationSet    RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation = "set"
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperationRemove RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation = "remove"
)

func (RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation) IsKnown added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective added in v7.9.0

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

Remove the directive.

func (*RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective) UnmarshalJSON added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperationSet    RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation = "set"
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperationRemove RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation = "remove"
)

func (RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation) IsKnown added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation `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           ruleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveJSON `json:"-"`
}

Set the directive with a duration value in seconds.

func (*RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective) UnmarshalJSON added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperationSet    RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation = "set"
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperationRemove RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation = "remove"
)

func (RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation) IsKnown added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeUnion added in v7.9.0

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

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

Union satisfied by RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective or RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective.

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate added in v7.9.0

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

A cache-control directive configuration.

func (*RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate) UnmarshalJSON added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation string

The operation to perform on the cache-control directive.

const (
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperationSet    RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation = "set"
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperationRemove RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation = "remove"
)

func (RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation) IsKnown added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective added in v7.9.0

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

Remove the directive.

func (*RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective) UnmarshalJSON added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperationSet    RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation = "set"
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperationRemove RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation = "remove"
)

func (RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation) IsKnown added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective added in v7.9.0

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

Set the directive.

func (*RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective) UnmarshalJSON added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperationSet    RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation = "set"
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperationRemove RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation = "remove"
)

func (RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation) IsKnown added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateUnion added in v7.9.0

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

A cache-control directive configuration.

Union satisfied by RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective or RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective.

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand added in v7.9.0

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

A cache-control directive configuration.

func (*RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand) UnmarshalJSON added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation string

The operation to perform on the cache-control directive.

const (
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperationSet    RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation = "set"
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperationRemove RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation = "remove"
)

func (RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation) IsKnown added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective added in v7.9.0

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

Remove the directive.

func (*RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective) UnmarshalJSON added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperationSet    RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation = "set"
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperationRemove RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation = "remove"
)

func (RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation) IsKnown added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective added in v7.9.0

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

Set the directive.

func (*RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective) UnmarshalJSON added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperationSet    RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation = "set"
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperationRemove RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation = "remove"
)

func (RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation) IsKnown added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandUnion added in v7.9.0

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

A cache-control directive configuration.

Union satisfied by RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective or RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective.

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCache added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCache struct {
	// The operation to perform on the cache-control directive.
	Operation RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation `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       ruleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheJSON `json:"-"`
	// contains filtered or unexported fields
}

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

func (*RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCache) UnmarshalJSON added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation string

The operation to perform on the cache-control directive.

const (
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperationSet    RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation = "set"
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperationRemove RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation = "remove"
)

func (RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation) IsKnown added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective added in v7.9.0

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

Remove the directive.

func (*RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective) UnmarshalJSON added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperationSet    RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation = "set"
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperationRemove RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation = "remove"
)

func (RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation) IsKnown added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation `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       ruleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveJSON `json:"-"`
}

Set the directive with optional qualifiers.

func (*RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective) UnmarshalJSON added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperationSet    RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation = "set"
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperationRemove RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation = "remove"
)

func (RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation) IsKnown added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheUnion added in v7.9.0

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

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

Union satisfied by RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective or RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective.

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStore added in v7.9.0

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

A cache-control directive configuration.

func (*RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStore) UnmarshalJSON added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation string

The operation to perform on the cache-control directive.

const (
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperationSet    RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation = "set"
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperationRemove RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation = "remove"
)

func (RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation) IsKnown added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective added in v7.9.0

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

Remove the directive.

func (*RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective) UnmarshalJSON added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperationSet    RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation = "set"
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperationRemove RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation = "remove"
)

func (RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation) IsKnown added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective added in v7.9.0

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

Set the directive.

func (*RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective) UnmarshalJSON added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperationSet    RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation = "set"
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperationRemove RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation = "remove"
)

func (RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation) IsKnown added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreUnion added in v7.9.0

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

A cache-control directive configuration.

Union satisfied by RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective or RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective.

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransform added in v7.9.0

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

A cache-control directive configuration.

func (*RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransform) UnmarshalJSON added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation string

The operation to perform on the cache-control directive.

const (
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperationSet    RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation = "set"
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperationRemove RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation = "remove"
)

func (RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation) IsKnown added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective added in v7.9.0

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

Remove the directive.

func (*RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective) UnmarshalJSON added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperationSet    RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation = "set"
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperationRemove RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation = "remove"
)

func (RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation) IsKnown added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective added in v7.9.0

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

Set the directive.

func (*RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective) UnmarshalJSON added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperationSet    RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation = "set"
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperationRemove RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation = "remove"
)

func (RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation) IsKnown added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformUnion added in v7.9.0

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

A cache-control directive configuration.

Union satisfied by RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective or RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective.

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivate added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivate struct {
	// The operation to perform on the cache-control directive.
	Operation RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation `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       ruleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateJSON `json:"-"`
	// contains filtered or unexported fields
}

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

func (*RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivate) UnmarshalJSON added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation string

The operation to perform on the cache-control directive.

const (
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateOperationSet    RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation = "set"
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateOperationRemove RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation = "remove"
)

func (RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation) IsKnown added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective added in v7.9.0

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

Remove the directive.

func (*RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective) UnmarshalJSON added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperationSet    RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation = "set"
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperationRemove RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation = "remove"
)

func (RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation) IsKnown added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation `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       ruleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveJSON `json:"-"`
}

Set the directive with optional qualifiers.

func (*RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective) UnmarshalJSON added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperationSet    RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation = "set"
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperationRemove RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation = "remove"
)

func (RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation) IsKnown added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateUnion added in v7.9.0

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

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

Union satisfied by RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective or RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective.

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate added in v7.9.0

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

A cache-control directive configuration.

func (*RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate) UnmarshalJSON added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation string

The operation to perform on the cache-control directive.

const (
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperationSet    RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation = "set"
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperationRemove RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation = "remove"
)

func (RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation) IsKnown added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective added in v7.9.0

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

Remove the directive.

func (*RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective) UnmarshalJSON added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperationSet    RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation = "set"
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperationRemove RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation = "remove"
)

func (RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation) IsKnown added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective added in v7.9.0

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

Set the directive.

func (*RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective) UnmarshalJSON added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperationSet    RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation = "set"
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperationRemove RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation = "remove"
)

func (RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation) IsKnown added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateUnion added in v7.9.0

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

A cache-control directive configuration.

Union satisfied by RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective or RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective.

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublic added in v7.9.0

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

A cache-control directive configuration.

func (*RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublic) UnmarshalJSON added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicOperation added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicOperation string

The operation to perform on the cache-control directive.

const (
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicOperationSet    RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicOperation = "set"
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicOperationRemove RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicOperation = "remove"
)

func (RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicOperation) IsKnown added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective added in v7.9.0

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

Remove the directive.

func (*RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective) UnmarshalJSON added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperationSet    RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation = "set"
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperationRemove RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation = "remove"
)

func (RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation) IsKnown added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective added in v7.9.0

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

Set the directive.

func (*RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective) UnmarshalJSON added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperationSet    RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation = "set"
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperationRemove RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation = "remove"
)

func (RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation) IsKnown added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicUnion added in v7.9.0

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

A cache-control directive configuration.

Union satisfied by RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective or RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective.

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxage added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxage struct {
	// The operation to perform on the cache-control directive.
	Operation RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation `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  ruleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageJSON `json:"-"`
	// contains filtered or unexported fields
}

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

func (*RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxage) UnmarshalJSON added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation string

The operation to perform on the cache-control directive.

const (
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperationSet    RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation = "set"
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperationRemove RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation = "remove"
)

func (RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation) IsKnown added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective added in v7.9.0

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

Remove the directive.

func (*RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective) UnmarshalJSON added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperationSet    RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation = "set"
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperationRemove RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation = "remove"
)

func (RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation) IsKnown added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation `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           ruleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveJSON `json:"-"`
}

Set the directive with a duration value in seconds.

func (*RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective) UnmarshalJSON added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperationSet    RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation = "set"
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperationRemove RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation = "remove"
)

func (RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation) IsKnown added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageUnion added in v7.9.0

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

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

Union satisfied by RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective or RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective.

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfError added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfError struct {
	// The operation to perform on the cache-control directive.
	Operation RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation `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  ruleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorJSON `json:"-"`
	// contains filtered or unexported fields
}

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

func (*RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfError) UnmarshalJSON added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation string

The operation to perform on the cache-control directive.

const (
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperationSet    RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation = "set"
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperationRemove RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation = "remove"
)

func (RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation) IsKnown added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective added in v7.9.0

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

Remove the directive.

func (*RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective) UnmarshalJSON added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperationSet    RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation = "set"
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperationRemove RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation = "remove"
)

func (RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation) IsKnown added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation `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           ruleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveJSON `json:"-"`
}

Set the directive with a duration value in seconds.

func (*RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective) UnmarshalJSON added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperationSet    RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation = "set"
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperationRemove RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation = "remove"
)

func (RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation) IsKnown added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorUnion added in v7.9.0

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

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

Union satisfied by RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective or RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective.

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate struct {
	// The operation to perform on the cache-control directive.
	Operation RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation `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  ruleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateJSON `json:"-"`
	// contains filtered or unexported fields
}

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

func (*RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate) UnmarshalJSON added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation string

The operation to perform on the cache-control directive.

const (
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperationSet    RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation = "set"
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperationRemove RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation = "remove"
)

func (RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation) IsKnown added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective added in v7.9.0

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

Remove the directive.

func (*RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective) UnmarshalJSON added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperationSet    RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation = "set"
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperationRemove RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation = "remove"
)

func (RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation) IsKnown added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation `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           ruleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveJSON `json:"-"`
}

Set the directive with a duration value in seconds.

func (*RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective) UnmarshalJSON added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperationSet    RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation = "set"
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperationRemove RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation = "remove"
)

func (RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation) IsKnown added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateUnion added in v7.9.0

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

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

Union satisfied by RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective or RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective.

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleExposedCredentialCheck added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleExposedCredentialCheck 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               ruleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleExposedCredentialCheck) UnmarshalJSON added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleRatelimit added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleRatelimit 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                    ruleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheControlRuleRatelimit) UnmarshalJSON added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRule added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRule 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 RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleAction `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParameters `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 RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleExposedCredentialCheck `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 RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                                                            `json:"ref"`
	JSON ruleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleJSON `json:"-"`
}

func (*RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRule) UnmarshalJSON added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleAction added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleAction string

The action to perform when the rule matches.

const (
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionSetCacheTags RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleAction = "set_cache_tags"
)

func (RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleAction) IsKnown added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParameters added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParameters struct {
	// The operation to perform on the cache tags.
	Operation RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersOperation `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   ruleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersJSON `json:"-"`
	// contains filtered or unexported fields
}

The parameters configuring the rule's action.

func (*RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParameters) UnmarshalJSON added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression 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 RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation `json:"operation" api:"required"`
	JSON      ruleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionJSON      `json:"-"`
}

Add cache tags using an expression.

func (*RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression) UnmarshalJSON added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation string

The operation to perform on the cache tags.

const (
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationAdd    RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "add"
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationRemove RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "remove"
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationSet    RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "set"
)

func (RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation) IsKnown added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues added in v7.9.0

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

Add cache tags using a list of values.

func (*RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues) UnmarshalJSON added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation string

The operation to perform on the cache tags.

const (
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationAdd    RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "add"
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationRemove RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "remove"
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationSet    RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "set"
)

func (RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation) IsKnown added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersOperation added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersOperation string

The operation to perform on the cache tags.

const (
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersOperationAdd    RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersOperation = "add"
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersOperationRemove RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersOperation = "remove"
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersOperationSet    RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersOperation = "set"
)

func (RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersOperation) IsKnown added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression 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 RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation `json:"operation" api:"required"`
	JSON      ruleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionJSON      `json:"-"`
}

Remove cache tags using an expression.

func (*RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression) UnmarshalJSON added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation string

The operation to perform on the cache tags.

const (
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationAdd    RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "add"
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationRemove RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "remove"
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationSet    RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "set"
)

func (RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation) IsKnown added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues added in v7.9.0

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

Remove cache tags using a list of values.

func (*RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues) UnmarshalJSON added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation string

The operation to perform on the cache tags.

const (
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationAdd    RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "add"
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationRemove RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "remove"
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationSet    RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "set"
)

func (RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation) IsKnown added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression 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 RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation `json:"operation" api:"required"`
	JSON      ruleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionJSON      `json:"-"`
}

Set cache tags using an expression.

func (*RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression) UnmarshalJSON added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation string

The operation to perform on the cache tags.

const (
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationAdd    RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "add"
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationRemove RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "remove"
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationSet    RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "set"
)

func (RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation) IsKnown added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues added in v7.9.0

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

Set cache tags using a list of values.

func (*RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues) UnmarshalJSON added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation string

The operation to perform on the cache tags.

const (
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationAdd    RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "add"
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationRemove RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "remove"
	RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationSet    RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "set"
)

func (RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation) IsKnown added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleExposedCredentialCheck added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleExposedCredentialCheck 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               ruleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleExposedCredentialCheck) UnmarshalJSON added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleRatelimit added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleRatelimit 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                    ruleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*RuleDeleteResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleRatelimit) UnmarshalJSON added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRule added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRule 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 RuleDeleteResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleAction `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters RuleDeleteResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleActionParameters `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 RuleDeleteResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleExposedCredentialCheck `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 RuleDeleteResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                                                                     `json:"ref"`
	JSON ruleDeleteResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleJSON `json:"-"`
}

func (*RuleDeleteResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRule) UnmarshalJSON added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleAction added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleAction string

The action to perform when the rule matches.

const (
	RuleDeleteResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleActionTransformResponseHTML RuleDeleteResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleAction = "transform_response_html"
)

func (RuleDeleteResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleAction) IsKnown added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleActionParameters added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleActionParameters struct {
	// Enables the link maze transformation on the response.
	LinkMaze interface{}                                                                                `json:"link_maze" api:"required"`
	JSON     ruleDeleteResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleActionParametersJSON `json:"-"`
}

The parameters configuring the rule's action.

func (*RuleDeleteResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleActionParameters) UnmarshalJSON added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleExposedCredentialCheck added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleExposedCredentialCheck 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               ruleDeleteResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*RuleDeleteResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleExposedCredentialCheck) UnmarshalJSON added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleRatelimit added in v7.9.0

type RuleDeleteResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleRatelimit 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                    ruleDeleteResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*RuleDeleteResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleRatelimit) UnmarshalJSON added in v7.9.0

type RuleDeleteResponseEnvelopeSuccess

type RuleDeleteResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	RuleDeleteResponseEnvelopeSuccessTrue RuleDeleteResponseEnvelopeSuccess = true
)

func (RuleDeleteResponseEnvelopeSuccess) IsKnown

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"`
	// Validates the request without persisting changes when set to `true`. Responses
	// that normally return 200 return `result: null`; endpoints that normally return
	// 204 continue to return 204.
	DryRun param.Field[bool] `query:"dry_run"`
}

func (RuleEditParams) MarshalJSON

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

func (RuleEditParams) URLQuery added in v7.9.0

func (r RuleEditParams) URLQuery() (v url.Values)

URLQuery serializes RuleEditParams's query parameters as `url.Values`.

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"
	RuleEditParamsBodyActionTransformResponseHTML RuleEditParamsBodyAction = "transform_response_html"
)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

type RuleEditParamsBodySetCacheControlRuleAction

type RuleEditParamsBodySetCacheControlRuleAction string

The action to perform when the rule matches.

const (
	RuleEditParamsBodySetCacheControlRuleActionSetCacheControl RuleEditParamsBodySetCacheControlRuleAction = "set_cache_control"
)

func (RuleEditParamsBodySetCacheControlRuleAction) IsKnown

type RuleEditParamsBodySetCacheControlRuleActionParameters

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

type RuleEditParamsBodySetCacheControlRuleActionParametersImmutable

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

type RuleEditParamsBodySetCacheControlRuleActionParametersImmutableOperation

type RuleEditParamsBodySetCacheControlRuleActionParametersImmutableOperation string

The operation to perform on the cache-control directive.

const (
	RuleEditParamsBodySetCacheControlRuleActionParametersImmutableOperationSet    RuleEditParamsBodySetCacheControlRuleActionParametersImmutableOperation = "set"
	RuleEditParamsBodySetCacheControlRuleActionParametersImmutableOperationRemove RuleEditParamsBodySetCacheControlRuleActionParametersImmutableOperation = "remove"
)

func (RuleEditParamsBodySetCacheControlRuleActionParametersImmutableOperation) IsKnown

type RuleEditParamsBodySetCacheControlRuleActionParametersImmutableRemoveDirective

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

type RuleEditParamsBodySetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation

type RuleEditParamsBodySetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleEditParamsBodySetCacheControlRuleActionParametersImmutableRemoveDirectiveOperationSet    RuleEditParamsBodySetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation = "set"
	RuleEditParamsBodySetCacheControlRuleActionParametersImmutableRemoveDirectiveOperationRemove RuleEditParamsBodySetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation = "remove"
)

func (RuleEditParamsBodySetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation) IsKnown

type RuleEditParamsBodySetCacheControlRuleActionParametersImmutableSetDirective

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

type RuleEditParamsBodySetCacheControlRuleActionParametersImmutableSetDirectiveOperation

type RuleEditParamsBodySetCacheControlRuleActionParametersImmutableSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleEditParamsBodySetCacheControlRuleActionParametersImmutableSetDirectiveOperationSet    RuleEditParamsBodySetCacheControlRuleActionParametersImmutableSetDirectiveOperation = "set"
	RuleEditParamsBodySetCacheControlRuleActionParametersImmutableSetDirectiveOperationRemove RuleEditParamsBodySetCacheControlRuleActionParametersImmutableSetDirectiveOperation = "remove"
)

func (RuleEditParamsBodySetCacheControlRuleActionParametersImmutableSetDirectiveOperation) IsKnown

type RuleEditParamsBodySetCacheControlRuleActionParametersMaxAge

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

type RuleEditParamsBodySetCacheControlRuleActionParametersMaxAgeOperation

type RuleEditParamsBodySetCacheControlRuleActionParametersMaxAgeOperation string

The operation to perform on the cache-control directive.

const (
	RuleEditParamsBodySetCacheControlRuleActionParametersMaxAgeOperationSet    RuleEditParamsBodySetCacheControlRuleActionParametersMaxAgeOperation = "set"
	RuleEditParamsBodySetCacheControlRuleActionParametersMaxAgeOperationRemove RuleEditParamsBodySetCacheControlRuleActionParametersMaxAgeOperation = "remove"
)

func (RuleEditParamsBodySetCacheControlRuleActionParametersMaxAgeOperation) IsKnown

type RuleEditParamsBodySetCacheControlRuleActionParametersMaxAgeRemoveDirective

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

type RuleEditParamsBodySetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation

type RuleEditParamsBodySetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleEditParamsBodySetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperationSet    RuleEditParamsBodySetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation = "set"
	RuleEditParamsBodySetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperationRemove RuleEditParamsBodySetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation = "remove"
)

func (RuleEditParamsBodySetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation) IsKnown

type RuleEditParamsBodySetCacheControlRuleActionParametersMaxAgeSetDirective

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

type RuleEditParamsBodySetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation

type RuleEditParamsBodySetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleEditParamsBodySetCacheControlRuleActionParametersMaxAgeSetDirectiveOperationSet    RuleEditParamsBodySetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation = "set"
	RuleEditParamsBodySetCacheControlRuleActionParametersMaxAgeSetDirectiveOperationRemove RuleEditParamsBodySetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation = "remove"
)

func (RuleEditParamsBodySetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation) IsKnown

type RuleEditParamsBodySetCacheControlRuleActionParametersMaxAgeUnion

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

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

type RuleEditParamsBodySetCacheControlRuleActionParametersMustRevalidateOperation

type RuleEditParamsBodySetCacheControlRuleActionParametersMustRevalidateOperation string

The operation to perform on the cache-control directive.

const (
	RuleEditParamsBodySetCacheControlRuleActionParametersMustRevalidateOperationSet    RuleEditParamsBodySetCacheControlRuleActionParametersMustRevalidateOperation = "set"
	RuleEditParamsBodySetCacheControlRuleActionParametersMustRevalidateOperationRemove RuleEditParamsBodySetCacheControlRuleActionParametersMustRevalidateOperation = "remove"
)

func (RuleEditParamsBodySetCacheControlRuleActionParametersMustRevalidateOperation) IsKnown

type RuleEditParamsBodySetCacheControlRuleActionParametersMustRevalidateRemoveDirective

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

type RuleEditParamsBodySetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation

type RuleEditParamsBodySetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleEditParamsBodySetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperationSet    RuleEditParamsBodySetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation = "set"
	RuleEditParamsBodySetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperationRemove RuleEditParamsBodySetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation = "remove"
)

func (RuleEditParamsBodySetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation) IsKnown

type RuleEditParamsBodySetCacheControlRuleActionParametersMustRevalidateSetDirective

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

type RuleEditParamsBodySetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation

type RuleEditParamsBodySetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleEditParamsBodySetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperationSet    RuleEditParamsBodySetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation = "set"
	RuleEditParamsBodySetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperationRemove RuleEditParamsBodySetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation = "remove"
)

func (RuleEditParamsBodySetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation) IsKnown

type RuleEditParamsBodySetCacheControlRuleActionParametersMustUnderstand

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

type RuleEditParamsBodySetCacheControlRuleActionParametersMustUnderstandOperation

type RuleEditParamsBodySetCacheControlRuleActionParametersMustUnderstandOperation string

The operation to perform on the cache-control directive.

const (
	RuleEditParamsBodySetCacheControlRuleActionParametersMustUnderstandOperationSet    RuleEditParamsBodySetCacheControlRuleActionParametersMustUnderstandOperation = "set"
	RuleEditParamsBodySetCacheControlRuleActionParametersMustUnderstandOperationRemove RuleEditParamsBodySetCacheControlRuleActionParametersMustUnderstandOperation = "remove"
)

func (RuleEditParamsBodySetCacheControlRuleActionParametersMustUnderstandOperation) IsKnown

type RuleEditParamsBodySetCacheControlRuleActionParametersMustUnderstandRemoveDirective

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

type RuleEditParamsBodySetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation

type RuleEditParamsBodySetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleEditParamsBodySetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperationSet    RuleEditParamsBodySetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation = "set"
	RuleEditParamsBodySetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperationRemove RuleEditParamsBodySetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation = "remove"
)

func (RuleEditParamsBodySetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation) IsKnown

type RuleEditParamsBodySetCacheControlRuleActionParametersMustUnderstandSetDirective

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

type RuleEditParamsBodySetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation

type RuleEditParamsBodySetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleEditParamsBodySetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperationSet    RuleEditParamsBodySetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation = "set"
	RuleEditParamsBodySetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperationRemove RuleEditParamsBodySetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation = "remove"
)

func (RuleEditParamsBodySetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation) IsKnown

type RuleEditParamsBodySetCacheControlRuleActionParametersNoCache

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

type RuleEditParamsBodySetCacheControlRuleActionParametersNoCacheOperation

type RuleEditParamsBodySetCacheControlRuleActionParametersNoCacheOperation string

The operation to perform on the cache-control directive.

const (
	RuleEditParamsBodySetCacheControlRuleActionParametersNoCacheOperationSet    RuleEditParamsBodySetCacheControlRuleActionParametersNoCacheOperation = "set"
	RuleEditParamsBodySetCacheControlRuleActionParametersNoCacheOperationRemove RuleEditParamsBodySetCacheControlRuleActionParametersNoCacheOperation = "remove"
)

func (RuleEditParamsBodySetCacheControlRuleActionParametersNoCacheOperation) IsKnown

type RuleEditParamsBodySetCacheControlRuleActionParametersNoCacheRemoveDirective

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

type RuleEditParamsBodySetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation

type RuleEditParamsBodySetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleEditParamsBodySetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperationSet    RuleEditParamsBodySetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation = "set"
	RuleEditParamsBodySetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperationRemove RuleEditParamsBodySetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation = "remove"
)

func (RuleEditParamsBodySetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation) IsKnown

type RuleEditParamsBodySetCacheControlRuleActionParametersNoCacheSetDirective

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

type RuleEditParamsBodySetCacheControlRuleActionParametersNoCacheSetDirectiveOperation

type RuleEditParamsBodySetCacheControlRuleActionParametersNoCacheSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleEditParamsBodySetCacheControlRuleActionParametersNoCacheSetDirectiveOperationSet    RuleEditParamsBodySetCacheControlRuleActionParametersNoCacheSetDirectiveOperation = "set"
	RuleEditParamsBodySetCacheControlRuleActionParametersNoCacheSetDirectiveOperationRemove RuleEditParamsBodySetCacheControlRuleActionParametersNoCacheSetDirectiveOperation = "remove"
)

func (RuleEditParamsBodySetCacheControlRuleActionParametersNoCacheSetDirectiveOperation) IsKnown

type RuleEditParamsBodySetCacheControlRuleActionParametersNoCacheUnion

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

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

type RuleEditParamsBodySetCacheControlRuleActionParametersNoStoreOperation

type RuleEditParamsBodySetCacheControlRuleActionParametersNoStoreOperation string

The operation to perform on the cache-control directive.

const (
	RuleEditParamsBodySetCacheControlRuleActionParametersNoStoreOperationSet    RuleEditParamsBodySetCacheControlRuleActionParametersNoStoreOperation = "set"
	RuleEditParamsBodySetCacheControlRuleActionParametersNoStoreOperationRemove RuleEditParamsBodySetCacheControlRuleActionParametersNoStoreOperation = "remove"
)

func (RuleEditParamsBodySetCacheControlRuleActionParametersNoStoreOperation) IsKnown

type RuleEditParamsBodySetCacheControlRuleActionParametersNoStoreRemoveDirective

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

type RuleEditParamsBodySetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation

type RuleEditParamsBodySetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleEditParamsBodySetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperationSet    RuleEditParamsBodySetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation = "set"
	RuleEditParamsBodySetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperationRemove RuleEditParamsBodySetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation = "remove"
)

func (RuleEditParamsBodySetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation) IsKnown

type RuleEditParamsBodySetCacheControlRuleActionParametersNoStoreSetDirective

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

type RuleEditParamsBodySetCacheControlRuleActionParametersNoStoreSetDirectiveOperation

type RuleEditParamsBodySetCacheControlRuleActionParametersNoStoreSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleEditParamsBodySetCacheControlRuleActionParametersNoStoreSetDirectiveOperationSet    RuleEditParamsBodySetCacheControlRuleActionParametersNoStoreSetDirectiveOperation = "set"
	RuleEditParamsBodySetCacheControlRuleActionParametersNoStoreSetDirectiveOperationRemove RuleEditParamsBodySetCacheControlRuleActionParametersNoStoreSetDirectiveOperation = "remove"
)

func (RuleEditParamsBodySetCacheControlRuleActionParametersNoStoreSetDirectiveOperation) IsKnown

type RuleEditParamsBodySetCacheControlRuleActionParametersNoStoreUnion

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

A cache-control directive configuration.

Satisfied by rulesets.RuleEditParamsBodySetCacheControlRuleActionParametersNoStoreSetDirective, rulesets.RuleEditParamsBodySetCacheControlRuleActionParametersNoStoreRemoveDirective, RuleEditParamsBodySetCacheControlRuleActionParametersNoStore.

type RuleEditParamsBodySetCacheControlRuleActionParametersNoTransform

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

type RuleEditParamsBodySetCacheControlRuleActionParametersNoTransformOperation

type RuleEditParamsBodySetCacheControlRuleActionParametersNoTransformOperation string

The operation to perform on the cache-control directive.

const (
	RuleEditParamsBodySetCacheControlRuleActionParametersNoTransformOperationSet    RuleEditParamsBodySetCacheControlRuleActionParametersNoTransformOperation = "set"
	RuleEditParamsBodySetCacheControlRuleActionParametersNoTransformOperationRemove RuleEditParamsBodySetCacheControlRuleActionParametersNoTransformOperation = "remove"
)

func (RuleEditParamsBodySetCacheControlRuleActionParametersNoTransformOperation) IsKnown

type RuleEditParamsBodySetCacheControlRuleActionParametersNoTransformRemoveDirective

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

type RuleEditParamsBodySetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation

type RuleEditParamsBodySetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleEditParamsBodySetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperationSet    RuleEditParamsBodySetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation = "set"
	RuleEditParamsBodySetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperationRemove RuleEditParamsBodySetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation = "remove"
)

func (RuleEditParamsBodySetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation) IsKnown

type RuleEditParamsBodySetCacheControlRuleActionParametersNoTransformSetDirective

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

type RuleEditParamsBodySetCacheControlRuleActionParametersNoTransformSetDirectiveOperation

type RuleEditParamsBodySetCacheControlRuleActionParametersNoTransformSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleEditParamsBodySetCacheControlRuleActionParametersNoTransformSetDirectiveOperationSet    RuleEditParamsBodySetCacheControlRuleActionParametersNoTransformSetDirectiveOperation = "set"
	RuleEditParamsBodySetCacheControlRuleActionParametersNoTransformSetDirectiveOperationRemove RuleEditParamsBodySetCacheControlRuleActionParametersNoTransformSetDirectiveOperation = "remove"
)

func (RuleEditParamsBodySetCacheControlRuleActionParametersNoTransformSetDirectiveOperation) IsKnown

type RuleEditParamsBodySetCacheControlRuleActionParametersPrivate

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

type RuleEditParamsBodySetCacheControlRuleActionParametersPrivateOperation

type RuleEditParamsBodySetCacheControlRuleActionParametersPrivateOperation string

The operation to perform on the cache-control directive.

const (
	RuleEditParamsBodySetCacheControlRuleActionParametersPrivateOperationSet    RuleEditParamsBodySetCacheControlRuleActionParametersPrivateOperation = "set"
	RuleEditParamsBodySetCacheControlRuleActionParametersPrivateOperationRemove RuleEditParamsBodySetCacheControlRuleActionParametersPrivateOperation = "remove"
)

func (RuleEditParamsBodySetCacheControlRuleActionParametersPrivateOperation) IsKnown

type RuleEditParamsBodySetCacheControlRuleActionParametersPrivateRemoveDirective

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

type RuleEditParamsBodySetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation

type RuleEditParamsBodySetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleEditParamsBodySetCacheControlRuleActionParametersPrivateRemoveDirectiveOperationSet    RuleEditParamsBodySetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation = "set"
	RuleEditParamsBodySetCacheControlRuleActionParametersPrivateRemoveDirectiveOperationRemove RuleEditParamsBodySetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation = "remove"
)

func (RuleEditParamsBodySetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation) IsKnown

type RuleEditParamsBodySetCacheControlRuleActionParametersPrivateSetDirective

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

type RuleEditParamsBodySetCacheControlRuleActionParametersPrivateSetDirectiveOperation

type RuleEditParamsBodySetCacheControlRuleActionParametersPrivateSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleEditParamsBodySetCacheControlRuleActionParametersPrivateSetDirectiveOperationSet    RuleEditParamsBodySetCacheControlRuleActionParametersPrivateSetDirectiveOperation = "set"
	RuleEditParamsBodySetCacheControlRuleActionParametersPrivateSetDirectiveOperationRemove RuleEditParamsBodySetCacheControlRuleActionParametersPrivateSetDirectiveOperation = "remove"
)

func (RuleEditParamsBodySetCacheControlRuleActionParametersPrivateSetDirectiveOperation) IsKnown

type RuleEditParamsBodySetCacheControlRuleActionParametersPrivateUnion

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

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

type RuleEditParamsBodySetCacheControlRuleActionParametersProxyRevalidateOperation

type RuleEditParamsBodySetCacheControlRuleActionParametersProxyRevalidateOperation string

The operation to perform on the cache-control directive.

const (
	RuleEditParamsBodySetCacheControlRuleActionParametersProxyRevalidateOperationSet    RuleEditParamsBodySetCacheControlRuleActionParametersProxyRevalidateOperation = "set"
	RuleEditParamsBodySetCacheControlRuleActionParametersProxyRevalidateOperationRemove RuleEditParamsBodySetCacheControlRuleActionParametersProxyRevalidateOperation = "remove"
)

func (RuleEditParamsBodySetCacheControlRuleActionParametersProxyRevalidateOperation) IsKnown

type RuleEditParamsBodySetCacheControlRuleActionParametersProxyRevalidateRemoveDirective

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

type RuleEditParamsBodySetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation

type RuleEditParamsBodySetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleEditParamsBodySetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperationSet    RuleEditParamsBodySetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation = "set"
	RuleEditParamsBodySetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperationRemove RuleEditParamsBodySetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation = "remove"
)

func (RuleEditParamsBodySetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation) IsKnown

type RuleEditParamsBodySetCacheControlRuleActionParametersProxyRevalidateSetDirective

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

type RuleEditParamsBodySetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation

type RuleEditParamsBodySetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleEditParamsBodySetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperationSet    RuleEditParamsBodySetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation = "set"
	RuleEditParamsBodySetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperationRemove RuleEditParamsBodySetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation = "remove"
)

func (RuleEditParamsBodySetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation) IsKnown

type RuleEditParamsBodySetCacheControlRuleActionParametersPublic

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

type RuleEditParamsBodySetCacheControlRuleActionParametersPublicOperation

type RuleEditParamsBodySetCacheControlRuleActionParametersPublicOperation string

The operation to perform on the cache-control directive.

const (
	RuleEditParamsBodySetCacheControlRuleActionParametersPublicOperationSet    RuleEditParamsBodySetCacheControlRuleActionParametersPublicOperation = "set"
	RuleEditParamsBodySetCacheControlRuleActionParametersPublicOperationRemove RuleEditParamsBodySetCacheControlRuleActionParametersPublicOperation = "remove"
)

func (RuleEditParamsBodySetCacheControlRuleActionParametersPublicOperation) IsKnown

type RuleEditParamsBodySetCacheControlRuleActionParametersPublicRemoveDirective

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

type RuleEditParamsBodySetCacheControlRuleActionParametersPublicRemoveDirectiveOperation

type RuleEditParamsBodySetCacheControlRuleActionParametersPublicRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleEditParamsBodySetCacheControlRuleActionParametersPublicRemoveDirectiveOperationSet    RuleEditParamsBodySetCacheControlRuleActionParametersPublicRemoveDirectiveOperation = "set"
	RuleEditParamsBodySetCacheControlRuleActionParametersPublicRemoveDirectiveOperationRemove RuleEditParamsBodySetCacheControlRuleActionParametersPublicRemoveDirectiveOperation = "remove"
)

func (RuleEditParamsBodySetCacheControlRuleActionParametersPublicRemoveDirectiveOperation) IsKnown

type RuleEditParamsBodySetCacheControlRuleActionParametersPublicSetDirective

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

type RuleEditParamsBodySetCacheControlRuleActionParametersPublicSetDirectiveOperation

type RuleEditParamsBodySetCacheControlRuleActionParametersPublicSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleEditParamsBodySetCacheControlRuleActionParametersPublicSetDirectiveOperationSet    RuleEditParamsBodySetCacheControlRuleActionParametersPublicSetDirectiveOperation = "set"
	RuleEditParamsBodySetCacheControlRuleActionParametersPublicSetDirectiveOperationRemove RuleEditParamsBodySetCacheControlRuleActionParametersPublicSetDirectiveOperation = "remove"
)

func (RuleEditParamsBodySetCacheControlRuleActionParametersPublicSetDirectiveOperation) IsKnown

type RuleEditParamsBodySetCacheControlRuleActionParametersPublicUnion

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

A cache-control directive configuration.

Satisfied by rulesets.RuleEditParamsBodySetCacheControlRuleActionParametersPublicSetDirective, rulesets.RuleEditParamsBodySetCacheControlRuleActionParametersPublicRemoveDirective, RuleEditParamsBodySetCacheControlRuleActionParametersPublic.

type RuleEditParamsBodySetCacheControlRuleActionParametersSMaxage

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

type RuleEditParamsBodySetCacheControlRuleActionParametersSMaxageOperation

type RuleEditParamsBodySetCacheControlRuleActionParametersSMaxageOperation string

The operation to perform on the cache-control directive.

const (
	RuleEditParamsBodySetCacheControlRuleActionParametersSMaxageOperationSet    RuleEditParamsBodySetCacheControlRuleActionParametersSMaxageOperation = "set"
	RuleEditParamsBodySetCacheControlRuleActionParametersSMaxageOperationRemove RuleEditParamsBodySetCacheControlRuleActionParametersSMaxageOperation = "remove"
)

func (RuleEditParamsBodySetCacheControlRuleActionParametersSMaxageOperation) IsKnown

type RuleEditParamsBodySetCacheControlRuleActionParametersSMaxageRemoveDirective

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

type RuleEditParamsBodySetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation

type RuleEditParamsBodySetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleEditParamsBodySetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperationSet    RuleEditParamsBodySetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation = "set"
	RuleEditParamsBodySetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperationRemove RuleEditParamsBodySetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation = "remove"
)

func (RuleEditParamsBodySetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation) IsKnown

type RuleEditParamsBodySetCacheControlRuleActionParametersSMaxageSetDirective

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

type RuleEditParamsBodySetCacheControlRuleActionParametersSMaxageSetDirectiveOperation

type RuleEditParamsBodySetCacheControlRuleActionParametersSMaxageSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleEditParamsBodySetCacheControlRuleActionParametersSMaxageSetDirectiveOperationSet    RuleEditParamsBodySetCacheControlRuleActionParametersSMaxageSetDirectiveOperation = "set"
	RuleEditParamsBodySetCacheControlRuleActionParametersSMaxageSetDirectiveOperationRemove RuleEditParamsBodySetCacheControlRuleActionParametersSMaxageSetDirectiveOperation = "remove"
)

func (RuleEditParamsBodySetCacheControlRuleActionParametersSMaxageSetDirectiveOperation) IsKnown

type RuleEditParamsBodySetCacheControlRuleActionParametersSMaxageUnion

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

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

type RuleEditParamsBodySetCacheControlRuleActionParametersStaleIfErrorOperation

type RuleEditParamsBodySetCacheControlRuleActionParametersStaleIfErrorOperation string

The operation to perform on the cache-control directive.

const (
	RuleEditParamsBodySetCacheControlRuleActionParametersStaleIfErrorOperationSet    RuleEditParamsBodySetCacheControlRuleActionParametersStaleIfErrorOperation = "set"
	RuleEditParamsBodySetCacheControlRuleActionParametersStaleIfErrorOperationRemove RuleEditParamsBodySetCacheControlRuleActionParametersStaleIfErrorOperation = "remove"
)

func (RuleEditParamsBodySetCacheControlRuleActionParametersStaleIfErrorOperation) IsKnown

type RuleEditParamsBodySetCacheControlRuleActionParametersStaleIfErrorRemoveDirective

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

type RuleEditParamsBodySetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation

type RuleEditParamsBodySetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleEditParamsBodySetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperationSet    RuleEditParamsBodySetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation = "set"
	RuleEditParamsBodySetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperationRemove RuleEditParamsBodySetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation = "remove"
)

func (RuleEditParamsBodySetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation) IsKnown

type RuleEditParamsBodySetCacheControlRuleActionParametersStaleIfErrorSetDirective

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

type RuleEditParamsBodySetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation

type RuleEditParamsBodySetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleEditParamsBodySetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperationSet    RuleEditParamsBodySetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation = "set"
	RuleEditParamsBodySetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperationRemove RuleEditParamsBodySetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation = "remove"
)

func (RuleEditParamsBodySetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation) IsKnown

type RuleEditParamsBodySetCacheControlRuleActionParametersStaleIfErrorUnion

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

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

type RuleEditParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateOperation

type RuleEditParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateOperation string

The operation to perform on the cache-control directive.

const (
	RuleEditParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateOperationSet    RuleEditParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateOperation = "set"
	RuleEditParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateOperationRemove RuleEditParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateOperation = "remove"
)

func (RuleEditParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateOperation) IsKnown

type RuleEditParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective

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

type RuleEditParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation

type RuleEditParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleEditParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperationSet    RuleEditParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation = "set"
	RuleEditParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperationRemove RuleEditParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation = "remove"
)

func (RuleEditParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation) IsKnown

type RuleEditParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective

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

type RuleEditParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation

type RuleEditParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleEditParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperationSet    RuleEditParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation = "set"
	RuleEditParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperationRemove RuleEditParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation = "remove"
)

func (RuleEditParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation) IsKnown

type RuleEditParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateUnion

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

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

type RuleEditParamsBodySetCacheControlRulePosition

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

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

type RuleEditParamsBodySetCacheControlRulePositionAfterPosition

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

type RuleEditParamsBodySetCacheControlRulePositionBeforePosition

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

type RuleEditParamsBodySetCacheControlRulePositionIndexPosition

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

type RuleEditParamsBodySetCacheControlRuleRatelimit

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

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

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

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

type RuleEditParamsBodySetCacheTagsRule

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

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

type RuleEditParamsBodySetCacheTagsRuleAction

type RuleEditParamsBodySetCacheTagsRuleAction string

The action to perform when the rule matches.

const (
	RuleEditParamsBodySetCacheTagsRuleActionSetCacheTags RuleEditParamsBodySetCacheTagsRuleAction = "set_cache_tags"
)

func (RuleEditParamsBodySetCacheTagsRuleAction) IsKnown

type RuleEditParamsBodySetCacheTagsRuleActionParameters

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

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

type RuleEditParamsBodySetCacheTagsRuleActionParametersAddCacheTagsExpression

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

type RuleEditParamsBodySetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation

type RuleEditParamsBodySetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation string

The operation to perform on the cache tags.

const (
	RuleEditParamsBodySetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationAdd    RuleEditParamsBodySetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "add"
	RuleEditParamsBodySetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationRemove RuleEditParamsBodySetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "remove"
	RuleEditParamsBodySetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationSet    RuleEditParamsBodySetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "set"
)

func (RuleEditParamsBodySetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation) IsKnown

type RuleEditParamsBodySetCacheTagsRuleActionParametersAddCacheTagsValues

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

type RuleEditParamsBodySetCacheTagsRuleActionParametersAddCacheTagsValuesOperation

type RuleEditParamsBodySetCacheTagsRuleActionParametersAddCacheTagsValuesOperation string

The operation to perform on the cache tags.

const (
	RuleEditParamsBodySetCacheTagsRuleActionParametersAddCacheTagsValuesOperationAdd    RuleEditParamsBodySetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "add"
	RuleEditParamsBodySetCacheTagsRuleActionParametersAddCacheTagsValuesOperationRemove RuleEditParamsBodySetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "remove"
	RuleEditParamsBodySetCacheTagsRuleActionParametersAddCacheTagsValuesOperationSet    RuleEditParamsBodySetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "set"
)

func (RuleEditParamsBodySetCacheTagsRuleActionParametersAddCacheTagsValuesOperation) IsKnown

type RuleEditParamsBodySetCacheTagsRuleActionParametersOperation

type RuleEditParamsBodySetCacheTagsRuleActionParametersOperation string

The operation to perform on the cache tags.

const (
	RuleEditParamsBodySetCacheTagsRuleActionParametersOperationAdd    RuleEditParamsBodySetCacheTagsRuleActionParametersOperation = "add"
	RuleEditParamsBodySetCacheTagsRuleActionParametersOperationRemove RuleEditParamsBodySetCacheTagsRuleActionParametersOperation = "remove"
	RuleEditParamsBodySetCacheTagsRuleActionParametersOperationSet    RuleEditParamsBodySetCacheTagsRuleActionParametersOperation = "set"
)

func (RuleEditParamsBodySetCacheTagsRuleActionParametersOperation) IsKnown

type RuleEditParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsExpression

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

type RuleEditParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation

type RuleEditParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation string

The operation to perform on the cache tags.

const (
	RuleEditParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationAdd    RuleEditParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "add"
	RuleEditParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationRemove RuleEditParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "remove"
	RuleEditParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationSet    RuleEditParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "set"
)

func (RuleEditParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation) IsKnown

type RuleEditParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsValues

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

type RuleEditParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation

type RuleEditParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation string

The operation to perform on the cache tags.

const (
	RuleEditParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationAdd    RuleEditParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "add"
	RuleEditParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationRemove RuleEditParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "remove"
	RuleEditParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationSet    RuleEditParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "set"
)

func (RuleEditParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation) IsKnown

type RuleEditParamsBodySetCacheTagsRuleActionParametersSetCacheTagsExpression

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

type RuleEditParamsBodySetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation

type RuleEditParamsBodySetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation string

The operation to perform on the cache tags.

const (
	RuleEditParamsBodySetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationAdd    RuleEditParamsBodySetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "add"
	RuleEditParamsBodySetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationRemove RuleEditParamsBodySetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "remove"
	RuleEditParamsBodySetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationSet    RuleEditParamsBodySetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "set"
)

func (RuleEditParamsBodySetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation) IsKnown

type RuleEditParamsBodySetCacheTagsRuleActionParametersSetCacheTagsValues

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

type RuleEditParamsBodySetCacheTagsRuleActionParametersSetCacheTagsValuesOperation

type RuleEditParamsBodySetCacheTagsRuleActionParametersSetCacheTagsValuesOperation string

The operation to perform on the cache tags.

const (
	RuleEditParamsBodySetCacheTagsRuleActionParametersSetCacheTagsValuesOperationAdd    RuleEditParamsBodySetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "add"
	RuleEditParamsBodySetCacheTagsRuleActionParametersSetCacheTagsValuesOperationRemove RuleEditParamsBodySetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "remove"
	RuleEditParamsBodySetCacheTagsRuleActionParametersSetCacheTagsValuesOperationSet    RuleEditParamsBodySetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "set"
)

func (RuleEditParamsBodySetCacheTagsRuleActionParametersSetCacheTagsValuesOperation) IsKnown

type RuleEditParamsBodySetCacheTagsRuleExposedCredentialCheck

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

type RuleEditParamsBodySetCacheTagsRulePosition

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

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

type RuleEditParamsBodySetCacheTagsRulePositionAfterPosition

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

type RuleEditParamsBodySetCacheTagsRulePositionBeforePosition

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

type RuleEditParamsBodySetCacheTagsRulePositionIndexPosition

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

type RuleEditParamsBodySetCacheTagsRulePositionUnion

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

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

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

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

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

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 RuleEditParamsBodyTransformResponseHTMLRule added in v7.7.0

type RuleEditParamsBodyTransformResponseHTMLRule struct {
	// The unique ID of the rule.
	ID param.Field[string] `json:"id"`
	// The action to perform when the rule matches.
	Action param.Field[RuleEditParamsBodyTransformResponseHTMLRuleAction] `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters param.Field[RuleEditParamsBodyTransformResponseHTMLRuleActionParameters] `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[RuleEditParamsBodyTransformResponseHTMLRuleExposedCredentialCheck] `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[RuleEditParamsBodyTransformResponseHTMLRulePositionUnion] `json:"position"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit param.Field[RuleEditParamsBodyTransformResponseHTMLRuleRatelimit] `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref param.Field[string] `json:"ref"`
}

func (RuleEditParamsBodyTransformResponseHTMLRule) MarshalJSON added in v7.7.0

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

type RuleEditParamsBodyTransformResponseHTMLRuleAction added in v7.7.0

type RuleEditParamsBodyTransformResponseHTMLRuleAction string

The action to perform when the rule matches.

const (
	RuleEditParamsBodyTransformResponseHTMLRuleActionTransformResponseHTML RuleEditParamsBodyTransformResponseHTMLRuleAction = "transform_response_html"
)

func (RuleEditParamsBodyTransformResponseHTMLRuleAction) IsKnown added in v7.7.0

type RuleEditParamsBodyTransformResponseHTMLRuleActionParameters added in v7.7.0

type RuleEditParamsBodyTransformResponseHTMLRuleActionParameters struct {
	// Enables the link maze transformation on the response.
	LinkMaze param.Field[interface{}] `json:"link_maze" api:"required"`
}

The parameters configuring the rule's action.

func (RuleEditParamsBodyTransformResponseHTMLRuleActionParameters) MarshalJSON added in v7.7.0

type RuleEditParamsBodyTransformResponseHTMLRuleExposedCredentialCheck added in v7.7.0

type RuleEditParamsBodyTransformResponseHTMLRuleExposedCredentialCheck 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 (RuleEditParamsBodyTransformResponseHTMLRuleExposedCredentialCheck) MarshalJSON added in v7.7.0

type RuleEditParamsBodyTransformResponseHTMLRulePosition added in v7.7.0

type RuleEditParamsBodyTransformResponseHTMLRulePosition 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 (RuleEditParamsBodyTransformResponseHTMLRulePosition) MarshalJSON added in v7.7.0

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

type RuleEditParamsBodyTransformResponseHTMLRulePositionAfterPosition added in v7.7.0

type RuleEditParamsBodyTransformResponseHTMLRulePositionAfterPosition 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 (RuleEditParamsBodyTransformResponseHTMLRulePositionAfterPosition) MarshalJSON added in v7.7.0

type RuleEditParamsBodyTransformResponseHTMLRulePositionBeforePosition added in v7.7.0

type RuleEditParamsBodyTransformResponseHTMLRulePositionBeforePosition 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 (RuleEditParamsBodyTransformResponseHTMLRulePositionBeforePosition) MarshalJSON added in v7.7.0

type RuleEditParamsBodyTransformResponseHTMLRulePositionIndexPosition added in v7.7.0

type RuleEditParamsBodyTransformResponseHTMLRulePositionIndexPosition 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 (RuleEditParamsBodyTransformResponseHTMLRulePositionIndexPosition) MarshalJSON added in v7.7.0

type RuleEditParamsBodyTransformResponseHTMLRuleRatelimit added in v7.7.0

type RuleEditParamsBodyTransformResponseHTMLRuleRatelimit 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 (RuleEditParamsBodyTransformResponseHTMLRuleRatelimit) MarshalJSON added in v7.7.0

func (r RuleEditParamsBodyTransformResponseHTMLRuleRatelimit) MarshalJSON() (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 result.
	Result RuleEditResponseEnvelopeResult `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 RuleEditResponseEnvelopeResult added in v7.9.0

type RuleEditResponseEnvelopeResult 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 []RuleEditResponseEnvelopeResultRules `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        ruleEditResponseEnvelopeResultJSON `json:"-"`
}

A ruleset object.

func (*RuleEditResponseEnvelopeResult) UnmarshalJSON added in v7.9.0

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

type RuleEditResponseEnvelopeResultRules added in v7.9.0

type RuleEditResponseEnvelopeResultRules 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 RuleEditResponseEnvelopeResultRulesAction `json:"action"`
	// This field can have the runtime type of [BlockRuleActionParameters],
	// [interface{}], [CompressResponseRuleActionParameters],
	// [ExecuteRuleActionParameters], [LogCustomFieldRuleActionParameters],
	// [RedirectRuleActionParameters], [RewriteRuleActionParameters],
	// [RouteRuleActionParameters], [ScoreRuleActionParameters],
	// [ServeErrorRuleActionParameters],
	// [RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParameters],
	// [SetCacheSettingsRuleActionParameters],
	// [RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParameters],
	// [SetConfigRuleActionParameters], [SkipRuleActionParameters],
	// [RuleEditResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleActionParameters].
	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],
	// [RuleEditResponseEnvelopeResultRulesRulesetsChallengeRuleExposedCredentialCheck],
	// [CompressResponseRuleExposedCredentialCheck],
	// [DDoSDynamicRuleExposedCredentialCheck], [ExecuteRuleExposedCredentialCheck],
	// [ForceConnectionCloseRuleExposedCredentialCheck],
	// [RuleEditResponseEnvelopeResultRulesRulesetsJSChallengeRuleExposedCredentialCheck],
	// [LogRuleExposedCredentialCheck], [LogCustomFieldRuleExposedCredentialCheck],
	// [ManagedChallengeRuleExposedCredentialCheck],
	// [RedirectRuleExposedCredentialCheck], [RewriteRuleExposedCredentialCheck],
	// [RouteRuleExposedCredentialCheck], [ScoreRuleExposedCredentialCheck],
	// [ServeErrorRuleExposedCredentialCheck],
	// [RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleExposedCredentialCheck],
	// [SetCacheSettingsRuleExposedCredentialCheck],
	// [RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleExposedCredentialCheck],
	// [SetConfigRuleExposedCredentialCheck], [SkipRuleExposedCredentialCheck],
	// [RuleEditResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleExposedCredentialCheck].
	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],
	// [RuleEditResponseEnvelopeResultRulesRulesetsChallengeRuleRatelimit],
	// [CompressResponseRuleRatelimit], [DDoSDynamicRuleRatelimit],
	// [ExecuteRuleRatelimit], [ForceConnectionCloseRuleRatelimit],
	// [RuleEditResponseEnvelopeResultRulesRulesetsJSChallengeRuleRatelimit],
	// [LogRuleRatelimit], [LogCustomFieldRuleRatelimit],
	// [ManagedChallengeRuleRatelimit], [RedirectRuleRatelimit],
	// [RewriteRuleRatelimit], [RouteRuleRatelimit], [ScoreRuleRatelimit],
	// [ServeErrorRuleRatelimit],
	// [RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleRatelimit],
	// [SetCacheSettingsRuleRatelimit],
	// [RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleRatelimit],
	// [SetConfigRuleRatelimit], [SkipRuleRatelimit],
	// [RuleEditResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleRatelimit].
	Ratelimit interface{} `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                                  `json:"ref"`
	JSON ruleEditResponseEnvelopeResultRulesJSON `json:"-"`
	// contains filtered or unexported fields
}

func (*RuleEditResponseEnvelopeResultRules) UnmarshalJSON added in v7.9.0

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

type RuleEditResponseEnvelopeResultRulesAction added in v7.9.0

type RuleEditResponseEnvelopeResultRulesAction string

The action to perform when the rule matches.

const (
	RuleEditResponseEnvelopeResultRulesActionBlock                 RuleEditResponseEnvelopeResultRulesAction = "block"
	RuleEditResponseEnvelopeResultRulesActionChallenge             RuleEditResponseEnvelopeResultRulesAction = "challenge"
	RuleEditResponseEnvelopeResultRulesActionCompressResponse      RuleEditResponseEnvelopeResultRulesAction = "compress_response"
	RuleEditResponseEnvelopeResultRulesActionDDoSDynamic           RuleEditResponseEnvelopeResultRulesAction = "ddos_dynamic"
	RuleEditResponseEnvelopeResultRulesActionExecute               RuleEditResponseEnvelopeResultRulesAction = "execute"
	RuleEditResponseEnvelopeResultRulesActionForceConnectionClose  RuleEditResponseEnvelopeResultRulesAction = "force_connection_close"
	RuleEditResponseEnvelopeResultRulesActionJSChallenge           RuleEditResponseEnvelopeResultRulesAction = "js_challenge"
	RuleEditResponseEnvelopeResultRulesActionLog                   RuleEditResponseEnvelopeResultRulesAction = "log"
	RuleEditResponseEnvelopeResultRulesActionLogCustomField        RuleEditResponseEnvelopeResultRulesAction = "log_custom_field"
	RuleEditResponseEnvelopeResultRulesActionManagedChallenge      RuleEditResponseEnvelopeResultRulesAction = "managed_challenge"
	RuleEditResponseEnvelopeResultRulesActionRedirect              RuleEditResponseEnvelopeResultRulesAction = "redirect"
	RuleEditResponseEnvelopeResultRulesActionRewrite               RuleEditResponseEnvelopeResultRulesAction = "rewrite"
	RuleEditResponseEnvelopeResultRulesActionRoute                 RuleEditResponseEnvelopeResultRulesAction = "route"
	RuleEditResponseEnvelopeResultRulesActionScore                 RuleEditResponseEnvelopeResultRulesAction = "score"
	RuleEditResponseEnvelopeResultRulesActionServeError            RuleEditResponseEnvelopeResultRulesAction = "serve_error"
	RuleEditResponseEnvelopeResultRulesActionSetCacheControl       RuleEditResponseEnvelopeResultRulesAction = "set_cache_control"
	RuleEditResponseEnvelopeResultRulesActionSetCacheSettings      RuleEditResponseEnvelopeResultRulesAction = "set_cache_settings"
	RuleEditResponseEnvelopeResultRulesActionSetCacheTags          RuleEditResponseEnvelopeResultRulesAction = "set_cache_tags"
	RuleEditResponseEnvelopeResultRulesActionSetConfig             RuleEditResponseEnvelopeResultRulesAction = "set_config"
	RuleEditResponseEnvelopeResultRulesActionSkip                  RuleEditResponseEnvelopeResultRulesAction = "skip"
	RuleEditResponseEnvelopeResultRulesActionTransformResponseHTML RuleEditResponseEnvelopeResultRulesAction = "transform_response_html"
)

func (RuleEditResponseEnvelopeResultRulesAction) IsKnown added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsChallengeRule added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsChallengeRule 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 RuleEditResponseEnvelopeResultRulesRulesetsChallengeRuleAction `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 RuleEditResponseEnvelopeResultRulesRulesetsChallengeRuleExposedCredentialCheck `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 RuleEditResponseEnvelopeResultRulesRulesetsChallengeRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                                                       `json:"ref"`
	JSON ruleEditResponseEnvelopeResultRulesRulesetsChallengeRuleJSON `json:"-"`
}

func (*RuleEditResponseEnvelopeResultRulesRulesetsChallengeRule) UnmarshalJSON added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsChallengeRuleAction added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsChallengeRuleAction string

The action to perform when the rule matches.

const (
	RuleEditResponseEnvelopeResultRulesRulesetsChallengeRuleActionChallenge RuleEditResponseEnvelopeResultRulesRulesetsChallengeRuleAction = "challenge"
)

func (RuleEditResponseEnvelopeResultRulesRulesetsChallengeRuleAction) IsKnown added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsChallengeRuleExposedCredentialCheck added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsChallengeRuleExposedCredentialCheck 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               ruleEditResponseEnvelopeResultRulesRulesetsChallengeRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*RuleEditResponseEnvelopeResultRulesRulesetsChallengeRuleExposedCredentialCheck) UnmarshalJSON added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsChallengeRuleRatelimit added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsChallengeRuleRatelimit 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                    ruleEditResponseEnvelopeResultRulesRulesetsChallengeRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*RuleEditResponseEnvelopeResultRulesRulesetsChallengeRuleRatelimit) UnmarshalJSON added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsJSChallengeRule added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsJSChallengeRule 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 RuleEditResponseEnvelopeResultRulesRulesetsJSChallengeRuleAction `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 RuleEditResponseEnvelopeResultRulesRulesetsJSChallengeRuleExposedCredentialCheck `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 RuleEditResponseEnvelopeResultRulesRulesetsJSChallengeRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                                                         `json:"ref"`
	JSON ruleEditResponseEnvelopeResultRulesRulesetsJSChallengeRuleJSON `json:"-"`
}

func (*RuleEditResponseEnvelopeResultRulesRulesetsJSChallengeRule) UnmarshalJSON added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsJSChallengeRuleAction added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsJSChallengeRuleAction string

The action to perform when the rule matches.

const (
	RuleEditResponseEnvelopeResultRulesRulesetsJSChallengeRuleActionJSChallenge RuleEditResponseEnvelopeResultRulesRulesetsJSChallengeRuleAction = "js_challenge"
)

func (RuleEditResponseEnvelopeResultRulesRulesetsJSChallengeRuleAction) IsKnown added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsJSChallengeRuleExposedCredentialCheck added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsJSChallengeRuleExposedCredentialCheck 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               ruleEditResponseEnvelopeResultRulesRulesetsJSChallengeRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*RuleEditResponseEnvelopeResultRulesRulesetsJSChallengeRuleExposedCredentialCheck) UnmarshalJSON added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsJSChallengeRuleRatelimit added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsJSChallengeRuleRatelimit 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                    ruleEditResponseEnvelopeResultRulesRulesetsJSChallengeRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*RuleEditResponseEnvelopeResultRulesRulesetsJSChallengeRuleRatelimit) UnmarshalJSON added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRule added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRule 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 RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleAction `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParameters `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 RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleExposedCredentialCheck `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 RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                                                             `json:"ref"`
	JSON ruleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleJSON `json:"-"`
}

func (*RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRule) UnmarshalJSON added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleAction added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleAction string

The action to perform when the rule matches.

const (
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionSetCacheControl RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleAction = "set_cache_control"
)

func (RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleAction) IsKnown added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParameters added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParameters struct {
	// A cache-control directive configuration.
	Immutable RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutable `json:"immutable"`
	// A cache-control directive configuration that accepts a duration value in
	// seconds.
	MaxAge RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAge `json:"max-age"`
	// A cache-control directive configuration.
	MustRevalidate RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate `json:"must-revalidate"`
	// A cache-control directive configuration.
	MustUnderstand RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand `json:"must-understand"`
	// A cache-control directive configuration that accepts optional qualifiers (header
	// names).
	NoCache RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCache `json:"no-cache"`
	// A cache-control directive configuration.
	NoStore RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStore `json:"no-store"`
	// A cache-control directive configuration.
	NoTransform RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransform `json:"no-transform"`
	// A cache-control directive configuration that accepts optional qualifiers (header
	// names).
	Private RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivate `json:"private"`
	// A cache-control directive configuration.
	ProxyRevalidate RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate `json:"proxy-revalidate"`
	// A cache-control directive configuration.
	Public RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublic `json:"public"`
	// A cache-control directive configuration that accepts a duration value in
	// seconds.
	SMaxage RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxage `json:"s-maxage"`
	// A cache-control directive configuration that accepts a duration value in
	// seconds.
	StaleIfError RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfError `json:"stale-if-error"`
	// A cache-control directive configuration that accepts a duration value in
	// seconds.
	StaleWhileRevalidate RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate `json:"stale-while-revalidate"`
	JSON                 ruleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersJSON                 `json:"-"`
}

The parameters configuring the rule's action.

func (*RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParameters) UnmarshalJSON added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutable added in v7.9.0

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

A cache-control directive configuration.

func (*RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutable) UnmarshalJSON added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation string

The operation to perform on the cache-control directive.

const (
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableOperationSet    RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation = "set"
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableOperationRemove RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation = "remove"
)

func (RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation) IsKnown added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective added in v7.9.0

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

Remove the directive.

func (*RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective) UnmarshalJSON added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperationSet    RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation = "set"
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperationRemove RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation = "remove"
)

func (RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation) IsKnown added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective added in v7.9.0

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

Set the directive.

func (*RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective) UnmarshalJSON added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperationSet    RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation = "set"
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperationRemove RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation = "remove"
)

func (RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation) IsKnown added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableUnion added in v7.9.0

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

A cache-control directive configuration.

Union satisfied by RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective or RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective.

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAge added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAge struct {
	// The operation to perform on the cache-control directive.
	Operation RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation `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  ruleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeJSON `json:"-"`
	// contains filtered or unexported fields
}

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

func (*RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAge) UnmarshalJSON added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation string

The operation to perform on the cache-control directive.

const (
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperationSet    RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation = "set"
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperationRemove RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation = "remove"
)

func (RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation) IsKnown added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective added in v7.9.0

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

Remove the directive.

func (*RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective) UnmarshalJSON added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperationSet    RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation = "set"
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperationRemove RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation = "remove"
)

func (RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation) IsKnown added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation `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           ruleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveJSON `json:"-"`
}

Set the directive with a duration value in seconds.

func (*RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective) UnmarshalJSON added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperationSet    RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation = "set"
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperationRemove RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation = "remove"
)

func (RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation) IsKnown added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeUnion added in v7.9.0

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

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

Union satisfied by RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective or RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective.

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate added in v7.9.0

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

A cache-control directive configuration.

func (*RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate) UnmarshalJSON added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation string

The operation to perform on the cache-control directive.

const (
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperationSet    RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation = "set"
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperationRemove RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation = "remove"
)

func (RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation) IsKnown added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective added in v7.9.0

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

Remove the directive.

func (*RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective) UnmarshalJSON added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperationSet    RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation = "set"
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperationRemove RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation = "remove"
)

func (RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation) IsKnown added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective added in v7.9.0

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

Set the directive.

func (*RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective) UnmarshalJSON added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperationSet    RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation = "set"
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperationRemove RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation = "remove"
)

func (RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation) IsKnown added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateUnion added in v7.9.0

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

A cache-control directive configuration.

Union satisfied by RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective or RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective.

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand added in v7.9.0

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

A cache-control directive configuration.

func (*RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand) UnmarshalJSON added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation string

The operation to perform on the cache-control directive.

const (
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperationSet    RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation = "set"
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperationRemove RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation = "remove"
)

func (RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation) IsKnown added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective added in v7.9.0

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

Remove the directive.

func (*RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective) UnmarshalJSON added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperationSet    RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation = "set"
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperationRemove RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation = "remove"
)

func (RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation) IsKnown added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective added in v7.9.0

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

Set the directive.

func (*RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective) UnmarshalJSON added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperationSet    RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation = "set"
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperationRemove RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation = "remove"
)

func (RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation) IsKnown added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandUnion added in v7.9.0

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

A cache-control directive configuration.

Union satisfied by RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective or RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective.

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCache added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCache struct {
	// The operation to perform on the cache-control directive.
	Operation RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation `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       ruleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheJSON `json:"-"`
	// contains filtered or unexported fields
}

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

func (*RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCache) UnmarshalJSON added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation string

The operation to perform on the cache-control directive.

const (
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperationSet    RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation = "set"
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperationRemove RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation = "remove"
)

func (RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation) IsKnown added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective added in v7.9.0

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

Remove the directive.

func (*RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective) UnmarshalJSON added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperationSet    RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation = "set"
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperationRemove RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation = "remove"
)

func (RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation) IsKnown added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation `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       ruleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveJSON `json:"-"`
}

Set the directive with optional qualifiers.

func (*RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective) UnmarshalJSON added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperationSet    RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation = "set"
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperationRemove RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation = "remove"
)

func (RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation) IsKnown added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheUnion added in v7.9.0

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

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

Union satisfied by RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective or RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective.

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStore added in v7.9.0

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

A cache-control directive configuration.

func (*RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStore) UnmarshalJSON added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation string

The operation to perform on the cache-control directive.

const (
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperationSet    RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation = "set"
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperationRemove RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation = "remove"
)

func (RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation) IsKnown added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective added in v7.9.0

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

Remove the directive.

func (*RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective) UnmarshalJSON added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperationSet    RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation = "set"
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperationRemove RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation = "remove"
)

func (RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation) IsKnown added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective added in v7.9.0

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

Set the directive.

func (*RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective) UnmarshalJSON added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperationSet    RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation = "set"
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperationRemove RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation = "remove"
)

func (RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation) IsKnown added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreUnion added in v7.9.0

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

A cache-control directive configuration.

Union satisfied by RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective or RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective.

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransform added in v7.9.0

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

A cache-control directive configuration.

func (*RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransform) UnmarshalJSON added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation string

The operation to perform on the cache-control directive.

const (
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperationSet    RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation = "set"
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperationRemove RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation = "remove"
)

func (RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation) IsKnown added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective added in v7.9.0

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

Remove the directive.

func (*RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective) UnmarshalJSON added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperationSet    RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation = "set"
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperationRemove RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation = "remove"
)

func (RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation) IsKnown added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective added in v7.9.0

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

Set the directive.

func (*RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective) UnmarshalJSON added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperationSet    RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation = "set"
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperationRemove RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation = "remove"
)

func (RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation) IsKnown added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformUnion added in v7.9.0

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

A cache-control directive configuration.

Union satisfied by RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective or RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective.

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivate added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivate struct {
	// The operation to perform on the cache-control directive.
	Operation RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation `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       ruleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateJSON `json:"-"`
	// contains filtered or unexported fields
}

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

func (*RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivate) UnmarshalJSON added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation string

The operation to perform on the cache-control directive.

const (
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateOperationSet    RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation = "set"
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateOperationRemove RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation = "remove"
)

func (RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation) IsKnown added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective added in v7.9.0

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

Remove the directive.

func (*RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective) UnmarshalJSON added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperationSet    RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation = "set"
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperationRemove RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation = "remove"
)

func (RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation) IsKnown added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation `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       ruleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveJSON `json:"-"`
}

Set the directive with optional qualifiers.

func (*RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective) UnmarshalJSON added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperationSet    RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation = "set"
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperationRemove RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation = "remove"
)

func (RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation) IsKnown added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateUnion added in v7.9.0

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

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

Union satisfied by RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective or RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective.

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate added in v7.9.0

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

A cache-control directive configuration.

func (*RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate) UnmarshalJSON added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation string

The operation to perform on the cache-control directive.

const (
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperationSet    RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation = "set"
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperationRemove RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation = "remove"
)

func (RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation) IsKnown added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective added in v7.9.0

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

Remove the directive.

func (*RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective) UnmarshalJSON added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperationSet    RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation = "set"
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperationRemove RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation = "remove"
)

func (RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation) IsKnown added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective added in v7.9.0

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

Set the directive.

func (*RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective) UnmarshalJSON added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperationSet    RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation = "set"
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperationRemove RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation = "remove"
)

func (RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation) IsKnown added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateUnion added in v7.9.0

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

A cache-control directive configuration.

Union satisfied by RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective or RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective.

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublic added in v7.9.0

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

A cache-control directive configuration.

func (*RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublic) UnmarshalJSON added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicOperation added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicOperation string

The operation to perform on the cache-control directive.

const (
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicOperationSet    RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicOperation = "set"
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicOperationRemove RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicOperation = "remove"
)

func (RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicOperation) IsKnown added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective added in v7.9.0

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

Remove the directive.

func (*RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective) UnmarshalJSON added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperationSet    RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation = "set"
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperationRemove RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation = "remove"
)

func (RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation) IsKnown added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective added in v7.9.0

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

Set the directive.

func (*RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective) UnmarshalJSON added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperationSet    RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation = "set"
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperationRemove RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation = "remove"
)

func (RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation) IsKnown added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicUnion added in v7.9.0

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

A cache-control directive configuration.

Union satisfied by RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective or RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective.

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxage added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxage struct {
	// The operation to perform on the cache-control directive.
	Operation RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation `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  ruleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageJSON `json:"-"`
	// contains filtered or unexported fields
}

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

func (*RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxage) UnmarshalJSON added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation string

The operation to perform on the cache-control directive.

const (
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperationSet    RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation = "set"
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperationRemove RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation = "remove"
)

func (RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation) IsKnown added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective added in v7.9.0

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

Remove the directive.

func (*RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective) UnmarshalJSON added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperationSet    RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation = "set"
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperationRemove RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation = "remove"
)

func (RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation) IsKnown added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation `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           ruleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveJSON `json:"-"`
}

Set the directive with a duration value in seconds.

func (*RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective) UnmarshalJSON added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperationSet    RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation = "set"
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperationRemove RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation = "remove"
)

func (RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation) IsKnown added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageUnion added in v7.9.0

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

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

Union satisfied by RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective or RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective.

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfError added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfError struct {
	// The operation to perform on the cache-control directive.
	Operation RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation `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  ruleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorJSON `json:"-"`
	// contains filtered or unexported fields
}

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

func (*RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfError) UnmarshalJSON added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation string

The operation to perform on the cache-control directive.

const (
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperationSet    RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation = "set"
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperationRemove RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation = "remove"
)

func (RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation) IsKnown added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective added in v7.9.0

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

Remove the directive.

func (*RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective) UnmarshalJSON added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperationSet    RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation = "set"
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperationRemove RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation = "remove"
)

func (RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation) IsKnown added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation `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           ruleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveJSON `json:"-"`
}

Set the directive with a duration value in seconds.

func (*RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective) UnmarshalJSON added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperationSet    RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation = "set"
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperationRemove RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation = "remove"
)

func (RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation) IsKnown added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorUnion added in v7.9.0

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

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

Union satisfied by RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective or RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective.

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate struct {
	// The operation to perform on the cache-control directive.
	Operation RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation `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  ruleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateJSON `json:"-"`
	// contains filtered or unexported fields
}

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

func (*RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate) UnmarshalJSON added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation string

The operation to perform on the cache-control directive.

const (
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperationSet    RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation = "set"
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperationRemove RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation = "remove"
)

func (RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation) IsKnown added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective added in v7.9.0

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

Remove the directive.

func (*RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective) UnmarshalJSON added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperationSet    RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation = "set"
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperationRemove RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation = "remove"
)

func (RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation) IsKnown added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation `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           ruleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveJSON `json:"-"`
}

Set the directive with a duration value in seconds.

func (*RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective) UnmarshalJSON added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperationSet    RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation = "set"
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperationRemove RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation = "remove"
)

func (RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation) IsKnown added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateUnion added in v7.9.0

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

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

Union satisfied by RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective or RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective.

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleExposedCredentialCheck added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleExposedCredentialCheck 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               ruleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleExposedCredentialCheck) UnmarshalJSON added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleRatelimit added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleRatelimit 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                    ruleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*RuleEditResponseEnvelopeResultRulesRulesetsSetCacheControlRuleRatelimit) UnmarshalJSON added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRule added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRule 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 RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleAction `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParameters `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 RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleExposedCredentialCheck `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 RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                                                          `json:"ref"`
	JSON ruleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleJSON `json:"-"`
}

func (*RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRule) UnmarshalJSON added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleAction added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleAction string

The action to perform when the rule matches.

const (
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionSetCacheTags RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleAction = "set_cache_tags"
)

func (RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleAction) IsKnown added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParameters added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParameters struct {
	// The operation to perform on the cache tags.
	Operation RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersOperation `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   ruleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersJSON `json:"-"`
	// contains filtered or unexported fields
}

The parameters configuring the rule's action.

func (*RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParameters) UnmarshalJSON added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression 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 RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation `json:"operation" api:"required"`
	JSON      ruleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionJSON      `json:"-"`
}

Add cache tags using an expression.

func (*RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression) UnmarshalJSON added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation string

The operation to perform on the cache tags.

const (
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationAdd    RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "add"
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationRemove RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "remove"
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationSet    RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "set"
)

func (RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation) IsKnown added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues added in v7.9.0

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

Add cache tags using a list of values.

func (*RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues) UnmarshalJSON added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation string

The operation to perform on the cache tags.

const (
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationAdd    RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "add"
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationRemove RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "remove"
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationSet    RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "set"
)

func (RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation) IsKnown added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersOperation added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersOperation string

The operation to perform on the cache tags.

const (
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersOperationAdd    RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersOperation = "add"
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersOperationRemove RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersOperation = "remove"
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersOperationSet    RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersOperation = "set"
)

func (RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersOperation) IsKnown added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression 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 RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation `json:"operation" api:"required"`
	JSON      ruleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionJSON      `json:"-"`
}

Remove cache tags using an expression.

func (*RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression) UnmarshalJSON added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation string

The operation to perform on the cache tags.

const (
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationAdd    RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "add"
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationRemove RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "remove"
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationSet    RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "set"
)

func (RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation) IsKnown added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues added in v7.9.0

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

Remove cache tags using a list of values.

func (*RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues) UnmarshalJSON added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation string

The operation to perform on the cache tags.

const (
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationAdd    RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "add"
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationRemove RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "remove"
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationSet    RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "set"
)

func (RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation) IsKnown added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression 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 RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation `json:"operation" api:"required"`
	JSON      ruleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionJSON      `json:"-"`
}

Set cache tags using an expression.

func (*RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression) UnmarshalJSON added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation string

The operation to perform on the cache tags.

const (
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationAdd    RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "add"
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationRemove RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "remove"
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationSet    RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "set"
)

func (RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation) IsKnown added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues added in v7.9.0

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

Set cache tags using a list of values.

func (*RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues) UnmarshalJSON added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation string

The operation to perform on the cache tags.

const (
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationAdd    RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "add"
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationRemove RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "remove"
	RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationSet    RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "set"
)

func (RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation) IsKnown added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleExposedCredentialCheck added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleExposedCredentialCheck 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               ruleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleExposedCredentialCheck) UnmarshalJSON added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleRatelimit added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleRatelimit 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                    ruleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*RuleEditResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleRatelimit) UnmarshalJSON added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRule added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRule 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 RuleEditResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleAction `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters RuleEditResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleActionParameters `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 RuleEditResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleExposedCredentialCheck `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 RuleEditResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                                                                   `json:"ref"`
	JSON ruleEditResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleJSON `json:"-"`
}

func (*RuleEditResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRule) UnmarshalJSON added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleAction added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleAction string

The action to perform when the rule matches.

const (
	RuleEditResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleActionTransformResponseHTML RuleEditResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleAction = "transform_response_html"
)

func (RuleEditResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleAction) IsKnown added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleActionParameters added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleActionParameters struct {
	// Enables the link maze transformation on the response.
	LinkMaze interface{}                                                                              `json:"link_maze" api:"required"`
	JSON     ruleEditResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleActionParametersJSON `json:"-"`
}

The parameters configuring the rule's action.

func (*RuleEditResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleActionParameters) UnmarshalJSON added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleExposedCredentialCheck added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleExposedCredentialCheck 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               ruleEditResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*RuleEditResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleExposedCredentialCheck) UnmarshalJSON added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleRatelimit added in v7.9.0

type RuleEditResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleRatelimit 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                    ruleEditResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*RuleEditResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleRatelimit) UnmarshalJSON added in v7.9.0

type RuleEditResponseEnvelopeSuccess

type RuleEditResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	RuleEditResponseEnvelopeSuccessTrue RuleEditResponseEnvelopeSuccess = true
)

func (RuleEditResponseEnvelopeSuccess) IsKnown

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"`
	// Validates the request without persisting changes when set to `true`. Responses
	// that normally return 200 return `result: null`; endpoints that normally return
	// 204 continue to return 204.
	DryRun param.Field[bool] `query:"dry_run"`
}

func (RuleNewParams) MarshalJSON

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

func (RuleNewParams) URLQuery added in v7.9.0

func (r RuleNewParams) URLQuery() (v url.Values)

URLQuery serializes RuleNewParams's query parameters as `url.Values`.

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"
	RuleNewParamsBodyActionTransformResponseHTML RuleNewParamsBodyAction = "transform_response_html"
)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

type RuleNewParamsBodySetCacheControlRuleAction

type RuleNewParamsBodySetCacheControlRuleAction string

The action to perform when the rule matches.

const (
	RuleNewParamsBodySetCacheControlRuleActionSetCacheControl RuleNewParamsBodySetCacheControlRuleAction = "set_cache_control"
)

func (RuleNewParamsBodySetCacheControlRuleAction) IsKnown

type RuleNewParamsBodySetCacheControlRuleActionParameters

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

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

type RuleNewParamsBodySetCacheControlRuleActionParametersImmutable

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

type RuleNewParamsBodySetCacheControlRuleActionParametersImmutableOperation

type RuleNewParamsBodySetCacheControlRuleActionParametersImmutableOperation string

The operation to perform on the cache-control directive.

const (
	RuleNewParamsBodySetCacheControlRuleActionParametersImmutableOperationSet    RuleNewParamsBodySetCacheControlRuleActionParametersImmutableOperation = "set"
	RuleNewParamsBodySetCacheControlRuleActionParametersImmutableOperationRemove RuleNewParamsBodySetCacheControlRuleActionParametersImmutableOperation = "remove"
)

func (RuleNewParamsBodySetCacheControlRuleActionParametersImmutableOperation) IsKnown

type RuleNewParamsBodySetCacheControlRuleActionParametersImmutableRemoveDirective

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

type RuleNewParamsBodySetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation

type RuleNewParamsBodySetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleNewParamsBodySetCacheControlRuleActionParametersImmutableRemoveDirectiveOperationSet    RuleNewParamsBodySetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation = "set"
	RuleNewParamsBodySetCacheControlRuleActionParametersImmutableRemoveDirectiveOperationRemove RuleNewParamsBodySetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation = "remove"
)

func (RuleNewParamsBodySetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation) IsKnown

type RuleNewParamsBodySetCacheControlRuleActionParametersImmutableSetDirective

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

type RuleNewParamsBodySetCacheControlRuleActionParametersImmutableSetDirectiveOperation

type RuleNewParamsBodySetCacheControlRuleActionParametersImmutableSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleNewParamsBodySetCacheControlRuleActionParametersImmutableSetDirectiveOperationSet    RuleNewParamsBodySetCacheControlRuleActionParametersImmutableSetDirectiveOperation = "set"
	RuleNewParamsBodySetCacheControlRuleActionParametersImmutableSetDirectiveOperationRemove RuleNewParamsBodySetCacheControlRuleActionParametersImmutableSetDirectiveOperation = "remove"
)

func (RuleNewParamsBodySetCacheControlRuleActionParametersImmutableSetDirectiveOperation) IsKnown

type RuleNewParamsBodySetCacheControlRuleActionParametersMaxAge

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

type RuleNewParamsBodySetCacheControlRuleActionParametersMaxAgeOperation

type RuleNewParamsBodySetCacheControlRuleActionParametersMaxAgeOperation string

The operation to perform on the cache-control directive.

const (
	RuleNewParamsBodySetCacheControlRuleActionParametersMaxAgeOperationSet    RuleNewParamsBodySetCacheControlRuleActionParametersMaxAgeOperation = "set"
	RuleNewParamsBodySetCacheControlRuleActionParametersMaxAgeOperationRemove RuleNewParamsBodySetCacheControlRuleActionParametersMaxAgeOperation = "remove"
)

func (RuleNewParamsBodySetCacheControlRuleActionParametersMaxAgeOperation) IsKnown

type RuleNewParamsBodySetCacheControlRuleActionParametersMaxAgeRemoveDirective

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

type RuleNewParamsBodySetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation

type RuleNewParamsBodySetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleNewParamsBodySetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperationSet    RuleNewParamsBodySetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation = "set"
	RuleNewParamsBodySetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperationRemove RuleNewParamsBodySetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation = "remove"
)

func (RuleNewParamsBodySetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation) IsKnown

type RuleNewParamsBodySetCacheControlRuleActionParametersMaxAgeSetDirective

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

type RuleNewParamsBodySetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation

type RuleNewParamsBodySetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleNewParamsBodySetCacheControlRuleActionParametersMaxAgeSetDirectiveOperationSet    RuleNewParamsBodySetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation = "set"
	RuleNewParamsBodySetCacheControlRuleActionParametersMaxAgeSetDirectiveOperationRemove RuleNewParamsBodySetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation = "remove"
)

func (RuleNewParamsBodySetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation) IsKnown

type RuleNewParamsBodySetCacheControlRuleActionParametersMaxAgeUnion

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

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

type RuleNewParamsBodySetCacheControlRuleActionParametersMustRevalidateOperation

type RuleNewParamsBodySetCacheControlRuleActionParametersMustRevalidateOperation string

The operation to perform on the cache-control directive.

const (
	RuleNewParamsBodySetCacheControlRuleActionParametersMustRevalidateOperationSet    RuleNewParamsBodySetCacheControlRuleActionParametersMustRevalidateOperation = "set"
	RuleNewParamsBodySetCacheControlRuleActionParametersMustRevalidateOperationRemove RuleNewParamsBodySetCacheControlRuleActionParametersMustRevalidateOperation = "remove"
)

func (RuleNewParamsBodySetCacheControlRuleActionParametersMustRevalidateOperation) IsKnown

type RuleNewParamsBodySetCacheControlRuleActionParametersMustRevalidateRemoveDirective

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

type RuleNewParamsBodySetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation

type RuleNewParamsBodySetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleNewParamsBodySetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperationSet    RuleNewParamsBodySetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation = "set"
	RuleNewParamsBodySetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperationRemove RuleNewParamsBodySetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation = "remove"
)

func (RuleNewParamsBodySetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation) IsKnown

type RuleNewParamsBodySetCacheControlRuleActionParametersMustRevalidateSetDirective

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

type RuleNewParamsBodySetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation

type RuleNewParamsBodySetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleNewParamsBodySetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperationSet    RuleNewParamsBodySetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation = "set"
	RuleNewParamsBodySetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperationRemove RuleNewParamsBodySetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation = "remove"
)

func (RuleNewParamsBodySetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation) IsKnown

type RuleNewParamsBodySetCacheControlRuleActionParametersMustUnderstand

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

type RuleNewParamsBodySetCacheControlRuleActionParametersMustUnderstandOperation

type RuleNewParamsBodySetCacheControlRuleActionParametersMustUnderstandOperation string

The operation to perform on the cache-control directive.

const (
	RuleNewParamsBodySetCacheControlRuleActionParametersMustUnderstandOperationSet    RuleNewParamsBodySetCacheControlRuleActionParametersMustUnderstandOperation = "set"
	RuleNewParamsBodySetCacheControlRuleActionParametersMustUnderstandOperationRemove RuleNewParamsBodySetCacheControlRuleActionParametersMustUnderstandOperation = "remove"
)

func (RuleNewParamsBodySetCacheControlRuleActionParametersMustUnderstandOperation) IsKnown

type RuleNewParamsBodySetCacheControlRuleActionParametersMustUnderstandRemoveDirective

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

type RuleNewParamsBodySetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation

type RuleNewParamsBodySetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleNewParamsBodySetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperationSet    RuleNewParamsBodySetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation = "set"
	RuleNewParamsBodySetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperationRemove RuleNewParamsBodySetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation = "remove"
)

func (RuleNewParamsBodySetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation) IsKnown

type RuleNewParamsBodySetCacheControlRuleActionParametersMustUnderstandSetDirective

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

type RuleNewParamsBodySetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation

type RuleNewParamsBodySetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleNewParamsBodySetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperationSet    RuleNewParamsBodySetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation = "set"
	RuleNewParamsBodySetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperationRemove RuleNewParamsBodySetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation = "remove"
)

func (RuleNewParamsBodySetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation) IsKnown

type RuleNewParamsBodySetCacheControlRuleActionParametersNoCache

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

type RuleNewParamsBodySetCacheControlRuleActionParametersNoCacheOperation

type RuleNewParamsBodySetCacheControlRuleActionParametersNoCacheOperation string

The operation to perform on the cache-control directive.

const (
	RuleNewParamsBodySetCacheControlRuleActionParametersNoCacheOperationSet    RuleNewParamsBodySetCacheControlRuleActionParametersNoCacheOperation = "set"
	RuleNewParamsBodySetCacheControlRuleActionParametersNoCacheOperationRemove RuleNewParamsBodySetCacheControlRuleActionParametersNoCacheOperation = "remove"
)

func (RuleNewParamsBodySetCacheControlRuleActionParametersNoCacheOperation) IsKnown

type RuleNewParamsBodySetCacheControlRuleActionParametersNoCacheRemoveDirective

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

type RuleNewParamsBodySetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation

type RuleNewParamsBodySetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleNewParamsBodySetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperationSet    RuleNewParamsBodySetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation = "set"
	RuleNewParamsBodySetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperationRemove RuleNewParamsBodySetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation = "remove"
)

func (RuleNewParamsBodySetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation) IsKnown

type RuleNewParamsBodySetCacheControlRuleActionParametersNoCacheSetDirective

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

type RuleNewParamsBodySetCacheControlRuleActionParametersNoCacheSetDirectiveOperation

type RuleNewParamsBodySetCacheControlRuleActionParametersNoCacheSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleNewParamsBodySetCacheControlRuleActionParametersNoCacheSetDirectiveOperationSet    RuleNewParamsBodySetCacheControlRuleActionParametersNoCacheSetDirectiveOperation = "set"
	RuleNewParamsBodySetCacheControlRuleActionParametersNoCacheSetDirectiveOperationRemove RuleNewParamsBodySetCacheControlRuleActionParametersNoCacheSetDirectiveOperation = "remove"
)

func (RuleNewParamsBodySetCacheControlRuleActionParametersNoCacheSetDirectiveOperation) IsKnown

type RuleNewParamsBodySetCacheControlRuleActionParametersNoCacheUnion

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

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

type RuleNewParamsBodySetCacheControlRuleActionParametersNoStoreOperation

type RuleNewParamsBodySetCacheControlRuleActionParametersNoStoreOperation string

The operation to perform on the cache-control directive.

const (
	RuleNewParamsBodySetCacheControlRuleActionParametersNoStoreOperationSet    RuleNewParamsBodySetCacheControlRuleActionParametersNoStoreOperation = "set"
	RuleNewParamsBodySetCacheControlRuleActionParametersNoStoreOperationRemove RuleNewParamsBodySetCacheControlRuleActionParametersNoStoreOperation = "remove"
)

func (RuleNewParamsBodySetCacheControlRuleActionParametersNoStoreOperation) IsKnown

type RuleNewParamsBodySetCacheControlRuleActionParametersNoStoreRemoveDirective

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

type RuleNewParamsBodySetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation

type RuleNewParamsBodySetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleNewParamsBodySetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperationSet    RuleNewParamsBodySetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation = "set"
	RuleNewParamsBodySetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperationRemove RuleNewParamsBodySetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation = "remove"
)

func (RuleNewParamsBodySetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation) IsKnown

type RuleNewParamsBodySetCacheControlRuleActionParametersNoStoreSetDirective

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

type RuleNewParamsBodySetCacheControlRuleActionParametersNoStoreSetDirectiveOperation

type RuleNewParamsBodySetCacheControlRuleActionParametersNoStoreSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleNewParamsBodySetCacheControlRuleActionParametersNoStoreSetDirectiveOperationSet    RuleNewParamsBodySetCacheControlRuleActionParametersNoStoreSetDirectiveOperation = "set"
	RuleNewParamsBodySetCacheControlRuleActionParametersNoStoreSetDirectiveOperationRemove RuleNewParamsBodySetCacheControlRuleActionParametersNoStoreSetDirectiveOperation = "remove"
)

func (RuleNewParamsBodySetCacheControlRuleActionParametersNoStoreSetDirectiveOperation) IsKnown

type RuleNewParamsBodySetCacheControlRuleActionParametersNoStoreUnion

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

A cache-control directive configuration.

Satisfied by rulesets.RuleNewParamsBodySetCacheControlRuleActionParametersNoStoreSetDirective, rulesets.RuleNewParamsBodySetCacheControlRuleActionParametersNoStoreRemoveDirective, RuleNewParamsBodySetCacheControlRuleActionParametersNoStore.

type RuleNewParamsBodySetCacheControlRuleActionParametersNoTransform

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

type RuleNewParamsBodySetCacheControlRuleActionParametersNoTransformOperation

type RuleNewParamsBodySetCacheControlRuleActionParametersNoTransformOperation string

The operation to perform on the cache-control directive.

const (
	RuleNewParamsBodySetCacheControlRuleActionParametersNoTransformOperationSet    RuleNewParamsBodySetCacheControlRuleActionParametersNoTransformOperation = "set"
	RuleNewParamsBodySetCacheControlRuleActionParametersNoTransformOperationRemove RuleNewParamsBodySetCacheControlRuleActionParametersNoTransformOperation = "remove"
)

func (RuleNewParamsBodySetCacheControlRuleActionParametersNoTransformOperation) IsKnown

type RuleNewParamsBodySetCacheControlRuleActionParametersNoTransformRemoveDirective

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

type RuleNewParamsBodySetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation

type RuleNewParamsBodySetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleNewParamsBodySetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperationSet    RuleNewParamsBodySetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation = "set"
	RuleNewParamsBodySetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperationRemove RuleNewParamsBodySetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation = "remove"
)

func (RuleNewParamsBodySetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation) IsKnown

type RuleNewParamsBodySetCacheControlRuleActionParametersNoTransformSetDirective

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

type RuleNewParamsBodySetCacheControlRuleActionParametersNoTransformSetDirectiveOperation

type RuleNewParamsBodySetCacheControlRuleActionParametersNoTransformSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleNewParamsBodySetCacheControlRuleActionParametersNoTransformSetDirectiveOperationSet    RuleNewParamsBodySetCacheControlRuleActionParametersNoTransformSetDirectiveOperation = "set"
	RuleNewParamsBodySetCacheControlRuleActionParametersNoTransformSetDirectiveOperationRemove RuleNewParamsBodySetCacheControlRuleActionParametersNoTransformSetDirectiveOperation = "remove"
)

func (RuleNewParamsBodySetCacheControlRuleActionParametersNoTransformSetDirectiveOperation) IsKnown

type RuleNewParamsBodySetCacheControlRuleActionParametersPrivate

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

type RuleNewParamsBodySetCacheControlRuleActionParametersPrivateOperation

type RuleNewParamsBodySetCacheControlRuleActionParametersPrivateOperation string

The operation to perform on the cache-control directive.

const (
	RuleNewParamsBodySetCacheControlRuleActionParametersPrivateOperationSet    RuleNewParamsBodySetCacheControlRuleActionParametersPrivateOperation = "set"
	RuleNewParamsBodySetCacheControlRuleActionParametersPrivateOperationRemove RuleNewParamsBodySetCacheControlRuleActionParametersPrivateOperation = "remove"
)

func (RuleNewParamsBodySetCacheControlRuleActionParametersPrivateOperation) IsKnown

type RuleNewParamsBodySetCacheControlRuleActionParametersPrivateRemoveDirective

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

type RuleNewParamsBodySetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation

type RuleNewParamsBodySetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleNewParamsBodySetCacheControlRuleActionParametersPrivateRemoveDirectiveOperationSet    RuleNewParamsBodySetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation = "set"
	RuleNewParamsBodySetCacheControlRuleActionParametersPrivateRemoveDirectiveOperationRemove RuleNewParamsBodySetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation = "remove"
)

func (RuleNewParamsBodySetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation) IsKnown

type RuleNewParamsBodySetCacheControlRuleActionParametersPrivateSetDirective

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

type RuleNewParamsBodySetCacheControlRuleActionParametersPrivateSetDirectiveOperation

type RuleNewParamsBodySetCacheControlRuleActionParametersPrivateSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleNewParamsBodySetCacheControlRuleActionParametersPrivateSetDirectiveOperationSet    RuleNewParamsBodySetCacheControlRuleActionParametersPrivateSetDirectiveOperation = "set"
	RuleNewParamsBodySetCacheControlRuleActionParametersPrivateSetDirectiveOperationRemove RuleNewParamsBodySetCacheControlRuleActionParametersPrivateSetDirectiveOperation = "remove"
)

func (RuleNewParamsBodySetCacheControlRuleActionParametersPrivateSetDirectiveOperation) IsKnown

type RuleNewParamsBodySetCacheControlRuleActionParametersPrivateUnion

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

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

type RuleNewParamsBodySetCacheControlRuleActionParametersProxyRevalidateOperation

type RuleNewParamsBodySetCacheControlRuleActionParametersProxyRevalidateOperation string

The operation to perform on the cache-control directive.

const (
	RuleNewParamsBodySetCacheControlRuleActionParametersProxyRevalidateOperationSet    RuleNewParamsBodySetCacheControlRuleActionParametersProxyRevalidateOperation = "set"
	RuleNewParamsBodySetCacheControlRuleActionParametersProxyRevalidateOperationRemove RuleNewParamsBodySetCacheControlRuleActionParametersProxyRevalidateOperation = "remove"
)

func (RuleNewParamsBodySetCacheControlRuleActionParametersProxyRevalidateOperation) IsKnown

type RuleNewParamsBodySetCacheControlRuleActionParametersProxyRevalidateRemoveDirective

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

type RuleNewParamsBodySetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation

type RuleNewParamsBodySetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleNewParamsBodySetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperationSet    RuleNewParamsBodySetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation = "set"
	RuleNewParamsBodySetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperationRemove RuleNewParamsBodySetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation = "remove"
)

func (RuleNewParamsBodySetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation) IsKnown

type RuleNewParamsBodySetCacheControlRuleActionParametersProxyRevalidateSetDirective

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

type RuleNewParamsBodySetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation

type RuleNewParamsBodySetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleNewParamsBodySetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperationSet    RuleNewParamsBodySetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation = "set"
	RuleNewParamsBodySetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperationRemove RuleNewParamsBodySetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation = "remove"
)

func (RuleNewParamsBodySetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation) IsKnown

type RuleNewParamsBodySetCacheControlRuleActionParametersPublic

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

type RuleNewParamsBodySetCacheControlRuleActionParametersPublicOperation

type RuleNewParamsBodySetCacheControlRuleActionParametersPublicOperation string

The operation to perform on the cache-control directive.

const (
	RuleNewParamsBodySetCacheControlRuleActionParametersPublicOperationSet    RuleNewParamsBodySetCacheControlRuleActionParametersPublicOperation = "set"
	RuleNewParamsBodySetCacheControlRuleActionParametersPublicOperationRemove RuleNewParamsBodySetCacheControlRuleActionParametersPublicOperation = "remove"
)

func (RuleNewParamsBodySetCacheControlRuleActionParametersPublicOperation) IsKnown

type RuleNewParamsBodySetCacheControlRuleActionParametersPublicRemoveDirective

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

type RuleNewParamsBodySetCacheControlRuleActionParametersPublicRemoveDirectiveOperation

type RuleNewParamsBodySetCacheControlRuleActionParametersPublicRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleNewParamsBodySetCacheControlRuleActionParametersPublicRemoveDirectiveOperationSet    RuleNewParamsBodySetCacheControlRuleActionParametersPublicRemoveDirectiveOperation = "set"
	RuleNewParamsBodySetCacheControlRuleActionParametersPublicRemoveDirectiveOperationRemove RuleNewParamsBodySetCacheControlRuleActionParametersPublicRemoveDirectiveOperation = "remove"
)

func (RuleNewParamsBodySetCacheControlRuleActionParametersPublicRemoveDirectiveOperation) IsKnown

type RuleNewParamsBodySetCacheControlRuleActionParametersPublicSetDirective

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

type RuleNewParamsBodySetCacheControlRuleActionParametersPublicSetDirectiveOperation

type RuleNewParamsBodySetCacheControlRuleActionParametersPublicSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleNewParamsBodySetCacheControlRuleActionParametersPublicSetDirectiveOperationSet    RuleNewParamsBodySetCacheControlRuleActionParametersPublicSetDirectiveOperation = "set"
	RuleNewParamsBodySetCacheControlRuleActionParametersPublicSetDirectiveOperationRemove RuleNewParamsBodySetCacheControlRuleActionParametersPublicSetDirectiveOperation = "remove"
)

func (RuleNewParamsBodySetCacheControlRuleActionParametersPublicSetDirectiveOperation) IsKnown

type RuleNewParamsBodySetCacheControlRuleActionParametersPublicUnion

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

A cache-control directive configuration.

Satisfied by rulesets.RuleNewParamsBodySetCacheControlRuleActionParametersPublicSetDirective, rulesets.RuleNewParamsBodySetCacheControlRuleActionParametersPublicRemoveDirective, RuleNewParamsBodySetCacheControlRuleActionParametersPublic.

type RuleNewParamsBodySetCacheControlRuleActionParametersSMaxage

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

type RuleNewParamsBodySetCacheControlRuleActionParametersSMaxageOperation

type RuleNewParamsBodySetCacheControlRuleActionParametersSMaxageOperation string

The operation to perform on the cache-control directive.

const (
	RuleNewParamsBodySetCacheControlRuleActionParametersSMaxageOperationSet    RuleNewParamsBodySetCacheControlRuleActionParametersSMaxageOperation = "set"
	RuleNewParamsBodySetCacheControlRuleActionParametersSMaxageOperationRemove RuleNewParamsBodySetCacheControlRuleActionParametersSMaxageOperation = "remove"
)

func (RuleNewParamsBodySetCacheControlRuleActionParametersSMaxageOperation) IsKnown

type RuleNewParamsBodySetCacheControlRuleActionParametersSMaxageRemoveDirective

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

type RuleNewParamsBodySetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation

type RuleNewParamsBodySetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleNewParamsBodySetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperationSet    RuleNewParamsBodySetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation = "set"
	RuleNewParamsBodySetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperationRemove RuleNewParamsBodySetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation = "remove"
)

func (RuleNewParamsBodySetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation) IsKnown

type RuleNewParamsBodySetCacheControlRuleActionParametersSMaxageSetDirective

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

type RuleNewParamsBodySetCacheControlRuleActionParametersSMaxageSetDirectiveOperation

type RuleNewParamsBodySetCacheControlRuleActionParametersSMaxageSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleNewParamsBodySetCacheControlRuleActionParametersSMaxageSetDirectiveOperationSet    RuleNewParamsBodySetCacheControlRuleActionParametersSMaxageSetDirectiveOperation = "set"
	RuleNewParamsBodySetCacheControlRuleActionParametersSMaxageSetDirectiveOperationRemove RuleNewParamsBodySetCacheControlRuleActionParametersSMaxageSetDirectiveOperation = "remove"
)

func (RuleNewParamsBodySetCacheControlRuleActionParametersSMaxageSetDirectiveOperation) IsKnown

type RuleNewParamsBodySetCacheControlRuleActionParametersSMaxageUnion

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

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

type RuleNewParamsBodySetCacheControlRuleActionParametersStaleIfErrorOperation

type RuleNewParamsBodySetCacheControlRuleActionParametersStaleIfErrorOperation string

The operation to perform on the cache-control directive.

const (
	RuleNewParamsBodySetCacheControlRuleActionParametersStaleIfErrorOperationSet    RuleNewParamsBodySetCacheControlRuleActionParametersStaleIfErrorOperation = "set"
	RuleNewParamsBodySetCacheControlRuleActionParametersStaleIfErrorOperationRemove RuleNewParamsBodySetCacheControlRuleActionParametersStaleIfErrorOperation = "remove"
)

func (RuleNewParamsBodySetCacheControlRuleActionParametersStaleIfErrorOperation) IsKnown

type RuleNewParamsBodySetCacheControlRuleActionParametersStaleIfErrorRemoveDirective

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

type RuleNewParamsBodySetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation

type RuleNewParamsBodySetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleNewParamsBodySetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperationSet    RuleNewParamsBodySetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation = "set"
	RuleNewParamsBodySetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperationRemove RuleNewParamsBodySetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation = "remove"
)

func (RuleNewParamsBodySetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation) IsKnown

type RuleNewParamsBodySetCacheControlRuleActionParametersStaleIfErrorSetDirective

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

type RuleNewParamsBodySetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation

type RuleNewParamsBodySetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleNewParamsBodySetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperationSet    RuleNewParamsBodySetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation = "set"
	RuleNewParamsBodySetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperationRemove RuleNewParamsBodySetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation = "remove"
)

func (RuleNewParamsBodySetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation) IsKnown

type RuleNewParamsBodySetCacheControlRuleActionParametersStaleIfErrorUnion

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

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

type RuleNewParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateOperation

type RuleNewParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateOperation string

The operation to perform on the cache-control directive.

const (
	RuleNewParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateOperationSet    RuleNewParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateOperation = "set"
	RuleNewParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateOperationRemove RuleNewParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateOperation = "remove"
)

func (RuleNewParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateOperation) IsKnown

type RuleNewParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective

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

type RuleNewParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation

type RuleNewParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleNewParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperationSet    RuleNewParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation = "set"
	RuleNewParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperationRemove RuleNewParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation = "remove"
)

func (RuleNewParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation) IsKnown

type RuleNewParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective

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

type RuleNewParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation

type RuleNewParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleNewParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperationSet    RuleNewParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation = "set"
	RuleNewParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperationRemove RuleNewParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation = "remove"
)

func (RuleNewParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation) IsKnown

type RuleNewParamsBodySetCacheControlRuleActionParametersStaleWhileRevalidateUnion

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

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

type RuleNewParamsBodySetCacheControlRulePosition

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

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

type RuleNewParamsBodySetCacheControlRulePositionAfterPosition

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

type RuleNewParamsBodySetCacheControlRulePositionBeforePosition

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

type RuleNewParamsBodySetCacheControlRulePositionIndexPosition

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

type RuleNewParamsBodySetCacheControlRuleRatelimit

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

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

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

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

type RuleNewParamsBodySetCacheTagsRule

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

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

type RuleNewParamsBodySetCacheTagsRuleAction

type RuleNewParamsBodySetCacheTagsRuleAction string

The action to perform when the rule matches.

const (
	RuleNewParamsBodySetCacheTagsRuleActionSetCacheTags RuleNewParamsBodySetCacheTagsRuleAction = "set_cache_tags"
)

func (RuleNewParamsBodySetCacheTagsRuleAction) IsKnown

type RuleNewParamsBodySetCacheTagsRuleActionParameters

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

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

type RuleNewParamsBodySetCacheTagsRuleActionParametersAddCacheTagsExpression

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

type RuleNewParamsBodySetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation

type RuleNewParamsBodySetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation string

The operation to perform on the cache tags.

const (
	RuleNewParamsBodySetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationAdd    RuleNewParamsBodySetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "add"
	RuleNewParamsBodySetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationRemove RuleNewParamsBodySetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "remove"
	RuleNewParamsBodySetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationSet    RuleNewParamsBodySetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "set"
)

func (RuleNewParamsBodySetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation) IsKnown

type RuleNewParamsBodySetCacheTagsRuleActionParametersAddCacheTagsValues

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

type RuleNewParamsBodySetCacheTagsRuleActionParametersAddCacheTagsValuesOperation

type RuleNewParamsBodySetCacheTagsRuleActionParametersAddCacheTagsValuesOperation string

The operation to perform on the cache tags.

const (
	RuleNewParamsBodySetCacheTagsRuleActionParametersAddCacheTagsValuesOperationAdd    RuleNewParamsBodySetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "add"
	RuleNewParamsBodySetCacheTagsRuleActionParametersAddCacheTagsValuesOperationRemove RuleNewParamsBodySetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "remove"
	RuleNewParamsBodySetCacheTagsRuleActionParametersAddCacheTagsValuesOperationSet    RuleNewParamsBodySetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "set"
)

func (RuleNewParamsBodySetCacheTagsRuleActionParametersAddCacheTagsValuesOperation) IsKnown

type RuleNewParamsBodySetCacheTagsRuleActionParametersOperation

type RuleNewParamsBodySetCacheTagsRuleActionParametersOperation string

The operation to perform on the cache tags.

const (
	RuleNewParamsBodySetCacheTagsRuleActionParametersOperationAdd    RuleNewParamsBodySetCacheTagsRuleActionParametersOperation = "add"
	RuleNewParamsBodySetCacheTagsRuleActionParametersOperationRemove RuleNewParamsBodySetCacheTagsRuleActionParametersOperation = "remove"
	RuleNewParamsBodySetCacheTagsRuleActionParametersOperationSet    RuleNewParamsBodySetCacheTagsRuleActionParametersOperation = "set"
)

func (RuleNewParamsBodySetCacheTagsRuleActionParametersOperation) IsKnown

type RuleNewParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsExpression

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

type RuleNewParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation

type RuleNewParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation string

The operation to perform on the cache tags.

const (
	RuleNewParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationAdd    RuleNewParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "add"
	RuleNewParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationRemove RuleNewParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "remove"
	RuleNewParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationSet    RuleNewParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "set"
)

func (RuleNewParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation) IsKnown

type RuleNewParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsValues

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

type RuleNewParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation

type RuleNewParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation string

The operation to perform on the cache tags.

const (
	RuleNewParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationAdd    RuleNewParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "add"
	RuleNewParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationRemove RuleNewParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "remove"
	RuleNewParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationSet    RuleNewParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "set"
)

func (RuleNewParamsBodySetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation) IsKnown

type RuleNewParamsBodySetCacheTagsRuleActionParametersSetCacheTagsExpression

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

type RuleNewParamsBodySetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation

type RuleNewParamsBodySetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation string

The operation to perform on the cache tags.

const (
	RuleNewParamsBodySetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationAdd    RuleNewParamsBodySetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "add"
	RuleNewParamsBodySetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationRemove RuleNewParamsBodySetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "remove"
	RuleNewParamsBodySetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationSet    RuleNewParamsBodySetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "set"
)

func (RuleNewParamsBodySetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation) IsKnown

type RuleNewParamsBodySetCacheTagsRuleActionParametersSetCacheTagsValues

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

type RuleNewParamsBodySetCacheTagsRuleActionParametersSetCacheTagsValuesOperation

type RuleNewParamsBodySetCacheTagsRuleActionParametersSetCacheTagsValuesOperation string

The operation to perform on the cache tags.

const (
	RuleNewParamsBodySetCacheTagsRuleActionParametersSetCacheTagsValuesOperationAdd    RuleNewParamsBodySetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "add"
	RuleNewParamsBodySetCacheTagsRuleActionParametersSetCacheTagsValuesOperationRemove RuleNewParamsBodySetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "remove"
	RuleNewParamsBodySetCacheTagsRuleActionParametersSetCacheTagsValuesOperationSet    RuleNewParamsBodySetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "set"
)

func (RuleNewParamsBodySetCacheTagsRuleActionParametersSetCacheTagsValuesOperation) IsKnown

type RuleNewParamsBodySetCacheTagsRuleExposedCredentialCheck

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

type RuleNewParamsBodySetCacheTagsRulePosition

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

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

type RuleNewParamsBodySetCacheTagsRulePositionAfterPosition

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

type RuleNewParamsBodySetCacheTagsRulePositionBeforePosition

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

type RuleNewParamsBodySetCacheTagsRulePositionIndexPosition

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

type RuleNewParamsBodySetCacheTagsRulePositionUnion

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

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

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

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

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

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 RuleNewParamsBodyTransformResponseHTMLRule added in v7.7.0

type RuleNewParamsBodyTransformResponseHTMLRule struct {
	// The unique ID of the rule.
	ID param.Field[string] `json:"id"`
	// The action to perform when the rule matches.
	Action param.Field[RuleNewParamsBodyTransformResponseHTMLRuleAction] `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters param.Field[RuleNewParamsBodyTransformResponseHTMLRuleActionParameters] `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[RuleNewParamsBodyTransformResponseHTMLRuleExposedCredentialCheck] `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[RuleNewParamsBodyTransformResponseHTMLRulePositionUnion] `json:"position"`
	// An object configuring the rule's rate limit behavior.
	Ratelimit param.Field[RuleNewParamsBodyTransformResponseHTMLRuleRatelimit] `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref param.Field[string] `json:"ref"`
}

func (RuleNewParamsBodyTransformResponseHTMLRule) MarshalJSON added in v7.7.0

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

type RuleNewParamsBodyTransformResponseHTMLRuleAction added in v7.7.0

type RuleNewParamsBodyTransformResponseHTMLRuleAction string

The action to perform when the rule matches.

const (
	RuleNewParamsBodyTransformResponseHTMLRuleActionTransformResponseHTML RuleNewParamsBodyTransformResponseHTMLRuleAction = "transform_response_html"
)

func (RuleNewParamsBodyTransformResponseHTMLRuleAction) IsKnown added in v7.7.0

type RuleNewParamsBodyTransformResponseHTMLRuleActionParameters added in v7.7.0

type RuleNewParamsBodyTransformResponseHTMLRuleActionParameters struct {
	// Enables the link maze transformation on the response.
	LinkMaze param.Field[interface{}] `json:"link_maze" api:"required"`
}

The parameters configuring the rule's action.

func (RuleNewParamsBodyTransformResponseHTMLRuleActionParameters) MarshalJSON added in v7.7.0

type RuleNewParamsBodyTransformResponseHTMLRuleExposedCredentialCheck added in v7.7.0

type RuleNewParamsBodyTransformResponseHTMLRuleExposedCredentialCheck 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 (RuleNewParamsBodyTransformResponseHTMLRuleExposedCredentialCheck) MarshalJSON added in v7.7.0

type RuleNewParamsBodyTransformResponseHTMLRulePosition added in v7.7.0

type RuleNewParamsBodyTransformResponseHTMLRulePosition 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 (RuleNewParamsBodyTransformResponseHTMLRulePosition) MarshalJSON added in v7.7.0

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

type RuleNewParamsBodyTransformResponseHTMLRulePositionAfterPosition added in v7.7.0

type RuleNewParamsBodyTransformResponseHTMLRulePositionAfterPosition 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 (RuleNewParamsBodyTransformResponseHTMLRulePositionAfterPosition) MarshalJSON added in v7.7.0

type RuleNewParamsBodyTransformResponseHTMLRulePositionBeforePosition added in v7.7.0

type RuleNewParamsBodyTransformResponseHTMLRulePositionBeforePosition 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 (RuleNewParamsBodyTransformResponseHTMLRulePositionBeforePosition) MarshalJSON added in v7.7.0

type RuleNewParamsBodyTransformResponseHTMLRulePositionIndexPosition added in v7.7.0

type RuleNewParamsBodyTransformResponseHTMLRulePositionIndexPosition 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 (RuleNewParamsBodyTransformResponseHTMLRulePositionIndexPosition) MarshalJSON added in v7.7.0

type RuleNewParamsBodyTransformResponseHTMLRulePositionUnion added in v7.7.0

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

An object configuring where the rule will be placed.

Satisfied by rulesets.RuleNewParamsBodyTransformResponseHTMLRulePositionBeforePosition, rulesets.RuleNewParamsBodyTransformResponseHTMLRulePositionAfterPosition, rulesets.RuleNewParamsBodyTransformResponseHTMLRulePositionIndexPosition, RuleNewParamsBodyTransformResponseHTMLRulePosition.

type RuleNewParamsBodyTransformResponseHTMLRuleRatelimit added in v7.7.0

type RuleNewParamsBodyTransformResponseHTMLRuleRatelimit 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 (RuleNewParamsBodyTransformResponseHTMLRuleRatelimit) MarshalJSON added in v7.7.0

func (r RuleNewParamsBodyTransformResponseHTMLRuleRatelimit) MarshalJSON() (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 result.
	Result RuleNewResponseEnvelopeResult `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 RuleNewResponseEnvelopeResult added in v7.9.0

type RuleNewResponseEnvelopeResult 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 []RuleNewResponseEnvelopeResultRules `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        ruleNewResponseEnvelopeResultJSON `json:"-"`
}

A ruleset object.

func (*RuleNewResponseEnvelopeResult) UnmarshalJSON added in v7.9.0

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

type RuleNewResponseEnvelopeResultRules added in v7.9.0

type RuleNewResponseEnvelopeResultRules 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 RuleNewResponseEnvelopeResultRulesAction `json:"action"`
	// This field can have the runtime type of [BlockRuleActionParameters],
	// [interface{}], [CompressResponseRuleActionParameters],
	// [ExecuteRuleActionParameters], [LogCustomFieldRuleActionParameters],
	// [RedirectRuleActionParameters], [RewriteRuleActionParameters],
	// [RouteRuleActionParameters], [ScoreRuleActionParameters],
	// [ServeErrorRuleActionParameters],
	// [RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParameters],
	// [SetCacheSettingsRuleActionParameters],
	// [RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParameters],
	// [SetConfigRuleActionParameters], [SkipRuleActionParameters],
	// [RuleNewResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleActionParameters].
	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],
	// [RuleNewResponseEnvelopeResultRulesRulesetsChallengeRuleExposedCredentialCheck],
	// [CompressResponseRuleExposedCredentialCheck],
	// [DDoSDynamicRuleExposedCredentialCheck], [ExecuteRuleExposedCredentialCheck],
	// [ForceConnectionCloseRuleExposedCredentialCheck],
	// [RuleNewResponseEnvelopeResultRulesRulesetsJSChallengeRuleExposedCredentialCheck],
	// [LogRuleExposedCredentialCheck], [LogCustomFieldRuleExposedCredentialCheck],
	// [ManagedChallengeRuleExposedCredentialCheck],
	// [RedirectRuleExposedCredentialCheck], [RewriteRuleExposedCredentialCheck],
	// [RouteRuleExposedCredentialCheck], [ScoreRuleExposedCredentialCheck],
	// [ServeErrorRuleExposedCredentialCheck],
	// [RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleExposedCredentialCheck],
	// [SetCacheSettingsRuleExposedCredentialCheck],
	// [RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleExposedCredentialCheck],
	// [SetConfigRuleExposedCredentialCheck], [SkipRuleExposedCredentialCheck],
	// [RuleNewResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleExposedCredentialCheck].
	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],
	// [RuleNewResponseEnvelopeResultRulesRulesetsChallengeRuleRatelimit],
	// [CompressResponseRuleRatelimit], [DDoSDynamicRuleRatelimit],
	// [ExecuteRuleRatelimit], [ForceConnectionCloseRuleRatelimit],
	// [RuleNewResponseEnvelopeResultRulesRulesetsJSChallengeRuleRatelimit],
	// [LogRuleRatelimit], [LogCustomFieldRuleRatelimit],
	// [ManagedChallengeRuleRatelimit], [RedirectRuleRatelimit],
	// [RewriteRuleRatelimit], [RouteRuleRatelimit], [ScoreRuleRatelimit],
	// [ServeErrorRuleRatelimit],
	// [RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleRatelimit],
	// [SetCacheSettingsRuleRatelimit],
	// [RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleRatelimit],
	// [SetConfigRuleRatelimit], [SkipRuleRatelimit],
	// [RuleNewResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleRatelimit].
	Ratelimit interface{} `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                                 `json:"ref"`
	JSON ruleNewResponseEnvelopeResultRulesJSON `json:"-"`
	// contains filtered or unexported fields
}

func (*RuleNewResponseEnvelopeResultRules) UnmarshalJSON added in v7.9.0

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

type RuleNewResponseEnvelopeResultRulesAction added in v7.9.0

type RuleNewResponseEnvelopeResultRulesAction string

The action to perform when the rule matches.

const (
	RuleNewResponseEnvelopeResultRulesActionBlock                 RuleNewResponseEnvelopeResultRulesAction = "block"
	RuleNewResponseEnvelopeResultRulesActionChallenge             RuleNewResponseEnvelopeResultRulesAction = "challenge"
	RuleNewResponseEnvelopeResultRulesActionCompressResponse      RuleNewResponseEnvelopeResultRulesAction = "compress_response"
	RuleNewResponseEnvelopeResultRulesActionDDoSDynamic           RuleNewResponseEnvelopeResultRulesAction = "ddos_dynamic"
	RuleNewResponseEnvelopeResultRulesActionExecute               RuleNewResponseEnvelopeResultRulesAction = "execute"
	RuleNewResponseEnvelopeResultRulesActionForceConnectionClose  RuleNewResponseEnvelopeResultRulesAction = "force_connection_close"
	RuleNewResponseEnvelopeResultRulesActionJSChallenge           RuleNewResponseEnvelopeResultRulesAction = "js_challenge"
	RuleNewResponseEnvelopeResultRulesActionLog                   RuleNewResponseEnvelopeResultRulesAction = "log"
	RuleNewResponseEnvelopeResultRulesActionLogCustomField        RuleNewResponseEnvelopeResultRulesAction = "log_custom_field"
	RuleNewResponseEnvelopeResultRulesActionManagedChallenge      RuleNewResponseEnvelopeResultRulesAction = "managed_challenge"
	RuleNewResponseEnvelopeResultRulesActionRedirect              RuleNewResponseEnvelopeResultRulesAction = "redirect"
	RuleNewResponseEnvelopeResultRulesActionRewrite               RuleNewResponseEnvelopeResultRulesAction = "rewrite"
	RuleNewResponseEnvelopeResultRulesActionRoute                 RuleNewResponseEnvelopeResultRulesAction = "route"
	RuleNewResponseEnvelopeResultRulesActionScore                 RuleNewResponseEnvelopeResultRulesAction = "score"
	RuleNewResponseEnvelopeResultRulesActionServeError            RuleNewResponseEnvelopeResultRulesAction = "serve_error"
	RuleNewResponseEnvelopeResultRulesActionSetCacheControl       RuleNewResponseEnvelopeResultRulesAction = "set_cache_control"
	RuleNewResponseEnvelopeResultRulesActionSetCacheSettings      RuleNewResponseEnvelopeResultRulesAction = "set_cache_settings"
	RuleNewResponseEnvelopeResultRulesActionSetCacheTags          RuleNewResponseEnvelopeResultRulesAction = "set_cache_tags"
	RuleNewResponseEnvelopeResultRulesActionSetConfig             RuleNewResponseEnvelopeResultRulesAction = "set_config"
	RuleNewResponseEnvelopeResultRulesActionSkip                  RuleNewResponseEnvelopeResultRulesAction = "skip"
	RuleNewResponseEnvelopeResultRulesActionTransformResponseHTML RuleNewResponseEnvelopeResultRulesAction = "transform_response_html"
)

func (RuleNewResponseEnvelopeResultRulesAction) IsKnown added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsChallengeRule added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsChallengeRule 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 RuleNewResponseEnvelopeResultRulesRulesetsChallengeRuleAction `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 RuleNewResponseEnvelopeResultRulesRulesetsChallengeRuleExposedCredentialCheck `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 RuleNewResponseEnvelopeResultRulesRulesetsChallengeRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                                                      `json:"ref"`
	JSON ruleNewResponseEnvelopeResultRulesRulesetsChallengeRuleJSON `json:"-"`
}

func (*RuleNewResponseEnvelopeResultRulesRulesetsChallengeRule) UnmarshalJSON added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsChallengeRuleAction added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsChallengeRuleAction string

The action to perform when the rule matches.

const (
	RuleNewResponseEnvelopeResultRulesRulesetsChallengeRuleActionChallenge RuleNewResponseEnvelopeResultRulesRulesetsChallengeRuleAction = "challenge"
)

func (RuleNewResponseEnvelopeResultRulesRulesetsChallengeRuleAction) IsKnown added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsChallengeRuleExposedCredentialCheck added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsChallengeRuleExposedCredentialCheck 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               ruleNewResponseEnvelopeResultRulesRulesetsChallengeRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*RuleNewResponseEnvelopeResultRulesRulesetsChallengeRuleExposedCredentialCheck) UnmarshalJSON added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsChallengeRuleRatelimit added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsChallengeRuleRatelimit 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                    ruleNewResponseEnvelopeResultRulesRulesetsChallengeRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*RuleNewResponseEnvelopeResultRulesRulesetsChallengeRuleRatelimit) UnmarshalJSON added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsJSChallengeRule added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsJSChallengeRule 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 RuleNewResponseEnvelopeResultRulesRulesetsJSChallengeRuleAction `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 RuleNewResponseEnvelopeResultRulesRulesetsJSChallengeRuleExposedCredentialCheck `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 RuleNewResponseEnvelopeResultRulesRulesetsJSChallengeRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                                                        `json:"ref"`
	JSON ruleNewResponseEnvelopeResultRulesRulesetsJSChallengeRuleJSON `json:"-"`
}

func (*RuleNewResponseEnvelopeResultRulesRulesetsJSChallengeRule) UnmarshalJSON added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsJSChallengeRuleAction added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsJSChallengeRuleAction string

The action to perform when the rule matches.

const (
	RuleNewResponseEnvelopeResultRulesRulesetsJSChallengeRuleActionJSChallenge RuleNewResponseEnvelopeResultRulesRulesetsJSChallengeRuleAction = "js_challenge"
)

func (RuleNewResponseEnvelopeResultRulesRulesetsJSChallengeRuleAction) IsKnown added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsJSChallengeRuleExposedCredentialCheck added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsJSChallengeRuleExposedCredentialCheck 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               ruleNewResponseEnvelopeResultRulesRulesetsJSChallengeRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*RuleNewResponseEnvelopeResultRulesRulesetsJSChallengeRuleExposedCredentialCheck) UnmarshalJSON added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsJSChallengeRuleRatelimit added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsJSChallengeRuleRatelimit 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                    ruleNewResponseEnvelopeResultRulesRulesetsJSChallengeRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*RuleNewResponseEnvelopeResultRulesRulesetsJSChallengeRuleRatelimit) UnmarshalJSON added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRule added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRule 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 RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleAction `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParameters `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 RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleExposedCredentialCheck `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 RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                                                            `json:"ref"`
	JSON ruleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleJSON `json:"-"`
}

func (*RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRule) UnmarshalJSON added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleAction added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleAction string

The action to perform when the rule matches.

const (
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionSetCacheControl RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleAction = "set_cache_control"
)

func (RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleAction) IsKnown added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParameters added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParameters struct {
	// A cache-control directive configuration.
	Immutable RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutable `json:"immutable"`
	// A cache-control directive configuration that accepts a duration value in
	// seconds.
	MaxAge RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAge `json:"max-age"`
	// A cache-control directive configuration.
	MustRevalidate RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate `json:"must-revalidate"`
	// A cache-control directive configuration.
	MustUnderstand RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand `json:"must-understand"`
	// A cache-control directive configuration that accepts optional qualifiers (header
	// names).
	NoCache RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCache `json:"no-cache"`
	// A cache-control directive configuration.
	NoStore RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStore `json:"no-store"`
	// A cache-control directive configuration.
	NoTransform RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransform `json:"no-transform"`
	// A cache-control directive configuration that accepts optional qualifiers (header
	// names).
	Private RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivate `json:"private"`
	// A cache-control directive configuration.
	ProxyRevalidate RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate `json:"proxy-revalidate"`
	// A cache-control directive configuration.
	Public RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublic `json:"public"`
	// A cache-control directive configuration that accepts a duration value in
	// seconds.
	SMaxage RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxage `json:"s-maxage"`
	// A cache-control directive configuration that accepts a duration value in
	// seconds.
	StaleIfError RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfError `json:"stale-if-error"`
	// A cache-control directive configuration that accepts a duration value in
	// seconds.
	StaleWhileRevalidate RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate `json:"stale-while-revalidate"`
	JSON                 ruleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersJSON                 `json:"-"`
}

The parameters configuring the rule's action.

func (*RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParameters) UnmarshalJSON added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutable added in v7.9.0

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

A cache-control directive configuration.

func (*RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutable) UnmarshalJSON added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation string

The operation to perform on the cache-control directive.

const (
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableOperationSet    RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation = "set"
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableOperationRemove RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation = "remove"
)

func (RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation) IsKnown added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective added in v7.9.0

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

Remove the directive.

func (*RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective) UnmarshalJSON added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperationSet    RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation = "set"
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperationRemove RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation = "remove"
)

func (RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation) IsKnown added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective added in v7.9.0

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

Set the directive.

func (*RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective) UnmarshalJSON added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperationSet    RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation = "set"
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperationRemove RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation = "remove"
)

func (RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation) IsKnown added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableUnion added in v7.9.0

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

A cache-control directive configuration.

Union satisfied by RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective or RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective.

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAge added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAge struct {
	// The operation to perform on the cache-control directive.
	Operation RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation `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  ruleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeJSON `json:"-"`
	// contains filtered or unexported fields
}

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

func (*RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAge) UnmarshalJSON added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation string

The operation to perform on the cache-control directive.

const (
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperationSet    RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation = "set"
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperationRemove RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation = "remove"
)

func (RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation) IsKnown added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective added in v7.9.0

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

Remove the directive.

func (*RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective) UnmarshalJSON added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperationSet    RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation = "set"
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperationRemove RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation = "remove"
)

func (RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation) IsKnown added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation `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           ruleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveJSON `json:"-"`
}

Set the directive with a duration value in seconds.

func (*RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective) UnmarshalJSON added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperationSet    RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation = "set"
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperationRemove RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation = "remove"
)

func (RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation) IsKnown added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeUnion added in v7.9.0

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

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

Union satisfied by RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective or RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective.

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate added in v7.9.0

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

A cache-control directive configuration.

func (*RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate) UnmarshalJSON added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation string

The operation to perform on the cache-control directive.

const (
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperationSet    RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation = "set"
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperationRemove RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation = "remove"
)

func (RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation) IsKnown added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective added in v7.9.0

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

Remove the directive.

func (*RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective) UnmarshalJSON added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperationSet    RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation = "set"
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperationRemove RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation = "remove"
)

func (RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation) IsKnown added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective added in v7.9.0

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

Set the directive.

func (*RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective) UnmarshalJSON added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperationSet    RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation = "set"
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperationRemove RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation = "remove"
)

func (RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation) IsKnown added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateUnion added in v7.9.0

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

A cache-control directive configuration.

Union satisfied by RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective or RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective.

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand added in v7.9.0

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

A cache-control directive configuration.

func (*RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand) UnmarshalJSON added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation string

The operation to perform on the cache-control directive.

const (
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperationSet    RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation = "set"
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperationRemove RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation = "remove"
)

func (RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation) IsKnown added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective added in v7.9.0

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

Remove the directive.

func (*RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective) UnmarshalJSON added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperationSet    RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation = "set"
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperationRemove RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation = "remove"
)

func (RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation) IsKnown added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective added in v7.9.0

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

Set the directive.

func (*RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective) UnmarshalJSON added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperationSet    RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation = "set"
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperationRemove RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation = "remove"
)

func (RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation) IsKnown added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandUnion added in v7.9.0

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

A cache-control directive configuration.

Union satisfied by RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective or RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective.

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCache added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCache struct {
	// The operation to perform on the cache-control directive.
	Operation RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation `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       ruleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheJSON `json:"-"`
	// contains filtered or unexported fields
}

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

func (*RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCache) UnmarshalJSON added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation string

The operation to perform on the cache-control directive.

const (
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperationSet    RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation = "set"
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperationRemove RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation = "remove"
)

func (RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation) IsKnown added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective added in v7.9.0

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

Remove the directive.

func (*RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective) UnmarshalJSON added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperationSet    RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation = "set"
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperationRemove RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation = "remove"
)

func (RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation) IsKnown added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation `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       ruleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveJSON `json:"-"`
}

Set the directive with optional qualifiers.

func (*RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective) UnmarshalJSON added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperationSet    RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation = "set"
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperationRemove RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation = "remove"
)

func (RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation) IsKnown added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheUnion added in v7.9.0

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

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

Union satisfied by RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective or RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective.

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStore added in v7.9.0

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

A cache-control directive configuration.

func (*RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStore) UnmarshalJSON added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation string

The operation to perform on the cache-control directive.

const (
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperationSet    RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation = "set"
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperationRemove RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation = "remove"
)

func (RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation) IsKnown added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective added in v7.9.0

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

Remove the directive.

func (*RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective) UnmarshalJSON added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperationSet    RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation = "set"
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperationRemove RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation = "remove"
)

func (RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation) IsKnown added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective added in v7.9.0

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

Set the directive.

func (*RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective) UnmarshalJSON added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperationSet    RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation = "set"
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperationRemove RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation = "remove"
)

func (RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation) IsKnown added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreUnion added in v7.9.0

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

A cache-control directive configuration.

Union satisfied by RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective or RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective.

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransform added in v7.9.0

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

A cache-control directive configuration.

func (*RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransform) UnmarshalJSON added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation string

The operation to perform on the cache-control directive.

const (
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperationSet    RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation = "set"
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperationRemove RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation = "remove"
)

func (RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation) IsKnown added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective added in v7.9.0

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

Remove the directive.

func (*RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective) UnmarshalJSON added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperationSet    RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation = "set"
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperationRemove RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation = "remove"
)

func (RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation) IsKnown added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective added in v7.9.0

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

Set the directive.

func (*RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective) UnmarshalJSON added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperationSet    RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation = "set"
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperationRemove RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation = "remove"
)

func (RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation) IsKnown added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformUnion added in v7.9.0

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

A cache-control directive configuration.

Union satisfied by RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective or RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective.

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivate added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivate struct {
	// The operation to perform on the cache-control directive.
	Operation RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation `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       ruleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateJSON `json:"-"`
	// contains filtered or unexported fields
}

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

func (*RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivate) UnmarshalJSON added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation string

The operation to perform on the cache-control directive.

const (
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateOperationSet    RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation = "set"
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateOperationRemove RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation = "remove"
)

func (RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation) IsKnown added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective added in v7.9.0

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

Remove the directive.

func (*RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective) UnmarshalJSON added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperationSet    RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation = "set"
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperationRemove RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation = "remove"
)

func (RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation) IsKnown added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation `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       ruleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveJSON `json:"-"`
}

Set the directive with optional qualifiers.

func (*RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective) UnmarshalJSON added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperationSet    RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation = "set"
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperationRemove RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation = "remove"
)

func (RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation) IsKnown added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateUnion added in v7.9.0

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

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

Union satisfied by RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective or RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective.

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate added in v7.9.0

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

A cache-control directive configuration.

func (*RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate) UnmarshalJSON added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation string

The operation to perform on the cache-control directive.

const (
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperationSet    RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation = "set"
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperationRemove RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation = "remove"
)

func (RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation) IsKnown added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective added in v7.9.0

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

Remove the directive.

func (*RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective) UnmarshalJSON added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperationSet    RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation = "set"
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperationRemove RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation = "remove"
)

func (RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation) IsKnown added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective added in v7.9.0

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

Set the directive.

func (*RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective) UnmarshalJSON added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperationSet    RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation = "set"
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperationRemove RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation = "remove"
)

func (RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation) IsKnown added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateUnion added in v7.9.0

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

A cache-control directive configuration.

Union satisfied by RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective or RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective.

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublic added in v7.9.0

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

A cache-control directive configuration.

func (*RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublic) UnmarshalJSON added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicOperation added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicOperation string

The operation to perform on the cache-control directive.

const (
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicOperationSet    RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicOperation = "set"
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicOperationRemove RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicOperation = "remove"
)

func (RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicOperation) IsKnown added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective added in v7.9.0

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

Remove the directive.

func (*RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective) UnmarshalJSON added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperationSet    RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation = "set"
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperationRemove RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation = "remove"
)

func (RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation) IsKnown added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective added in v7.9.0

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

Set the directive.

func (*RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective) UnmarshalJSON added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperationSet    RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation = "set"
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperationRemove RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation = "remove"
)

func (RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation) IsKnown added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicUnion added in v7.9.0

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

A cache-control directive configuration.

Union satisfied by RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective or RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective.

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxage added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxage struct {
	// The operation to perform on the cache-control directive.
	Operation RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation `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  ruleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageJSON `json:"-"`
	// contains filtered or unexported fields
}

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

func (*RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxage) UnmarshalJSON added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation string

The operation to perform on the cache-control directive.

const (
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperationSet    RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation = "set"
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperationRemove RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation = "remove"
)

func (RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation) IsKnown added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective added in v7.9.0

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

Remove the directive.

func (*RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective) UnmarshalJSON added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperationSet    RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation = "set"
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperationRemove RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation = "remove"
)

func (RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation) IsKnown added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation `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           ruleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveJSON `json:"-"`
}

Set the directive with a duration value in seconds.

func (*RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective) UnmarshalJSON added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperationSet    RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation = "set"
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperationRemove RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation = "remove"
)

func (RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation) IsKnown added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageUnion added in v7.9.0

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

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

Union satisfied by RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective or RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective.

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfError added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfError struct {
	// The operation to perform on the cache-control directive.
	Operation RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation `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  ruleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorJSON `json:"-"`
	// contains filtered or unexported fields
}

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

func (*RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfError) UnmarshalJSON added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation string

The operation to perform on the cache-control directive.

const (
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperationSet    RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation = "set"
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperationRemove RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation = "remove"
)

func (RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation) IsKnown added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective added in v7.9.0

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

Remove the directive.

func (*RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective) UnmarshalJSON added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperationSet    RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation = "set"
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperationRemove RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation = "remove"
)

func (RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation) IsKnown added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation `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           ruleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveJSON `json:"-"`
}

Set the directive with a duration value in seconds.

func (*RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective) UnmarshalJSON added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperationSet    RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation = "set"
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperationRemove RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation = "remove"
)

func (RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation) IsKnown added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorUnion added in v7.9.0

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

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

Union satisfied by RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective or RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective.

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate struct {
	// The operation to perform on the cache-control directive.
	Operation RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation `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  ruleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateJSON `json:"-"`
	// contains filtered or unexported fields
}

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

func (*RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate) UnmarshalJSON added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation string

The operation to perform on the cache-control directive.

const (
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperationSet    RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation = "set"
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperationRemove RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation = "remove"
)

func (RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation) IsKnown added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective added in v7.9.0

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

Remove the directive.

func (*RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective) UnmarshalJSON added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperationSet    RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation = "set"
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperationRemove RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation = "remove"
)

func (RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation) IsKnown added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation `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           ruleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveJSON `json:"-"`
}

Set the directive with a duration value in seconds.

func (*RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective) UnmarshalJSON added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperationSet    RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation = "set"
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperationRemove RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation = "remove"
)

func (RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation) IsKnown added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateUnion added in v7.9.0

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

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

Union satisfied by RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective or RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective.

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleExposedCredentialCheck added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleExposedCredentialCheck 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               ruleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleExposedCredentialCheck) UnmarshalJSON added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleRatelimit added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleRatelimit 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                    ruleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*RuleNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleRatelimit) UnmarshalJSON added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRule added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRule 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 RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleAction `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParameters `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 RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleExposedCredentialCheck `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 RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                                                         `json:"ref"`
	JSON ruleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleJSON `json:"-"`
}

func (*RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRule) UnmarshalJSON added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleAction added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleAction string

The action to perform when the rule matches.

const (
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionSetCacheTags RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleAction = "set_cache_tags"
)

func (RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleAction) IsKnown added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParameters added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParameters struct {
	// The operation to perform on the cache tags.
	Operation RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersOperation `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   ruleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersJSON `json:"-"`
	// contains filtered or unexported fields
}

The parameters configuring the rule's action.

func (*RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParameters) UnmarshalJSON added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression 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 RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation `json:"operation" api:"required"`
	JSON      ruleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionJSON      `json:"-"`
}

Add cache tags using an expression.

func (*RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression) UnmarshalJSON added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation string

The operation to perform on the cache tags.

const (
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationAdd    RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "add"
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationRemove RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "remove"
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationSet    RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "set"
)

func (RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation) IsKnown added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues added in v7.9.0

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

Add cache tags using a list of values.

func (*RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues) UnmarshalJSON added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation string

The operation to perform on the cache tags.

const (
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationAdd    RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "add"
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationRemove RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "remove"
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationSet    RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "set"
)

func (RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation) IsKnown added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersOperation added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersOperation string

The operation to perform on the cache tags.

const (
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersOperationAdd    RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersOperation = "add"
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersOperationRemove RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersOperation = "remove"
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersOperationSet    RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersOperation = "set"
)

func (RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersOperation) IsKnown added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression 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 RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation `json:"operation" api:"required"`
	JSON      ruleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionJSON      `json:"-"`
}

Remove cache tags using an expression.

func (*RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression) UnmarshalJSON added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation string

The operation to perform on the cache tags.

const (
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationAdd    RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "add"
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationRemove RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "remove"
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationSet    RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "set"
)

func (RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation) IsKnown added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues added in v7.9.0

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

Remove cache tags using a list of values.

func (*RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues) UnmarshalJSON added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation string

The operation to perform on the cache tags.

const (
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationAdd    RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "add"
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationRemove RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "remove"
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationSet    RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "set"
)

func (RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation) IsKnown added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression 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 RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation `json:"operation" api:"required"`
	JSON      ruleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionJSON      `json:"-"`
}

Set cache tags using an expression.

func (*RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression) UnmarshalJSON added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation string

The operation to perform on the cache tags.

const (
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationAdd    RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "add"
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationRemove RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "remove"
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationSet    RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "set"
)

func (RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation) IsKnown added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues added in v7.9.0

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

Set cache tags using a list of values.

func (*RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues) UnmarshalJSON added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation string

The operation to perform on the cache tags.

const (
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationAdd    RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "add"
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationRemove RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "remove"
	RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationSet    RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "set"
)

func (RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation) IsKnown added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleExposedCredentialCheck added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleExposedCredentialCheck 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               ruleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleExposedCredentialCheck) UnmarshalJSON added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleRatelimit added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleRatelimit 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                    ruleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*RuleNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleRatelimit) UnmarshalJSON added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRule added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRule 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 RuleNewResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleAction `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters RuleNewResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleActionParameters `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 RuleNewResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleExposedCredentialCheck `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 RuleNewResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                                                                  `json:"ref"`
	JSON ruleNewResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleJSON `json:"-"`
}

func (*RuleNewResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRule) UnmarshalJSON added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleAction added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleAction string

The action to perform when the rule matches.

const (
	RuleNewResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleActionTransformResponseHTML RuleNewResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleAction = "transform_response_html"
)

func (RuleNewResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleAction) IsKnown added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleActionParameters added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleActionParameters struct {
	// Enables the link maze transformation on the response.
	LinkMaze interface{}                                                                             `json:"link_maze" api:"required"`
	JSON     ruleNewResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleActionParametersJSON `json:"-"`
}

The parameters configuring the rule's action.

func (*RuleNewResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleActionParameters) UnmarshalJSON added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleExposedCredentialCheck added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleExposedCredentialCheck 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               ruleNewResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*RuleNewResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleExposedCredentialCheck) UnmarshalJSON added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleRatelimit added in v7.9.0

type RuleNewResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleRatelimit 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                    ruleNewResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*RuleNewResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleRatelimit) UnmarshalJSON added in v7.9.0

type RuleNewResponseEnvelopeSuccess

type RuleNewResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	RuleNewResponseEnvelopeSuccessTrue RuleNewResponseEnvelopeSuccess = true
)

func (RuleNewResponseEnvelopeSuccess) IsKnown

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, params RuleDeleteParams, opts ...option.RequestOption) (res *RuleDeleteResponseEnvelopeResult, 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 *RuleEditResponseEnvelopeResult, 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 *RuleNewResponseEnvelopeResult, 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"`
	// Validates the request without persisting changes when set to `true`. Responses
	// that normally return 200 return `result: null`; endpoints that normally return
	// 204 continue to return 204.
	DryRun param.Field[bool] `query:"dry_run"`
}

func (RulesetDeleteParams) URLQuery added in v7.9.0

func (r RulesetDeleteParams) URLQuery() (v url.Values)

URLQuery serializes RulesetDeleteParams's query parameters as `url.Values`.

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

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],
	// [RulesetGetResponseRulesRulesetsTransformResponseHTMLRuleActionParameters].
	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],
	// [RulesetGetResponseRulesRulesetsTransformResponseHTMLRuleExposedCredentialCheck].
	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],
	// [RulesetGetResponseRulesRulesetsTransformResponseHTMLRuleRatelimit].
	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) 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"
	RulesetGetResponseRulesActionTransformResponseHTML RulesetGetResponseRulesAction = "transform_response_html"
)

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

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

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

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

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

type RulesetGetResponseRulesRulesetsSetCacheControlRule

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

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

type RulesetGetResponseRulesRulesetsSetCacheControlRuleAction

type RulesetGetResponseRulesRulesetsSetCacheControlRuleAction string

The action to perform when the rule matches.

const (
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionSetCacheControl RulesetGetResponseRulesRulesetsSetCacheControlRuleAction = "set_cache_control"
)

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleAction) IsKnown

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParameters

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

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutable

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) UnmarshalJSON

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation string

The operation to perform on the cache-control directive.

const (
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperationSet    RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation = "set"
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperationRemove RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation = "remove"
)

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation) IsKnown

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective

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

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperationSet    RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation = "set"
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperationRemove RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation = "remove"
)

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation) IsKnown

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective

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

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperationSet    RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation = "set"
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperationRemove RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation = "remove"
)

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation) IsKnown

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableUnion

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

A cache-control directive configuration.

Union satisfied by RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective or RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective.

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAge

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) UnmarshalJSON

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation string

The operation to perform on the cache-control directive.

const (
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperationSet    RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation = "set"
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperationRemove RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation = "remove"
)

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation) IsKnown

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective

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

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperationSet    RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation = "set"
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperationRemove RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation = "remove"
)

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation) IsKnown

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective

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

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperationSet    RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation = "set"
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperationRemove RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation = "remove"
)

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation) IsKnown

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeUnion

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

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) UnmarshalJSON

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation string

The operation to perform on the cache-control directive.

const (
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperationSet    RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation = "set"
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperationRemove RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation = "remove"
)

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation) IsKnown

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective

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

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperationSet    RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation = "set"
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperationRemove RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation = "remove"
)

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation) IsKnown

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective

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

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperationSet    RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation = "set"
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperationRemove RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation = "remove"
)

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation) IsKnown

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateUnion

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

A cache-control directive configuration.

Union satisfied by RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective or RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective.

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand

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) UnmarshalJSON

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation string

The operation to perform on the cache-control directive.

const (
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperationSet    RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation = "set"
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperationRemove RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation = "remove"
)

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation) IsKnown

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective

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

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperationSet    RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation = "set"
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperationRemove RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation = "remove"
)

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation) IsKnown

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective

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

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperationSet    RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation = "set"
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperationRemove RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation = "remove"
)

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation) IsKnown

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandUnion

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

A cache-control directive configuration.

Union satisfied by RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective or RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective.

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCache

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) UnmarshalJSON

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation string

The operation to perform on the cache-control directive.

const (
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperationSet    RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation = "set"
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperationRemove RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation = "remove"
)

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation) IsKnown

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective

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

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperationSet    RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation = "set"
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperationRemove RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation = "remove"
)

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation) IsKnown

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective

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

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperationSet    RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation = "set"
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperationRemove RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation = "remove"
)

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation) IsKnown

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheUnion

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

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) UnmarshalJSON

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation string

The operation to perform on the cache-control directive.

const (
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperationSet    RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation = "set"
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperationRemove RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation = "remove"
)

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation) IsKnown

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective

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

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperationSet    RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation = "set"
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperationRemove RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation = "remove"
)

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation) IsKnown

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective

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

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperationSet    RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation = "set"
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperationRemove RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation = "remove"
)

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation) IsKnown

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreUnion

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

A cache-control directive configuration.

Union satisfied by RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective or RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective.

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransform

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) UnmarshalJSON

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation string

The operation to perform on the cache-control directive.

const (
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperationSet    RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation = "set"
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperationRemove RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation = "remove"
)

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation) IsKnown

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective

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

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperationSet    RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation = "set"
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperationRemove RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation = "remove"
)

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation) IsKnown

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective

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

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperationSet    RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation = "set"
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperationRemove RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation = "remove"
)

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation) IsKnown

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformUnion

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

A cache-control directive configuration.

Union satisfied by RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective or RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective.

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivate

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) UnmarshalJSON

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation string

The operation to perform on the cache-control directive.

const (
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperationSet    RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation = "set"
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperationRemove RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation = "remove"
)

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation) IsKnown

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective

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

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperationSet    RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation = "set"
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperationRemove RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation = "remove"
)

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation) IsKnown

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective

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

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperationSet    RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation = "set"
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperationRemove RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation = "remove"
)

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation) IsKnown

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateUnion

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

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) UnmarshalJSON

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation string

The operation to perform on the cache-control directive.

const (
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperationSet    RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation = "set"
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperationRemove RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation = "remove"
)

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation) IsKnown

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective

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

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperationSet    RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation = "set"
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperationRemove RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation = "remove"
)

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation) IsKnown

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective

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

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperationSet    RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation = "set"
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperationRemove RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation = "remove"
)

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation) IsKnown

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateUnion

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

A cache-control directive configuration.

Union satisfied by RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective or RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective.

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublic

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) UnmarshalJSON

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation string

The operation to perform on the cache-control directive.

const (
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperationSet    RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation = "set"
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperationRemove RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation = "remove"
)

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation) IsKnown

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective

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

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperationSet    RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation = "set"
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperationRemove RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation = "remove"
)

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation) IsKnown

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective

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

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperationSet    RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation = "set"
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperationRemove RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation = "remove"
)

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation) IsKnown

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicUnion

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

A cache-control directive configuration.

Union satisfied by RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective or RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective.

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxage

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) UnmarshalJSON

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation string

The operation to perform on the cache-control directive.

const (
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperationSet    RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation = "set"
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperationRemove RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation = "remove"
)

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation) IsKnown

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective

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

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperationSet    RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation = "set"
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperationRemove RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation = "remove"
)

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation) IsKnown

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective

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

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperationSet    RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation = "set"
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperationRemove RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation = "remove"
)

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation) IsKnown

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageUnion

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

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) UnmarshalJSON

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation string

The operation to perform on the cache-control directive.

const (
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperationSet    RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation = "set"
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperationRemove RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation = "remove"
)

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation) IsKnown

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective

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

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperationSet    RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation = "set"
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperationRemove RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation = "remove"
)

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation) IsKnown

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective

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

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperationSet    RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation = "set"
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperationRemove RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation = "remove"
)

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation) IsKnown

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorUnion

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

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) UnmarshalJSON

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation string

The operation to perform on the cache-control directive.

const (
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperationSet    RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation = "set"
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperationRemove RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation = "remove"
)

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation) IsKnown

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective

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

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperationSet    RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation = "set"
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperationRemove RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation = "remove"
)

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation) IsKnown

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective

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

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperationSet    RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation = "set"
	RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperationRemove RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation = "remove"
)

func (RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation) IsKnown

type RulesetGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateUnion

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

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

type RulesetGetResponseRulesRulesetsSetCacheControlRuleRatelimit

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

type RulesetGetResponseRulesRulesetsSetCacheTagsRule

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

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

type RulesetGetResponseRulesRulesetsSetCacheTagsRuleAction

type RulesetGetResponseRulesRulesetsSetCacheTagsRuleAction string

The action to perform when the rule matches.

const (
	RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionSetCacheTags RulesetGetResponseRulesRulesetsSetCacheTagsRuleAction = "set_cache_tags"
)

func (RulesetGetResponseRulesRulesetsSetCacheTagsRuleAction) IsKnown

type RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParameters

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) UnmarshalJSON

type RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression

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

type RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation

type RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation string

The operation to perform on the cache tags.

const (
	RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationAdd    RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "add"
	RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationRemove RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "remove"
	RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationSet    RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "set"
)

func (RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation) IsKnown

type RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues

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

type RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation

type RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation string

The operation to perform on the cache tags.

const (
	RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationAdd    RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "add"
	RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationRemove RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "remove"
	RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationSet    RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "set"
)

func (RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation) IsKnown

type RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation

type RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation string

The operation to perform on the cache tags.

const (
	RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersOperationAdd    RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation = "add"
	RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersOperationRemove RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation = "remove"
	RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersOperationSet    RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation = "set"
)

func (RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation) IsKnown

type RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression

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

type RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation

type RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation string

The operation to perform on the cache tags.

const (
	RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationAdd    RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "add"
	RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationRemove RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "remove"
	RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationSet    RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "set"
)

func (RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation) IsKnown

type RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues

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

type RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation

type RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation string

The operation to perform on the cache tags.

const (
	RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationAdd    RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "add"
	RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationRemove RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "remove"
	RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationSet    RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "set"
)

func (RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation) IsKnown

type RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression

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

type RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation

type RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation string

The operation to perform on the cache tags.

const (
	RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationAdd    RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "add"
	RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationRemove RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "remove"
	RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationSet    RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "set"
)

func (RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation) IsKnown

type RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues

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

type RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation

type RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation string

The operation to perform on the cache tags.

const (
	RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationAdd    RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "add"
	RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationRemove RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "remove"
	RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationSet    RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "set"
)

func (RulesetGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation) IsKnown

type RulesetGetResponseRulesRulesetsSetCacheTagsRuleExposedCredentialCheck

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

type RulesetGetResponseRulesRulesetsSetCacheTagsRuleRatelimit

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

type RulesetGetResponseRulesRulesetsTransformResponseHTMLRule added in v7.7.0

type RulesetGetResponseRulesRulesetsTransformResponseHTMLRule 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 RulesetGetResponseRulesRulesetsTransformResponseHTMLRuleAction `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters RulesetGetResponseRulesRulesetsTransformResponseHTMLRuleActionParameters `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 RulesetGetResponseRulesRulesetsTransformResponseHTMLRuleExposedCredentialCheck `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 RulesetGetResponseRulesRulesetsTransformResponseHTMLRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                                                       `json:"ref"`
	JSON rulesetGetResponseRulesRulesetsTransformResponseHTMLRuleJSON `json:"-"`
}

func (*RulesetGetResponseRulesRulesetsTransformResponseHTMLRule) UnmarshalJSON added in v7.7.0

type RulesetGetResponseRulesRulesetsTransformResponseHTMLRuleAction added in v7.7.0

type RulesetGetResponseRulesRulesetsTransformResponseHTMLRuleAction string

The action to perform when the rule matches.

const (
	RulesetGetResponseRulesRulesetsTransformResponseHTMLRuleActionTransformResponseHTML RulesetGetResponseRulesRulesetsTransformResponseHTMLRuleAction = "transform_response_html"
)

func (RulesetGetResponseRulesRulesetsTransformResponseHTMLRuleAction) IsKnown added in v7.7.0

type RulesetGetResponseRulesRulesetsTransformResponseHTMLRuleActionParameters added in v7.7.0

type RulesetGetResponseRulesRulesetsTransformResponseHTMLRuleActionParameters struct {
	// Enables the link maze transformation on the response.
	LinkMaze interface{}                                                                  `json:"link_maze" api:"required"`
	JSON     rulesetGetResponseRulesRulesetsTransformResponseHTMLRuleActionParametersJSON `json:"-"`
}

The parameters configuring the rule's action.

func (*RulesetGetResponseRulesRulesetsTransformResponseHTMLRuleActionParameters) UnmarshalJSON added in v7.7.0

type RulesetGetResponseRulesRulesetsTransformResponseHTMLRuleExposedCredentialCheck added in v7.7.0

type RulesetGetResponseRulesRulesetsTransformResponseHTMLRuleExposedCredentialCheck 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               rulesetGetResponseRulesRulesetsTransformResponseHTMLRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*RulesetGetResponseRulesRulesetsTransformResponseHTMLRuleExposedCredentialCheck) UnmarshalJSON added in v7.7.0

type RulesetGetResponseRulesRulesetsTransformResponseHTMLRuleRatelimit added in v7.7.0

type RulesetGetResponseRulesRulesetsTransformResponseHTMLRuleRatelimit 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                    rulesetGetResponseRulesRulesetsTransformResponseHTMLRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*RulesetGetResponseRulesRulesetsTransformResponseHTMLRuleRatelimit) UnmarshalJSON added in v7.7.0

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"`
	// Validates the request without persisting changes when set to `true`. Responses
	// that normally return 200 return `result: null`; endpoints that normally return
	// 204 continue to return 204.
	DryRun param.Field[bool] `query:"dry_run"`
	// 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)

func (RulesetNewParams) URLQuery added in v7.9.0

func (r RulesetNewParams) URLQuery() (v url.Values)

URLQuery serializes RulesetNewParams's query parameters as `url.Values`.

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 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"
	RulesetNewParamsRulesActionTransformResponseHTML RulesetNewParamsRulesAction = "transform_response_html"
)

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

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

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

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

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

type RulesetNewParamsRulesRulesetsSetCacheControlRule

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

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

type RulesetNewParamsRulesRulesetsSetCacheControlRuleAction

type RulesetNewParamsRulesRulesetsSetCacheControlRuleAction string

The action to perform when the rule matches.

const (
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionSetCacheControl RulesetNewParamsRulesRulesetsSetCacheControlRuleAction = "set_cache_control"
)

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleAction) IsKnown

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParameters

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

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersImmutable

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

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation string

The operation to perform on the cache-control directive.

const (
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableOperationSet    RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation = "set"
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation = "remove"
)

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation) IsKnown

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective

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

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperationSet    RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation = "set"
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation = "remove"
)

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation) IsKnown

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective

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

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperationSet    RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation = "set"
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation = "remove"
)

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation) IsKnown

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAge

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

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation string

The operation to perform on the cache-control directive.

const (
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperationSet    RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation = "set"
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation = "remove"
)

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation) IsKnown

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective

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

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperationSet    RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation = "set"
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation = "remove"
)

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation) IsKnown

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective

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

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperationSet    RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation = "set"
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation = "remove"
)

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation) IsKnown

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeUnion

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

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

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation string

The operation to perform on the cache-control directive.

const (
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperationSet    RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation = "set"
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation = "remove"
)

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation) IsKnown

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective

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

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperationSet    RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation = "set"
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation = "remove"
)

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation) IsKnown

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective

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

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperationSet    RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation = "set"
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation = "remove"
)

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation) IsKnown

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand

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

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation string

The operation to perform on the cache-control directive.

const (
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperationSet    RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation = "set"
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation = "remove"
)

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation) IsKnown

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective

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

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperationSet    RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation = "set"
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation = "remove"
)

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation) IsKnown

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective

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

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperationSet    RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation = "set"
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation = "remove"
)

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation) IsKnown

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoCache

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

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation string

The operation to perform on the cache-control directive.

const (
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperationSet    RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation = "set"
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation = "remove"
)

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation) IsKnown

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective

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

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperationSet    RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation = "set"
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation = "remove"
)

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation) IsKnown

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective

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

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperationSet    RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation = "set"
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation = "remove"
)

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation) IsKnown

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheUnion

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

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

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation string

The operation to perform on the cache-control directive.

const (
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperationSet    RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation = "set"
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation = "remove"
)

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation) IsKnown

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective

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

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperationSet    RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation = "set"
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation = "remove"
)

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation) IsKnown

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective

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

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperationSet    RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation = "set"
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation = "remove"
)

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation) IsKnown

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransform

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

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation string

The operation to perform on the cache-control directive.

const (
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperationSet    RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation = "set"
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation = "remove"
)

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation) IsKnown

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective

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

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperationSet    RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation = "set"
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation = "remove"
)

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation) IsKnown

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective

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

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperationSet    RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation = "set"
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation = "remove"
)

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation) IsKnown

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPrivate

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

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation string

The operation to perform on the cache-control directive.

const (
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateOperationSet    RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation = "set"
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation = "remove"
)

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation) IsKnown

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective

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

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperationSet    RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation = "set"
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation = "remove"
)

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation) IsKnown

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective

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

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperationSet    RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation = "set"
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation = "remove"
)

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation) IsKnown

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateUnion

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

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

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation string

The operation to perform on the cache-control directive.

const (
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperationSet    RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation = "set"
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation = "remove"
)

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation) IsKnown

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective

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

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperationSet    RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation = "set"
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation = "remove"
)

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation) IsKnown

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective

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

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperationSet    RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation = "set"
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation = "remove"
)

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation) IsKnown

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPublic

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

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPublicOperation

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPublicOperation string

The operation to perform on the cache-control directive.

const (
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPublicOperationSet    RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPublicOperation = "set"
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPublicOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPublicOperation = "remove"
)

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPublicOperation) IsKnown

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective

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

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperationSet    RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation = "set"
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation = "remove"
)

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation) IsKnown

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective

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

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperationSet    RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation = "set"
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation = "remove"
)

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation) IsKnown

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxage

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

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation string

The operation to perform on the cache-control directive.

const (
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperationSet    RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation = "set"
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation = "remove"
)

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation) IsKnown

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective

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

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperationSet    RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation = "set"
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation = "remove"
)

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation) IsKnown

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective

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

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperationSet    RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation = "set"
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation = "remove"
)

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation) IsKnown

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageUnion

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

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

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation string

The operation to perform on the cache-control directive.

const (
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperationSet    RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation = "set"
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation = "remove"
)

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation) IsKnown

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective

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

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperationSet    RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation = "set"
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation = "remove"
)

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation) IsKnown

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective

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

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperationSet    RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation = "set"
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation = "remove"
)

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation) IsKnown

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorUnion

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

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

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation string

The operation to perform on the cache-control directive.

const (
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperationSet    RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation = "set"
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation = "remove"
)

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation) IsKnown

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective

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

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperationSet    RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation = "set"
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation = "remove"
)

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation) IsKnown

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective

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

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperationSet    RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation = "set"
	RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperationRemove RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation = "remove"
)

func (RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation) IsKnown

type RulesetNewParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateUnion

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

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

type RulesetNewParamsRulesRulesetsSetCacheControlRuleRatelimit

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

type RulesetNewParamsRulesRulesetsSetCacheTagsRule

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

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

type RulesetNewParamsRulesRulesetsSetCacheTagsRuleAction

type RulesetNewParamsRulesRulesetsSetCacheTagsRuleAction string

The action to perform when the rule matches.

const (
	RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionSetCacheTags RulesetNewParamsRulesRulesetsSetCacheTagsRuleAction = "set_cache_tags"
)

func (RulesetNewParamsRulesRulesetsSetCacheTagsRuleAction) IsKnown

type RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParameters

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

type RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression

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

type RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation

type RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation string

The operation to perform on the cache tags.

const (
	RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationAdd    RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "add"
	RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationRemove RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "remove"
	RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationSet    RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "set"
)

func (RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation) IsKnown

type RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues

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

type RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation

type RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation string

The operation to perform on the cache tags.

const (
	RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationAdd    RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "add"
	RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationRemove RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "remove"
	RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationSet    RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "set"
)

func (RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation) IsKnown

type RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersOperation

type RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersOperation string

The operation to perform on the cache tags.

const (
	RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersOperationAdd    RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersOperation = "add"
	RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersOperationRemove RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersOperation = "remove"
	RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersOperationSet    RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersOperation = "set"
)

func (RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersOperation) IsKnown

type RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression

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

type RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation

type RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation string

The operation to perform on the cache tags.

const (
	RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationAdd    RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "add"
	RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationRemove RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "remove"
	RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationSet    RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "set"
)

func (RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation) IsKnown

type RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues

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

type RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation

type RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation string

The operation to perform on the cache tags.

const (
	RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationAdd    RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "add"
	RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationRemove RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "remove"
	RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationSet    RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "set"
)

func (RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation) IsKnown

type RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression

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

type RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation

type RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation string

The operation to perform on the cache tags.

const (
	RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationAdd    RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "add"
	RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationRemove RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "remove"
	RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationSet    RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "set"
)

func (RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation) IsKnown

type RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues

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

type RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation

type RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation string

The operation to perform on the cache tags.

const (
	RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationAdd    RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "add"
	RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationRemove RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "remove"
	RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationSet    RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "set"
)

func (RulesetNewParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation) IsKnown

type RulesetNewParamsRulesRulesetsSetCacheTagsRuleExposedCredentialCheck

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

type RulesetNewParamsRulesRulesetsSetCacheTagsRuleRatelimit

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

type RulesetNewParamsRulesRulesetsTransformResponseHTMLRule added in v7.7.0

type RulesetNewParamsRulesRulesetsTransformResponseHTMLRule struct {
	// The unique ID of the rule.
	ID param.Field[string] `json:"id"`
	// The action to perform when the rule matches.
	Action param.Field[RulesetNewParamsRulesRulesetsTransformResponseHTMLRuleAction] `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters param.Field[RulesetNewParamsRulesRulesetsTransformResponseHTMLRuleActionParameters] `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[RulesetNewParamsRulesRulesetsTransformResponseHTMLRuleExposedCredentialCheck] `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[RulesetNewParamsRulesRulesetsTransformResponseHTMLRuleRatelimit] `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref param.Field[string] `json:"ref"`
}

func (RulesetNewParamsRulesRulesetsTransformResponseHTMLRule) MarshalJSON added in v7.7.0

type RulesetNewParamsRulesRulesetsTransformResponseHTMLRuleAction added in v7.7.0

type RulesetNewParamsRulesRulesetsTransformResponseHTMLRuleAction string

The action to perform when the rule matches.

const (
	RulesetNewParamsRulesRulesetsTransformResponseHTMLRuleActionTransformResponseHTML RulesetNewParamsRulesRulesetsTransformResponseHTMLRuleAction = "transform_response_html"
)

func (RulesetNewParamsRulesRulesetsTransformResponseHTMLRuleAction) IsKnown added in v7.7.0

type RulesetNewParamsRulesRulesetsTransformResponseHTMLRuleActionParameters added in v7.7.0

type RulesetNewParamsRulesRulesetsTransformResponseHTMLRuleActionParameters struct {
	// Enables the link maze transformation on the response.
	LinkMaze param.Field[interface{}] `json:"link_maze" api:"required"`
}

The parameters configuring the rule's action.

func (RulesetNewParamsRulesRulesetsTransformResponseHTMLRuleActionParameters) MarshalJSON added in v7.7.0

type RulesetNewParamsRulesRulesetsTransformResponseHTMLRuleExposedCredentialCheck added in v7.7.0

type RulesetNewParamsRulesRulesetsTransformResponseHTMLRuleExposedCredentialCheck 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 (RulesetNewParamsRulesRulesetsTransformResponseHTMLRuleExposedCredentialCheck) MarshalJSON added in v7.7.0

type RulesetNewParamsRulesRulesetsTransformResponseHTMLRuleRatelimit added in v7.7.0

type RulesetNewParamsRulesRulesetsTransformResponseHTMLRuleRatelimit 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 (RulesetNewParamsRulesRulesetsTransformResponseHTMLRuleRatelimit) MarshalJSON added in v7.7.0

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 result.
	Result RulesetNewResponseEnvelopeResult `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 RulesetNewResponseEnvelopeResult added in v7.9.0

type RulesetNewResponseEnvelopeResult 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 []RulesetNewResponseEnvelopeResultRules `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        rulesetNewResponseEnvelopeResultJSON `json:"-"`
}

A ruleset object.

func (*RulesetNewResponseEnvelopeResult) UnmarshalJSON added in v7.9.0

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

type RulesetNewResponseEnvelopeResultRules added in v7.9.0

type RulesetNewResponseEnvelopeResultRules 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 RulesetNewResponseEnvelopeResultRulesAction `json:"action"`
	// This field can have the runtime type of [BlockRuleActionParameters],
	// [interface{}], [CompressResponseRuleActionParameters],
	// [ExecuteRuleActionParameters], [LogCustomFieldRuleActionParameters],
	// [RedirectRuleActionParameters], [RewriteRuleActionParameters],
	// [RouteRuleActionParameters], [ScoreRuleActionParameters],
	// [ServeErrorRuleActionParameters],
	// [RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParameters],
	// [SetCacheSettingsRuleActionParameters],
	// [RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParameters],
	// [SetConfigRuleActionParameters], [SkipRuleActionParameters],
	// [RulesetNewResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleActionParameters].
	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],
	// [RulesetNewResponseEnvelopeResultRulesRulesetsChallengeRuleExposedCredentialCheck],
	// [CompressResponseRuleExposedCredentialCheck],
	// [DDoSDynamicRuleExposedCredentialCheck], [ExecuteRuleExposedCredentialCheck],
	// [ForceConnectionCloseRuleExposedCredentialCheck],
	// [RulesetNewResponseEnvelopeResultRulesRulesetsJSChallengeRuleExposedCredentialCheck],
	// [LogRuleExposedCredentialCheck], [LogCustomFieldRuleExposedCredentialCheck],
	// [ManagedChallengeRuleExposedCredentialCheck],
	// [RedirectRuleExposedCredentialCheck], [RewriteRuleExposedCredentialCheck],
	// [RouteRuleExposedCredentialCheck], [ScoreRuleExposedCredentialCheck],
	// [ServeErrorRuleExposedCredentialCheck],
	// [RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleExposedCredentialCheck],
	// [SetCacheSettingsRuleExposedCredentialCheck],
	// [RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleExposedCredentialCheck],
	// [SetConfigRuleExposedCredentialCheck], [SkipRuleExposedCredentialCheck],
	// [RulesetNewResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleExposedCredentialCheck].
	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],
	// [RulesetNewResponseEnvelopeResultRulesRulesetsChallengeRuleRatelimit],
	// [CompressResponseRuleRatelimit], [DDoSDynamicRuleRatelimit],
	// [ExecuteRuleRatelimit], [ForceConnectionCloseRuleRatelimit],
	// [RulesetNewResponseEnvelopeResultRulesRulesetsJSChallengeRuleRatelimit],
	// [LogRuleRatelimit], [LogCustomFieldRuleRatelimit],
	// [ManagedChallengeRuleRatelimit], [RedirectRuleRatelimit],
	// [RewriteRuleRatelimit], [RouteRuleRatelimit], [ScoreRuleRatelimit],
	// [ServeErrorRuleRatelimit],
	// [RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleRatelimit],
	// [SetCacheSettingsRuleRatelimit],
	// [RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleRatelimit],
	// [SetConfigRuleRatelimit], [SkipRuleRatelimit],
	// [RulesetNewResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleRatelimit].
	Ratelimit interface{} `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                                    `json:"ref"`
	JSON rulesetNewResponseEnvelopeResultRulesJSON `json:"-"`
	// contains filtered or unexported fields
}

func (*RulesetNewResponseEnvelopeResultRules) UnmarshalJSON added in v7.9.0

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

type RulesetNewResponseEnvelopeResultRulesAction added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesAction string

The action to perform when the rule matches.

const (
	RulesetNewResponseEnvelopeResultRulesActionBlock                 RulesetNewResponseEnvelopeResultRulesAction = "block"
	RulesetNewResponseEnvelopeResultRulesActionChallenge             RulesetNewResponseEnvelopeResultRulesAction = "challenge"
	RulesetNewResponseEnvelopeResultRulesActionCompressResponse      RulesetNewResponseEnvelopeResultRulesAction = "compress_response"
	RulesetNewResponseEnvelopeResultRulesActionDDoSDynamic           RulesetNewResponseEnvelopeResultRulesAction = "ddos_dynamic"
	RulesetNewResponseEnvelopeResultRulesActionExecute               RulesetNewResponseEnvelopeResultRulesAction = "execute"
	RulesetNewResponseEnvelopeResultRulesActionForceConnectionClose  RulesetNewResponseEnvelopeResultRulesAction = "force_connection_close"
	RulesetNewResponseEnvelopeResultRulesActionJSChallenge           RulesetNewResponseEnvelopeResultRulesAction = "js_challenge"
	RulesetNewResponseEnvelopeResultRulesActionLog                   RulesetNewResponseEnvelopeResultRulesAction = "log"
	RulesetNewResponseEnvelopeResultRulesActionLogCustomField        RulesetNewResponseEnvelopeResultRulesAction = "log_custom_field"
	RulesetNewResponseEnvelopeResultRulesActionManagedChallenge      RulesetNewResponseEnvelopeResultRulesAction = "managed_challenge"
	RulesetNewResponseEnvelopeResultRulesActionRedirect              RulesetNewResponseEnvelopeResultRulesAction = "redirect"
	RulesetNewResponseEnvelopeResultRulesActionRewrite               RulesetNewResponseEnvelopeResultRulesAction = "rewrite"
	RulesetNewResponseEnvelopeResultRulesActionRoute                 RulesetNewResponseEnvelopeResultRulesAction = "route"
	RulesetNewResponseEnvelopeResultRulesActionScore                 RulesetNewResponseEnvelopeResultRulesAction = "score"
	RulesetNewResponseEnvelopeResultRulesActionServeError            RulesetNewResponseEnvelopeResultRulesAction = "serve_error"
	RulesetNewResponseEnvelopeResultRulesActionSetCacheControl       RulesetNewResponseEnvelopeResultRulesAction = "set_cache_control"
	RulesetNewResponseEnvelopeResultRulesActionSetCacheSettings      RulesetNewResponseEnvelopeResultRulesAction = "set_cache_settings"
	RulesetNewResponseEnvelopeResultRulesActionSetCacheTags          RulesetNewResponseEnvelopeResultRulesAction = "set_cache_tags"
	RulesetNewResponseEnvelopeResultRulesActionSetConfig             RulesetNewResponseEnvelopeResultRulesAction = "set_config"
	RulesetNewResponseEnvelopeResultRulesActionSkip                  RulesetNewResponseEnvelopeResultRulesAction = "skip"
	RulesetNewResponseEnvelopeResultRulesActionTransformResponseHTML RulesetNewResponseEnvelopeResultRulesAction = "transform_response_html"
)

func (RulesetNewResponseEnvelopeResultRulesAction) IsKnown added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsChallengeRule added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsChallengeRule 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 RulesetNewResponseEnvelopeResultRulesRulesetsChallengeRuleAction `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 RulesetNewResponseEnvelopeResultRulesRulesetsChallengeRuleExposedCredentialCheck `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 RulesetNewResponseEnvelopeResultRulesRulesetsChallengeRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                                                         `json:"ref"`
	JSON rulesetNewResponseEnvelopeResultRulesRulesetsChallengeRuleJSON `json:"-"`
}

func (*RulesetNewResponseEnvelopeResultRulesRulesetsChallengeRule) UnmarshalJSON added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsChallengeRuleAction added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsChallengeRuleAction string

The action to perform when the rule matches.

const (
	RulesetNewResponseEnvelopeResultRulesRulesetsChallengeRuleActionChallenge RulesetNewResponseEnvelopeResultRulesRulesetsChallengeRuleAction = "challenge"
)

func (RulesetNewResponseEnvelopeResultRulesRulesetsChallengeRuleAction) IsKnown added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsChallengeRuleExposedCredentialCheck added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsChallengeRuleExposedCredentialCheck 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               rulesetNewResponseEnvelopeResultRulesRulesetsChallengeRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*RulesetNewResponseEnvelopeResultRulesRulesetsChallengeRuleExposedCredentialCheck) UnmarshalJSON added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsChallengeRuleRatelimit added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsChallengeRuleRatelimit 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                    rulesetNewResponseEnvelopeResultRulesRulesetsChallengeRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*RulesetNewResponseEnvelopeResultRulesRulesetsChallengeRuleRatelimit) UnmarshalJSON added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsJSChallengeRule added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsJSChallengeRule 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 RulesetNewResponseEnvelopeResultRulesRulesetsJSChallengeRuleAction `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 RulesetNewResponseEnvelopeResultRulesRulesetsJSChallengeRuleExposedCredentialCheck `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 RulesetNewResponseEnvelopeResultRulesRulesetsJSChallengeRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                                                           `json:"ref"`
	JSON rulesetNewResponseEnvelopeResultRulesRulesetsJSChallengeRuleJSON `json:"-"`
}

func (*RulesetNewResponseEnvelopeResultRulesRulesetsJSChallengeRule) UnmarshalJSON added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsJSChallengeRuleAction added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsJSChallengeRuleAction string

The action to perform when the rule matches.

const (
	RulesetNewResponseEnvelopeResultRulesRulesetsJSChallengeRuleActionJSChallenge RulesetNewResponseEnvelopeResultRulesRulesetsJSChallengeRuleAction = "js_challenge"
)

func (RulesetNewResponseEnvelopeResultRulesRulesetsJSChallengeRuleAction) IsKnown added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsJSChallengeRuleExposedCredentialCheck added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsJSChallengeRuleExposedCredentialCheck 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               rulesetNewResponseEnvelopeResultRulesRulesetsJSChallengeRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*RulesetNewResponseEnvelopeResultRulesRulesetsJSChallengeRuleExposedCredentialCheck) UnmarshalJSON added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsJSChallengeRuleRatelimit added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsJSChallengeRuleRatelimit 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                    rulesetNewResponseEnvelopeResultRulesRulesetsJSChallengeRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*RulesetNewResponseEnvelopeResultRulesRulesetsJSChallengeRuleRatelimit) UnmarshalJSON added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRule added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRule 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 RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleAction `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParameters `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 RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleExposedCredentialCheck `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 RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                                                               `json:"ref"`
	JSON rulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleJSON `json:"-"`
}

func (*RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRule) UnmarshalJSON added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleAction added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleAction string

The action to perform when the rule matches.

const (
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionSetCacheControl RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleAction = "set_cache_control"
)

func (RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleAction) IsKnown added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParameters added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParameters struct {
	// A cache-control directive configuration.
	Immutable RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutable `json:"immutable"`
	// A cache-control directive configuration that accepts a duration value in
	// seconds.
	MaxAge RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAge `json:"max-age"`
	// A cache-control directive configuration.
	MustRevalidate RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate `json:"must-revalidate"`
	// A cache-control directive configuration.
	MustUnderstand RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand `json:"must-understand"`
	// A cache-control directive configuration that accepts optional qualifiers (header
	// names).
	NoCache RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCache `json:"no-cache"`
	// A cache-control directive configuration.
	NoStore RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStore `json:"no-store"`
	// A cache-control directive configuration.
	NoTransform RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransform `json:"no-transform"`
	// A cache-control directive configuration that accepts optional qualifiers (header
	// names).
	Private RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivate `json:"private"`
	// A cache-control directive configuration.
	ProxyRevalidate RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate `json:"proxy-revalidate"`
	// A cache-control directive configuration.
	Public RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublic `json:"public"`
	// A cache-control directive configuration that accepts a duration value in
	// seconds.
	SMaxage RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxage `json:"s-maxage"`
	// A cache-control directive configuration that accepts a duration value in
	// seconds.
	StaleIfError RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfError `json:"stale-if-error"`
	// A cache-control directive configuration that accepts a duration value in
	// seconds.
	StaleWhileRevalidate RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate `json:"stale-while-revalidate"`
	JSON                 rulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersJSON                 `json:"-"`
}

The parameters configuring the rule's action.

func (*RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParameters) UnmarshalJSON added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutable added in v7.9.0

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

A cache-control directive configuration.

func (*RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutable) UnmarshalJSON added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation string

The operation to perform on the cache-control directive.

const (
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableOperationSet    RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation = "set"
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableOperationRemove RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation = "remove"
)

func (RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation) IsKnown added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective added in v7.9.0

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

Remove the directive.

func (*RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective) UnmarshalJSON added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperationSet    RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation = "set"
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperationRemove RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation = "remove"
)

func (RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation) IsKnown added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective added in v7.9.0

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

Set the directive.

func (*RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective) UnmarshalJSON added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperationSet    RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation = "set"
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperationRemove RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation = "remove"
)

func (RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation) IsKnown added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableUnion added in v7.9.0

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

A cache-control directive configuration.

Union satisfied by RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective or RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective.

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAge added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAge struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation `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  rulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeJSON `json:"-"`
	// contains filtered or unexported fields
}

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

func (*RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAge) UnmarshalJSON added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation string

The operation to perform on the cache-control directive.

const (
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperationSet    RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation = "set"
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperationRemove RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation = "remove"
)

func (RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation) IsKnown added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective added in v7.9.0

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

Remove the directive.

func (*RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective) UnmarshalJSON added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperationSet    RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation = "set"
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperationRemove RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation = "remove"
)

func (RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation) IsKnown added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation `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           rulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveJSON `json:"-"`
}

Set the directive with a duration value in seconds.

func (*RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective) UnmarshalJSON added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperationSet    RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation = "set"
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperationRemove RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation = "remove"
)

func (RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation) IsKnown added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeUnion added in v7.9.0

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

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

Union satisfied by RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective or RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective.

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate added in v7.9.0

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

A cache-control directive configuration.

func (*RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate) UnmarshalJSON added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation string

The operation to perform on the cache-control directive.

const (
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperationSet    RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation = "set"
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperationRemove RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation = "remove"
)

func (RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation) IsKnown added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective added in v7.9.0

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

Remove the directive.

func (*RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective) UnmarshalJSON added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperationSet    RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation = "set"
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperationRemove RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation = "remove"
)

func (RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation) IsKnown added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective added in v7.9.0

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

Set the directive.

func (*RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective) UnmarshalJSON added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperationSet    RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation = "set"
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperationRemove RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation = "remove"
)

func (RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation) IsKnown added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateUnion added in v7.9.0

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

A cache-control directive configuration.

Union satisfied by RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective or RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective.

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand added in v7.9.0

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

A cache-control directive configuration.

func (*RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand) UnmarshalJSON added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation string

The operation to perform on the cache-control directive.

const (
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperationSet    RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation = "set"
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperationRemove RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation = "remove"
)

func (RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation) IsKnown added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective added in v7.9.0

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

Remove the directive.

func (*RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective) UnmarshalJSON added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperationSet    RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation = "set"
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperationRemove RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation = "remove"
)

func (RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation) IsKnown added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective added in v7.9.0

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

Set the directive.

func (*RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective) UnmarshalJSON added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperationSet    RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation = "set"
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperationRemove RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation = "remove"
)

func (RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation) IsKnown added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandUnion added in v7.9.0

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

A cache-control directive configuration.

Union satisfied by RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective or RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective.

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCache added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCache struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation `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       rulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheJSON `json:"-"`
	// contains filtered or unexported fields
}

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

func (*RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCache) UnmarshalJSON added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation string

The operation to perform on the cache-control directive.

const (
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperationSet    RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation = "set"
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperationRemove RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation = "remove"
)

func (RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation) IsKnown added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective added in v7.9.0

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

Remove the directive.

func (*RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective) UnmarshalJSON added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperationSet    RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation = "set"
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperationRemove RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation = "remove"
)

func (RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation) IsKnown added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation `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       rulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveJSON `json:"-"`
}

Set the directive with optional qualifiers.

func (*RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective) UnmarshalJSON added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperationSet    RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation = "set"
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperationRemove RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation = "remove"
)

func (RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation) IsKnown added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheUnion added in v7.9.0

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

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

Union satisfied by RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective or RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective.

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStore added in v7.9.0

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

A cache-control directive configuration.

func (*RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStore) UnmarshalJSON added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation string

The operation to perform on the cache-control directive.

const (
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperationSet    RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation = "set"
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperationRemove RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation = "remove"
)

func (RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation) IsKnown added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective added in v7.9.0

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

Remove the directive.

func (*RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective) UnmarshalJSON added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperationSet    RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation = "set"
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperationRemove RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation = "remove"
)

func (RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation) IsKnown added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective added in v7.9.0

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

Set the directive.

func (*RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective) UnmarshalJSON added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperationSet    RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation = "set"
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperationRemove RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation = "remove"
)

func (RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation) IsKnown added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreUnion added in v7.9.0

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

A cache-control directive configuration.

Union satisfied by RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective or RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective.

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransform added in v7.9.0

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

A cache-control directive configuration.

func (*RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransform) UnmarshalJSON added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation string

The operation to perform on the cache-control directive.

const (
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperationSet    RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation = "set"
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperationRemove RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation = "remove"
)

func (RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation) IsKnown added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective added in v7.9.0

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

Remove the directive.

func (*RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective) UnmarshalJSON added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperationSet    RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation = "set"
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperationRemove RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation = "remove"
)

func (RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation) IsKnown added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective added in v7.9.0

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

Set the directive.

func (*RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective) UnmarshalJSON added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperationSet    RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation = "set"
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperationRemove RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation = "remove"
)

func (RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation) IsKnown added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformUnion added in v7.9.0

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

A cache-control directive configuration.

Union satisfied by RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective or RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective.

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivate added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivate struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation `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       rulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateJSON `json:"-"`
	// contains filtered or unexported fields
}

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

func (*RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivate) UnmarshalJSON added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation string

The operation to perform on the cache-control directive.

const (
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateOperationSet    RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation = "set"
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateOperationRemove RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation = "remove"
)

func (RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation) IsKnown added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective added in v7.9.0

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

Remove the directive.

func (*RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective) UnmarshalJSON added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperationSet    RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation = "set"
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperationRemove RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation = "remove"
)

func (RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation) IsKnown added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation `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       rulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveJSON `json:"-"`
}

Set the directive with optional qualifiers.

func (*RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective) UnmarshalJSON added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperationSet    RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation = "set"
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperationRemove RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation = "remove"
)

func (RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation) IsKnown added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateUnion added in v7.9.0

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

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

Union satisfied by RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective or RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective.

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate added in v7.9.0

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

A cache-control directive configuration.

func (*RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate) UnmarshalJSON added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation string

The operation to perform on the cache-control directive.

const (
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperationSet    RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation = "set"
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperationRemove RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation = "remove"
)

func (RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation) IsKnown added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective added in v7.9.0

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

Remove the directive.

func (*RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective) UnmarshalJSON added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperationSet    RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation = "set"
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperationRemove RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation = "remove"
)

func (RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation) IsKnown added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective added in v7.9.0

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

Set the directive.

func (*RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective) UnmarshalJSON added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperationSet    RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation = "set"
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperationRemove RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation = "remove"
)

func (RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation) IsKnown added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateUnion added in v7.9.0

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

A cache-control directive configuration.

Union satisfied by RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective or RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective.

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublic added in v7.9.0

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

A cache-control directive configuration.

func (*RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublic) UnmarshalJSON added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicOperation added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicOperation string

The operation to perform on the cache-control directive.

const (
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicOperationSet    RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicOperation = "set"
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicOperationRemove RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicOperation = "remove"
)

func (RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicOperation) IsKnown added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective added in v7.9.0

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

Remove the directive.

func (*RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective) UnmarshalJSON added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperationSet    RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation = "set"
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperationRemove RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation = "remove"
)

func (RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation) IsKnown added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective added in v7.9.0

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

Set the directive.

func (*RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective) UnmarshalJSON added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperationSet    RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation = "set"
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperationRemove RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation = "remove"
)

func (RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation) IsKnown added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicUnion added in v7.9.0

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

A cache-control directive configuration.

Union satisfied by RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective or RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective.

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxage added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxage struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation `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  rulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageJSON `json:"-"`
	// contains filtered or unexported fields
}

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

func (*RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxage) UnmarshalJSON added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation string

The operation to perform on the cache-control directive.

const (
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperationSet    RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation = "set"
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperationRemove RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation = "remove"
)

func (RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation) IsKnown added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective added in v7.9.0

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

Remove the directive.

func (*RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective) UnmarshalJSON added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperationSet    RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation = "set"
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperationRemove RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation = "remove"
)

func (RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation) IsKnown added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation `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           rulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveJSON `json:"-"`
}

Set the directive with a duration value in seconds.

func (*RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective) UnmarshalJSON added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperationSet    RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation = "set"
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperationRemove RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation = "remove"
)

func (RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation) IsKnown added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageUnion added in v7.9.0

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

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

Union satisfied by RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective or RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective.

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfError added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfError struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation `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  rulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorJSON `json:"-"`
	// contains filtered or unexported fields
}

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

func (*RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfError) UnmarshalJSON added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation string

The operation to perform on the cache-control directive.

const (
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperationSet    RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation = "set"
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperationRemove RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation = "remove"
)

func (RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation) IsKnown added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective added in v7.9.0

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

Remove the directive.

func (*RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective) UnmarshalJSON added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperationSet    RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation = "set"
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperationRemove RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation = "remove"
)

func (RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation) IsKnown added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation `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           rulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveJSON `json:"-"`
}

Set the directive with a duration value in seconds.

func (*RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective) UnmarshalJSON added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperationSet    RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation = "set"
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperationRemove RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation = "remove"
)

func (RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation) IsKnown added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorUnion added in v7.9.0

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

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

Union satisfied by RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective or RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective.

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation `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  rulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateJSON `json:"-"`
	// contains filtered or unexported fields
}

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

func (*RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate) UnmarshalJSON added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation string

The operation to perform on the cache-control directive.

const (
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperationSet    RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation = "set"
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperationRemove RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation = "remove"
)

func (RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation) IsKnown added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective added in v7.9.0

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

Remove the directive.

func (*RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective) UnmarshalJSON added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperationSet    RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation = "set"
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperationRemove RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation = "remove"
)

func (RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation) IsKnown added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation `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           rulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveJSON `json:"-"`
}

Set the directive with a duration value in seconds.

func (*RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective) UnmarshalJSON added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperationSet    RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation = "set"
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperationRemove RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation = "remove"
)

func (RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation) IsKnown added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateUnion added in v7.9.0

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

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

Union satisfied by RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective or RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective.

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleExposedCredentialCheck added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleExposedCredentialCheck 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               rulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleExposedCredentialCheck) UnmarshalJSON added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleRatelimit added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleRatelimit 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                    rulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheControlRuleRatelimit) UnmarshalJSON added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRule added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRule 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 RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleAction `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParameters `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 RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleExposedCredentialCheck `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 RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                                                            `json:"ref"`
	JSON rulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleJSON `json:"-"`
}

func (*RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRule) UnmarshalJSON added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleAction added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleAction string

The action to perform when the rule matches.

const (
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionSetCacheTags RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleAction = "set_cache_tags"
)

func (RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleAction) IsKnown added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParameters added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParameters struct {
	// The operation to perform on the cache tags.
	Operation RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersOperation `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   rulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersJSON `json:"-"`
	// contains filtered or unexported fields
}

The parameters configuring the rule's action.

func (*RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParameters) UnmarshalJSON added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression 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 RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation `json:"operation" api:"required"`
	JSON      rulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionJSON      `json:"-"`
}

Add cache tags using an expression.

func (*RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression) UnmarshalJSON added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation string

The operation to perform on the cache tags.

const (
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationAdd    RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "add"
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationRemove RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "remove"
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationSet    RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "set"
)

func (RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation) IsKnown added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues added in v7.9.0

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

Add cache tags using a list of values.

func (*RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues) UnmarshalJSON added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation string

The operation to perform on the cache tags.

const (
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationAdd    RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "add"
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationRemove RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "remove"
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationSet    RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "set"
)

func (RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation) IsKnown added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersOperation added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersOperation string

The operation to perform on the cache tags.

const (
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersOperationAdd    RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersOperation = "add"
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersOperationRemove RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersOperation = "remove"
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersOperationSet    RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersOperation = "set"
)

func (RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersOperation) IsKnown added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression 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 RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation `json:"operation" api:"required"`
	JSON      rulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionJSON      `json:"-"`
}

Remove cache tags using an expression.

func (*RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression) UnmarshalJSON added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation string

The operation to perform on the cache tags.

const (
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationAdd    RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "add"
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationRemove RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "remove"
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationSet    RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "set"
)

func (RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation) IsKnown added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues added in v7.9.0

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

Remove cache tags using a list of values.

func (*RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues) UnmarshalJSON added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation string

The operation to perform on the cache tags.

const (
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationAdd    RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "add"
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationRemove RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "remove"
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationSet    RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "set"
)

func (RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation) IsKnown added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression 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 RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation `json:"operation" api:"required"`
	JSON      rulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionJSON      `json:"-"`
}

Set cache tags using an expression.

func (*RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression) UnmarshalJSON added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation string

The operation to perform on the cache tags.

const (
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationAdd    RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "add"
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationRemove RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "remove"
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationSet    RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "set"
)

func (RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation) IsKnown added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues added in v7.9.0

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

Set cache tags using a list of values.

func (*RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues) UnmarshalJSON added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation string

The operation to perform on the cache tags.

const (
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationAdd    RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "add"
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationRemove RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "remove"
	RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationSet    RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "set"
)

func (RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation) IsKnown added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleExposedCredentialCheck added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleExposedCredentialCheck 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               rulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleExposedCredentialCheck) UnmarshalJSON added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleRatelimit added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleRatelimit 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                    rulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*RulesetNewResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleRatelimit) UnmarshalJSON added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRule added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRule 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 RulesetNewResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleAction `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters RulesetNewResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleActionParameters `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 RulesetNewResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleExposedCredentialCheck `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 RulesetNewResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                                                                     `json:"ref"`
	JSON rulesetNewResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleJSON `json:"-"`
}

func (*RulesetNewResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRule) UnmarshalJSON added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleAction added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleAction string

The action to perform when the rule matches.

const (
	RulesetNewResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleActionTransformResponseHTML RulesetNewResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleAction = "transform_response_html"
)

func (RulesetNewResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleAction) IsKnown added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleActionParameters added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleActionParameters struct {
	// Enables the link maze transformation on the response.
	LinkMaze interface{}                                                                                `json:"link_maze" api:"required"`
	JSON     rulesetNewResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleActionParametersJSON `json:"-"`
}

The parameters configuring the rule's action.

func (*RulesetNewResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleActionParameters) UnmarshalJSON added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleExposedCredentialCheck added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleExposedCredentialCheck 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               rulesetNewResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*RulesetNewResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleExposedCredentialCheck) UnmarshalJSON added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleRatelimit added in v7.9.0

type RulesetNewResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleRatelimit 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                    rulesetNewResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*RulesetNewResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleRatelimit) UnmarshalJSON added in v7.9.0

type RulesetNewResponseEnvelopeSuccess

type RulesetNewResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	RulesetNewResponseEnvelopeSuccessTrue RulesetNewResponseEnvelopeSuccess = true
)

func (RulesetNewResponseEnvelopeSuccess) IsKnown

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, params 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

Fetches all rulesets.

func (*RulesetService) ListAutoPaging

Fetches all rulesets.

func (*RulesetService) New

Creates a ruleset.

func (*RulesetService) Update

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"`
	// Validates the request without persisting changes when set to `true`. Responses
	// that normally return 200 return `result: null`; endpoints that normally return
	// 204 continue to return 204.
	DryRun param.Field[bool] `query:"dry_run"`
	// 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)

func (RulesetUpdateParams) URLQuery added in v7.9.0

func (r RulesetUpdateParams) URLQuery() (v url.Values)

URLQuery serializes RulesetUpdateParams's query parameters as `url.Values`.

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 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"
	RulesetUpdateParamsRulesActionTransformResponseHTML RulesetUpdateParamsRulesAction = "transform_response_html"
)

func (RulesetUpdateParamsRulesAction) IsKnown

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

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

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

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

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

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

type RulesetUpdateParamsRulesRulesetsSetCacheControlRule

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

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

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleAction

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleAction string

The action to perform when the rule matches.

const (
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionSetCacheControl RulesetUpdateParamsRulesRulesetsSetCacheControlRuleAction = "set_cache_control"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleAction) IsKnown

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParameters

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

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutable

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

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation string

The operation to perform on the cache-control directive.

const (
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation = "set"
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation = "remove"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation) IsKnown

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective

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

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation = "set"
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation = "remove"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation) IsKnown

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective

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

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation = "set"
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation = "remove"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation) IsKnown

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAge

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

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation string

The operation to perform on the cache-control directive.

const (
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation = "set"
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation = "remove"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation) IsKnown

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective

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

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation = "set"
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation = "remove"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation) IsKnown

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective

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

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation = "set"
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation = "remove"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation) IsKnown

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMaxAgeUnion

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

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

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation string

The operation to perform on the cache-control directive.

const (
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation = "set"
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation = "remove"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation) IsKnown

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective

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

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation = "set"
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation = "remove"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation) IsKnown

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective

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

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation = "set"
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation = "remove"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation) IsKnown

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand

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

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation string

The operation to perform on the cache-control directive.

const (
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation = "set"
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation = "remove"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation) IsKnown

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective

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

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation = "set"
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation = "remove"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation) IsKnown

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective

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

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation = "set"
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation = "remove"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation) IsKnown

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCache

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

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation string

The operation to perform on the cache-control directive.

const (
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation = "set"
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation = "remove"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation) IsKnown

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective

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

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation = "set"
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation = "remove"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation) IsKnown

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective

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

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation = "set"
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation = "remove"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation) IsKnown

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoCacheUnion

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

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

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation string

The operation to perform on the cache-control directive.

const (
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation = "set"
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation = "remove"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation) IsKnown

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective

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

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation = "set"
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation = "remove"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation) IsKnown

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective

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

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation = "set"
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation = "remove"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation) IsKnown

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransform

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

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation string

The operation to perform on the cache-control directive.

const (
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation = "set"
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation = "remove"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation) IsKnown

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective

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

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation = "set"
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation = "remove"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation) IsKnown

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective

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

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation = "set"
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation = "remove"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation) IsKnown

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivate

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

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation string

The operation to perform on the cache-control directive.

const (
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation = "set"
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation = "remove"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation) IsKnown

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective

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

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation = "set"
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation = "remove"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation) IsKnown

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective

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

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation = "set"
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation = "remove"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation) IsKnown

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPrivateUnion

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

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

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation string

The operation to perform on the cache-control directive.

const (
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation = "set"
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation = "remove"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation) IsKnown

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective

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

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation = "set"
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation = "remove"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation) IsKnown

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective

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

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation = "set"
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation = "remove"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation) IsKnown

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublic

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

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicOperation

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicOperation string

The operation to perform on the cache-control directive.

const (
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicOperation = "set"
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicOperation = "remove"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicOperation) IsKnown

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective

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

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation = "set"
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation = "remove"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation) IsKnown

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective

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

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation = "set"
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation = "remove"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation) IsKnown

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxage

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

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation string

The operation to perform on the cache-control directive.

const (
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation = "set"
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation = "remove"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation) IsKnown

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective

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

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation = "set"
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation = "remove"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation) IsKnown

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective

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

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation = "set"
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation = "remove"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation) IsKnown

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersSMaxageUnion

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

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

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation string

The operation to perform on the cache-control directive.

const (
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation = "set"
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation = "remove"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation) IsKnown

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective

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

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation = "set"
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation = "remove"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation) IsKnown

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective

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

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation = "set"
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation = "remove"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation) IsKnown

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorUnion

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

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

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation string

The operation to perform on the cache-control directive.

const (
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation = "set"
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation = "remove"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation) IsKnown

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective

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

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation = "set"
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation = "remove"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation) IsKnown

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective

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

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation = "set"
	RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation = "remove"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation) IsKnown

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleExposedCredentialCheck

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

type RulesetUpdateParamsRulesRulesetsSetCacheControlRuleRatelimit

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

type RulesetUpdateParamsRulesRulesetsSetCacheTagsRule

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

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

type RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleAction

type RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleAction string

The action to perform when the rule matches.

const (
	RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionSetCacheTags RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleAction = "set_cache_tags"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleAction) IsKnown

type RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParameters

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

type RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression

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

type RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation

type RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation string

The operation to perform on the cache tags.

const (
	RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationAdd    RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "add"
	RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "remove"
	RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "set"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation) IsKnown

type RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues

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

type RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation

type RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation string

The operation to perform on the cache tags.

const (
	RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationAdd    RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "add"
	RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "remove"
	RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "set"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation) IsKnown

type RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersOperation

type RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersOperation string

The operation to perform on the cache tags.

const (
	RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersOperationAdd    RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersOperation = "add"
	RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersOperation = "remove"
	RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersOperation = "set"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersOperation) IsKnown

type RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression

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

type RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation

type RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation string

The operation to perform on the cache tags.

const (
	RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationAdd    RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "add"
	RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "remove"
	RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "set"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation) IsKnown

type RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues

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

type RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation

type RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation string

The operation to perform on the cache tags.

const (
	RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationAdd    RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "add"
	RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "remove"
	RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "set"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation) IsKnown

type RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression

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

type RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation

type RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation string

The operation to perform on the cache tags.

const (
	RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationAdd    RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "add"
	RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "remove"
	RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "set"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation) IsKnown

type RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues

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

type RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation

type RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation string

The operation to perform on the cache tags.

const (
	RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationAdd    RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "add"
	RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationRemove RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "remove"
	RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationSet    RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "set"
)

func (RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation) IsKnown

type RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleExposedCredentialCheck

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

type RulesetUpdateParamsRulesRulesetsSetCacheTagsRuleRatelimit

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

type RulesetUpdateParamsRulesRulesetsTransformResponseHTMLRule added in v7.7.0

type RulesetUpdateParamsRulesRulesetsTransformResponseHTMLRule struct {
	// The unique ID of the rule.
	ID param.Field[string] `json:"id"`
	// The action to perform when the rule matches.
	Action param.Field[RulesetUpdateParamsRulesRulesetsTransformResponseHTMLRuleAction] `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters param.Field[RulesetUpdateParamsRulesRulesetsTransformResponseHTMLRuleActionParameters] `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[RulesetUpdateParamsRulesRulesetsTransformResponseHTMLRuleExposedCredentialCheck] `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[RulesetUpdateParamsRulesRulesetsTransformResponseHTMLRuleRatelimit] `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref param.Field[string] `json:"ref"`
}

func (RulesetUpdateParamsRulesRulesetsTransformResponseHTMLRule) MarshalJSON added in v7.7.0

type RulesetUpdateParamsRulesRulesetsTransformResponseHTMLRuleAction added in v7.7.0

type RulesetUpdateParamsRulesRulesetsTransformResponseHTMLRuleAction string

The action to perform when the rule matches.

const (
	RulesetUpdateParamsRulesRulesetsTransformResponseHTMLRuleActionTransformResponseHTML RulesetUpdateParamsRulesRulesetsTransformResponseHTMLRuleAction = "transform_response_html"
)

func (RulesetUpdateParamsRulesRulesetsTransformResponseHTMLRuleAction) IsKnown added in v7.7.0

type RulesetUpdateParamsRulesRulesetsTransformResponseHTMLRuleActionParameters added in v7.7.0

type RulesetUpdateParamsRulesRulesetsTransformResponseHTMLRuleActionParameters struct {
	// Enables the link maze transformation on the response.
	LinkMaze param.Field[interface{}] `json:"link_maze" api:"required"`
}

The parameters configuring the rule's action.

func (RulesetUpdateParamsRulesRulesetsTransformResponseHTMLRuleActionParameters) MarshalJSON added in v7.7.0

type RulesetUpdateParamsRulesRulesetsTransformResponseHTMLRuleExposedCredentialCheck added in v7.7.0

type RulesetUpdateParamsRulesRulesetsTransformResponseHTMLRuleExposedCredentialCheck 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 (RulesetUpdateParamsRulesRulesetsTransformResponseHTMLRuleExposedCredentialCheck) MarshalJSON added in v7.7.0

type RulesetUpdateParamsRulesRulesetsTransformResponseHTMLRuleRatelimit added in v7.7.0

type RulesetUpdateParamsRulesRulesetsTransformResponseHTMLRuleRatelimit 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 (RulesetUpdateParamsRulesRulesetsTransformResponseHTMLRuleRatelimit) MarshalJSON added in v7.7.0

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 result.
	Result RulesetUpdateResponseEnvelopeResult `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 RulesetUpdateResponseEnvelopeResult added in v7.9.0

type RulesetUpdateResponseEnvelopeResult 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 []RulesetUpdateResponseEnvelopeResultRules `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        rulesetUpdateResponseEnvelopeResultJSON `json:"-"`
}

A ruleset object.

func (*RulesetUpdateResponseEnvelopeResult) UnmarshalJSON added in v7.9.0

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

type RulesetUpdateResponseEnvelopeResultRules added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRules 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 RulesetUpdateResponseEnvelopeResultRulesAction `json:"action"`
	// This field can have the runtime type of [BlockRuleActionParameters],
	// [interface{}], [CompressResponseRuleActionParameters],
	// [ExecuteRuleActionParameters], [LogCustomFieldRuleActionParameters],
	// [RedirectRuleActionParameters], [RewriteRuleActionParameters],
	// [RouteRuleActionParameters], [ScoreRuleActionParameters],
	// [ServeErrorRuleActionParameters],
	// [RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParameters],
	// [SetCacheSettingsRuleActionParameters],
	// [RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParameters],
	// [SetConfigRuleActionParameters], [SkipRuleActionParameters],
	// [RulesetUpdateResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleActionParameters].
	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],
	// [RulesetUpdateResponseEnvelopeResultRulesRulesetsChallengeRuleExposedCredentialCheck],
	// [CompressResponseRuleExposedCredentialCheck],
	// [DDoSDynamicRuleExposedCredentialCheck], [ExecuteRuleExposedCredentialCheck],
	// [ForceConnectionCloseRuleExposedCredentialCheck],
	// [RulesetUpdateResponseEnvelopeResultRulesRulesetsJSChallengeRuleExposedCredentialCheck],
	// [LogRuleExposedCredentialCheck], [LogCustomFieldRuleExposedCredentialCheck],
	// [ManagedChallengeRuleExposedCredentialCheck],
	// [RedirectRuleExposedCredentialCheck], [RewriteRuleExposedCredentialCheck],
	// [RouteRuleExposedCredentialCheck], [ScoreRuleExposedCredentialCheck],
	// [ServeErrorRuleExposedCredentialCheck],
	// [RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleExposedCredentialCheck],
	// [SetCacheSettingsRuleExposedCredentialCheck],
	// [RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleExposedCredentialCheck],
	// [SetConfigRuleExposedCredentialCheck], [SkipRuleExposedCredentialCheck],
	// [RulesetUpdateResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleExposedCredentialCheck].
	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],
	// [RulesetUpdateResponseEnvelopeResultRulesRulesetsChallengeRuleRatelimit],
	// [CompressResponseRuleRatelimit], [DDoSDynamicRuleRatelimit],
	// [ExecuteRuleRatelimit], [ForceConnectionCloseRuleRatelimit],
	// [RulesetUpdateResponseEnvelopeResultRulesRulesetsJSChallengeRuleRatelimit],
	// [LogRuleRatelimit], [LogCustomFieldRuleRatelimit],
	// [ManagedChallengeRuleRatelimit], [RedirectRuleRatelimit],
	// [RewriteRuleRatelimit], [RouteRuleRatelimit], [ScoreRuleRatelimit],
	// [ServeErrorRuleRatelimit],
	// [RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleRatelimit],
	// [SetCacheSettingsRuleRatelimit],
	// [RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleRatelimit],
	// [SetConfigRuleRatelimit], [SkipRuleRatelimit],
	// [RulesetUpdateResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleRatelimit].
	Ratelimit interface{} `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                                       `json:"ref"`
	JSON rulesetUpdateResponseEnvelopeResultRulesJSON `json:"-"`
	// contains filtered or unexported fields
}

func (*RulesetUpdateResponseEnvelopeResultRules) UnmarshalJSON added in v7.9.0

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

type RulesetUpdateResponseEnvelopeResultRulesAction added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesAction string

The action to perform when the rule matches.

const (
	RulesetUpdateResponseEnvelopeResultRulesActionBlock                 RulesetUpdateResponseEnvelopeResultRulesAction = "block"
	RulesetUpdateResponseEnvelopeResultRulesActionChallenge             RulesetUpdateResponseEnvelopeResultRulesAction = "challenge"
	RulesetUpdateResponseEnvelopeResultRulesActionCompressResponse      RulesetUpdateResponseEnvelopeResultRulesAction = "compress_response"
	RulesetUpdateResponseEnvelopeResultRulesActionDDoSDynamic           RulesetUpdateResponseEnvelopeResultRulesAction = "ddos_dynamic"
	RulesetUpdateResponseEnvelopeResultRulesActionExecute               RulesetUpdateResponseEnvelopeResultRulesAction = "execute"
	RulesetUpdateResponseEnvelopeResultRulesActionForceConnectionClose  RulesetUpdateResponseEnvelopeResultRulesAction = "force_connection_close"
	RulesetUpdateResponseEnvelopeResultRulesActionJSChallenge           RulesetUpdateResponseEnvelopeResultRulesAction = "js_challenge"
	RulesetUpdateResponseEnvelopeResultRulesActionLog                   RulesetUpdateResponseEnvelopeResultRulesAction = "log"
	RulesetUpdateResponseEnvelopeResultRulesActionLogCustomField        RulesetUpdateResponseEnvelopeResultRulesAction = "log_custom_field"
	RulesetUpdateResponseEnvelopeResultRulesActionManagedChallenge      RulesetUpdateResponseEnvelopeResultRulesAction = "managed_challenge"
	RulesetUpdateResponseEnvelopeResultRulesActionRedirect              RulesetUpdateResponseEnvelopeResultRulesAction = "redirect"
	RulesetUpdateResponseEnvelopeResultRulesActionRewrite               RulesetUpdateResponseEnvelopeResultRulesAction = "rewrite"
	RulesetUpdateResponseEnvelopeResultRulesActionRoute                 RulesetUpdateResponseEnvelopeResultRulesAction = "route"
	RulesetUpdateResponseEnvelopeResultRulesActionScore                 RulesetUpdateResponseEnvelopeResultRulesAction = "score"
	RulesetUpdateResponseEnvelopeResultRulesActionServeError            RulesetUpdateResponseEnvelopeResultRulesAction = "serve_error"
	RulesetUpdateResponseEnvelopeResultRulesActionSetCacheControl       RulesetUpdateResponseEnvelopeResultRulesAction = "set_cache_control"
	RulesetUpdateResponseEnvelopeResultRulesActionSetCacheSettings      RulesetUpdateResponseEnvelopeResultRulesAction = "set_cache_settings"
	RulesetUpdateResponseEnvelopeResultRulesActionSetCacheTags          RulesetUpdateResponseEnvelopeResultRulesAction = "set_cache_tags"
	RulesetUpdateResponseEnvelopeResultRulesActionSetConfig             RulesetUpdateResponseEnvelopeResultRulesAction = "set_config"
	RulesetUpdateResponseEnvelopeResultRulesActionSkip                  RulesetUpdateResponseEnvelopeResultRulesAction = "skip"
	RulesetUpdateResponseEnvelopeResultRulesActionTransformResponseHTML RulesetUpdateResponseEnvelopeResultRulesAction = "transform_response_html"
)

func (RulesetUpdateResponseEnvelopeResultRulesAction) IsKnown added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsChallengeRule added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsChallengeRule 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 RulesetUpdateResponseEnvelopeResultRulesRulesetsChallengeRuleAction `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 RulesetUpdateResponseEnvelopeResultRulesRulesetsChallengeRuleExposedCredentialCheck `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 RulesetUpdateResponseEnvelopeResultRulesRulesetsChallengeRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                                                            `json:"ref"`
	JSON rulesetUpdateResponseEnvelopeResultRulesRulesetsChallengeRuleJSON `json:"-"`
}

func (*RulesetUpdateResponseEnvelopeResultRulesRulesetsChallengeRule) UnmarshalJSON added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsChallengeRuleAction added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsChallengeRuleAction string

The action to perform when the rule matches.

const (
	RulesetUpdateResponseEnvelopeResultRulesRulesetsChallengeRuleActionChallenge RulesetUpdateResponseEnvelopeResultRulesRulesetsChallengeRuleAction = "challenge"
)

func (RulesetUpdateResponseEnvelopeResultRulesRulesetsChallengeRuleAction) IsKnown added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsChallengeRuleExposedCredentialCheck added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsChallengeRuleExposedCredentialCheck 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               rulesetUpdateResponseEnvelopeResultRulesRulesetsChallengeRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*RulesetUpdateResponseEnvelopeResultRulesRulesetsChallengeRuleExposedCredentialCheck) UnmarshalJSON added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsChallengeRuleRatelimit added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsChallengeRuleRatelimit 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                    rulesetUpdateResponseEnvelopeResultRulesRulesetsChallengeRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*RulesetUpdateResponseEnvelopeResultRulesRulesetsChallengeRuleRatelimit) UnmarshalJSON added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsJSChallengeRule added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsJSChallengeRule 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 RulesetUpdateResponseEnvelopeResultRulesRulesetsJSChallengeRuleAction `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 RulesetUpdateResponseEnvelopeResultRulesRulesetsJSChallengeRuleExposedCredentialCheck `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 RulesetUpdateResponseEnvelopeResultRulesRulesetsJSChallengeRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                                                              `json:"ref"`
	JSON rulesetUpdateResponseEnvelopeResultRulesRulesetsJSChallengeRuleJSON `json:"-"`
}

func (*RulesetUpdateResponseEnvelopeResultRulesRulesetsJSChallengeRule) UnmarshalJSON added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsJSChallengeRuleAction added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsJSChallengeRuleAction string

The action to perform when the rule matches.

const (
	RulesetUpdateResponseEnvelopeResultRulesRulesetsJSChallengeRuleActionJSChallenge RulesetUpdateResponseEnvelopeResultRulesRulesetsJSChallengeRuleAction = "js_challenge"
)

func (RulesetUpdateResponseEnvelopeResultRulesRulesetsJSChallengeRuleAction) IsKnown added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsJSChallengeRuleExposedCredentialCheck added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsJSChallengeRuleExposedCredentialCheck 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               rulesetUpdateResponseEnvelopeResultRulesRulesetsJSChallengeRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*RulesetUpdateResponseEnvelopeResultRulesRulesetsJSChallengeRuleExposedCredentialCheck) UnmarshalJSON added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsJSChallengeRuleRatelimit added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsJSChallengeRuleRatelimit 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                    rulesetUpdateResponseEnvelopeResultRulesRulesetsJSChallengeRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*RulesetUpdateResponseEnvelopeResultRulesRulesetsJSChallengeRuleRatelimit) UnmarshalJSON added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRule added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRule 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 RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleAction `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParameters `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 RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleExposedCredentialCheck `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 RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                                                                  `json:"ref"`
	JSON rulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleJSON `json:"-"`
}

func (*RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRule) UnmarshalJSON added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleAction added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleAction string

The action to perform when the rule matches.

const (
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionSetCacheControl RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleAction = "set_cache_control"
)

func (RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleAction) IsKnown added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParameters added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParameters struct {
	// A cache-control directive configuration.
	Immutable RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutable `json:"immutable"`
	// A cache-control directive configuration that accepts a duration value in
	// seconds.
	MaxAge RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAge `json:"max-age"`
	// A cache-control directive configuration.
	MustRevalidate RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate `json:"must-revalidate"`
	// A cache-control directive configuration.
	MustUnderstand RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand `json:"must-understand"`
	// A cache-control directive configuration that accepts optional qualifiers (header
	// names).
	NoCache RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCache `json:"no-cache"`
	// A cache-control directive configuration.
	NoStore RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStore `json:"no-store"`
	// A cache-control directive configuration.
	NoTransform RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransform `json:"no-transform"`
	// A cache-control directive configuration that accepts optional qualifiers (header
	// names).
	Private RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivate `json:"private"`
	// A cache-control directive configuration.
	ProxyRevalidate RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate `json:"proxy-revalidate"`
	// A cache-control directive configuration.
	Public RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublic `json:"public"`
	// A cache-control directive configuration that accepts a duration value in
	// seconds.
	SMaxage RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxage `json:"s-maxage"`
	// A cache-control directive configuration that accepts a duration value in
	// seconds.
	StaleIfError RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfError `json:"stale-if-error"`
	// A cache-control directive configuration that accepts a duration value in
	// seconds.
	StaleWhileRevalidate RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate `json:"stale-while-revalidate"`
	JSON                 rulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersJSON                 `json:"-"`
}

The parameters configuring the rule's action.

func (*RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParameters) UnmarshalJSON added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutable added in v7.9.0

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

A cache-control directive configuration.

func (*RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutable) UnmarshalJSON added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation string

The operation to perform on the cache-control directive.

const (
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableOperationSet    RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation = "set"
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableOperationRemove RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation = "remove"
)

func (RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation) IsKnown added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective added in v7.9.0

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

Remove the directive.

func (*RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective) UnmarshalJSON added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperationSet    RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation = "set"
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperationRemove RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation = "remove"
)

func (RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation) IsKnown added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective added in v7.9.0

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

Set the directive.

func (*RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective) UnmarshalJSON added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperationSet    RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation = "set"
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperationRemove RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation = "remove"
)

func (RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation) IsKnown added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableUnion added in v7.9.0

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

A cache-control directive configuration.

Union satisfied by RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective or RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective.

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAge added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAge struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation `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  rulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeJSON `json:"-"`
	// contains filtered or unexported fields
}

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

func (*RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAge) UnmarshalJSON added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation string

The operation to perform on the cache-control directive.

const (
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperationSet    RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation = "set"
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperationRemove RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation = "remove"
)

func (RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation) IsKnown added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective added in v7.9.0

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

Remove the directive.

func (*RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective) UnmarshalJSON added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperationSet    RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation = "set"
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperationRemove RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation = "remove"
)

func (RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation) IsKnown added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation `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           rulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveJSON `json:"-"`
}

Set the directive with a duration value in seconds.

func (*RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective) UnmarshalJSON added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperationSet    RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation = "set"
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperationRemove RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation = "remove"
)

func (RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation) IsKnown added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeUnion added in v7.9.0

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

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

Union satisfied by RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective or RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective.

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate added in v7.9.0

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

A cache-control directive configuration.

func (*RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidate) UnmarshalJSON added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation string

The operation to perform on the cache-control directive.

const (
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperationSet    RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation = "set"
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperationRemove RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation = "remove"
)

func (RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation) IsKnown added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective added in v7.9.0

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

Remove the directive.

func (*RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective) UnmarshalJSON added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperationSet    RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation = "set"
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperationRemove RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation = "remove"
)

func (RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation) IsKnown added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective added in v7.9.0

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

Set the directive.

func (*RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective) UnmarshalJSON added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperationSet    RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation = "set"
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperationRemove RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation = "remove"
)

func (RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation) IsKnown added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateUnion added in v7.9.0

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

A cache-control directive configuration.

Union satisfied by RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective or RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective.

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand added in v7.9.0

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

A cache-control directive configuration.

func (*RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand) UnmarshalJSON added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation string

The operation to perform on the cache-control directive.

const (
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperationSet    RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation = "set"
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperationRemove RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation = "remove"
)

func (RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation) IsKnown added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective added in v7.9.0

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

Remove the directive.

func (*RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective) UnmarshalJSON added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperationSet    RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation = "set"
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperationRemove RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation = "remove"
)

func (RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation) IsKnown added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective added in v7.9.0

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

Set the directive.

func (*RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective) UnmarshalJSON added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperationSet    RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation = "set"
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperationRemove RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation = "remove"
)

func (RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation) IsKnown added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandUnion added in v7.9.0

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

A cache-control directive configuration.

Union satisfied by RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective or RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective.

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCache added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCache struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation `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       rulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheJSON `json:"-"`
	// contains filtered or unexported fields
}

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

func (*RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCache) UnmarshalJSON added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation string

The operation to perform on the cache-control directive.

const (
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperationSet    RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation = "set"
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperationRemove RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation = "remove"
)

func (RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation) IsKnown added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective added in v7.9.0

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

Remove the directive.

func (*RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective) UnmarshalJSON added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperationSet    RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation = "set"
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperationRemove RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation = "remove"
)

func (RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation) IsKnown added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation `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       rulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveJSON `json:"-"`
}

Set the directive with optional qualifiers.

func (*RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective) UnmarshalJSON added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperationSet    RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation = "set"
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperationRemove RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation = "remove"
)

func (RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation) IsKnown added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheUnion added in v7.9.0

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

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

Union satisfied by RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective or RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective.

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStore added in v7.9.0

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

A cache-control directive configuration.

func (*RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStore) UnmarshalJSON added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation string

The operation to perform on the cache-control directive.

const (
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperationSet    RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation = "set"
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperationRemove RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation = "remove"
)

func (RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation) IsKnown added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective added in v7.9.0

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

Remove the directive.

func (*RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective) UnmarshalJSON added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperationSet    RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation = "set"
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperationRemove RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation = "remove"
)

func (RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation) IsKnown added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective added in v7.9.0

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

Set the directive.

func (*RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective) UnmarshalJSON added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperationSet    RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation = "set"
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperationRemove RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation = "remove"
)

func (RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation) IsKnown added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreUnion added in v7.9.0

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

A cache-control directive configuration.

Union satisfied by RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective or RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective.

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransform added in v7.9.0

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

A cache-control directive configuration.

func (*RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransform) UnmarshalJSON added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation string

The operation to perform on the cache-control directive.

const (
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperationSet    RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation = "set"
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperationRemove RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation = "remove"
)

func (RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation) IsKnown added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective added in v7.9.0

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

Remove the directive.

func (*RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective) UnmarshalJSON added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperationSet    RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation = "set"
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperationRemove RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation = "remove"
)

func (RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation) IsKnown added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective added in v7.9.0

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

Set the directive.

func (*RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective) UnmarshalJSON added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperationSet    RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation = "set"
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperationRemove RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation = "remove"
)

func (RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation) IsKnown added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformUnion added in v7.9.0

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

A cache-control directive configuration.

Union satisfied by RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective or RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective.

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivate added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivate struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation `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       rulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateJSON `json:"-"`
	// contains filtered or unexported fields
}

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

func (*RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivate) UnmarshalJSON added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation string

The operation to perform on the cache-control directive.

const (
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateOperationSet    RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation = "set"
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateOperationRemove RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation = "remove"
)

func (RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation) IsKnown added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective added in v7.9.0

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

Remove the directive.

func (*RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective) UnmarshalJSON added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperationSet    RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation = "set"
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperationRemove RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation = "remove"
)

func (RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation) IsKnown added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation `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       rulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveJSON `json:"-"`
}

Set the directive with optional qualifiers.

func (*RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective) UnmarshalJSON added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperationSet    RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation = "set"
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperationRemove RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation = "remove"
)

func (RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation) IsKnown added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateUnion added in v7.9.0

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

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

Union satisfied by RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective or RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective.

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate added in v7.9.0

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

A cache-control directive configuration.

func (*RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidate) UnmarshalJSON added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation string

The operation to perform on the cache-control directive.

const (
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperationSet    RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation = "set"
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperationRemove RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation = "remove"
)

func (RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation) IsKnown added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective added in v7.9.0

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

Remove the directive.

func (*RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective) UnmarshalJSON added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperationSet    RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation = "set"
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperationRemove RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation = "remove"
)

func (RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation) IsKnown added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective added in v7.9.0

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

Set the directive.

func (*RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective) UnmarshalJSON added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperationSet    RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation = "set"
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperationRemove RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation = "remove"
)

func (RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation) IsKnown added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateUnion added in v7.9.0

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

A cache-control directive configuration.

Union satisfied by RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective or RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective.

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublic added in v7.9.0

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

A cache-control directive configuration.

func (*RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublic) UnmarshalJSON added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicOperation added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicOperation string

The operation to perform on the cache-control directive.

const (
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicOperationSet    RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicOperation = "set"
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicOperationRemove RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicOperation = "remove"
)

func (RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicOperation) IsKnown added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective added in v7.9.0

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

Remove the directive.

func (*RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective) UnmarshalJSON added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperationSet    RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation = "set"
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperationRemove RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation = "remove"
)

func (RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation) IsKnown added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective added in v7.9.0

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

Set the directive.

func (*RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective) UnmarshalJSON added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperationSet    RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation = "set"
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperationRemove RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation = "remove"
)

func (RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation) IsKnown added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicUnion added in v7.9.0

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

A cache-control directive configuration.

Union satisfied by RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective or RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective.

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxage added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxage struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation `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  rulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageJSON `json:"-"`
	// contains filtered or unexported fields
}

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

func (*RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxage) UnmarshalJSON added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation string

The operation to perform on the cache-control directive.

const (
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperationSet    RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation = "set"
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperationRemove RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation = "remove"
)

func (RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation) IsKnown added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective added in v7.9.0

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

Remove the directive.

func (*RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective) UnmarshalJSON added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperationSet    RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation = "set"
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperationRemove RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation = "remove"
)

func (RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation) IsKnown added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation `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           rulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveJSON `json:"-"`
}

Set the directive with a duration value in seconds.

func (*RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective) UnmarshalJSON added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperationSet    RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation = "set"
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperationRemove RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation = "remove"
)

func (RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation) IsKnown added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageUnion added in v7.9.0

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

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

Union satisfied by RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective or RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective.

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfError added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfError struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation `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  rulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorJSON `json:"-"`
	// contains filtered or unexported fields
}

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

func (*RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfError) UnmarshalJSON added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation string

The operation to perform on the cache-control directive.

const (
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperationSet    RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation = "set"
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperationRemove RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation = "remove"
)

func (RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation) IsKnown added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective added in v7.9.0

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

Remove the directive.

func (*RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective) UnmarshalJSON added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperationSet    RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation = "set"
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperationRemove RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation = "remove"
)

func (RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation) IsKnown added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation `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           rulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveJSON `json:"-"`
}

Set the directive with a duration value in seconds.

func (*RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective) UnmarshalJSON added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperationSet    RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation = "set"
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperationRemove RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation = "remove"
)

func (RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation) IsKnown added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorUnion added in v7.9.0

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

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

Union satisfied by RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective or RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective.

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation `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  rulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateJSON `json:"-"`
	// contains filtered or unexported fields
}

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

func (*RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidate) UnmarshalJSON added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation string

The operation to perform on the cache-control directive.

const (
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperationSet    RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation = "set"
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperationRemove RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation = "remove"
)

func (RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation) IsKnown added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective added in v7.9.0

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

Remove the directive.

func (*RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective) UnmarshalJSON added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperationSet    RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation = "set"
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperationRemove RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation = "remove"
)

func (RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation) IsKnown added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective struct {
	// The operation to perform on the cache-control directive.
	Operation RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation `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           rulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveJSON `json:"-"`
}

Set the directive with a duration value in seconds.

func (*RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective) UnmarshalJSON added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperationSet    RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation = "set"
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperationRemove RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation = "remove"
)

func (RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation) IsKnown added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateUnion added in v7.9.0

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

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

Union satisfied by RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective or RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective.

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleExposedCredentialCheck added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleExposedCredentialCheck 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               rulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleExposedCredentialCheck) UnmarshalJSON added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleRatelimit added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleRatelimit 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                    rulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheControlRuleRatelimit) UnmarshalJSON added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRule added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRule 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 RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleAction `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParameters `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 RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleExposedCredentialCheck `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 RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                                                               `json:"ref"`
	JSON rulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleJSON `json:"-"`
}

func (*RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRule) UnmarshalJSON added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleAction added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleAction string

The action to perform when the rule matches.

const (
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionSetCacheTags RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleAction = "set_cache_tags"
)

func (RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleAction) IsKnown added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParameters added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParameters struct {
	// The operation to perform on the cache tags.
	Operation RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersOperation `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   rulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersJSON `json:"-"`
	// contains filtered or unexported fields
}

The parameters configuring the rule's action.

func (*RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParameters) UnmarshalJSON added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression 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 RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation `json:"operation" api:"required"`
	JSON      rulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionJSON      `json:"-"`
}

Add cache tags using an expression.

func (*RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression) UnmarshalJSON added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation string

The operation to perform on the cache tags.

const (
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationAdd    RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "add"
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationRemove RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "remove"
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationSet    RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "set"
)

func (RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation) IsKnown added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues added in v7.9.0

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

Add cache tags using a list of values.

func (*RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues) UnmarshalJSON added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation string

The operation to perform on the cache tags.

const (
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationAdd    RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "add"
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationRemove RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "remove"
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationSet    RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "set"
)

func (RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation) IsKnown added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersOperation added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersOperation string

The operation to perform on the cache tags.

const (
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersOperationAdd    RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersOperation = "add"
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersOperationRemove RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersOperation = "remove"
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersOperationSet    RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersOperation = "set"
)

func (RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersOperation) IsKnown added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression 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 RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation `json:"operation" api:"required"`
	JSON      rulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionJSON      `json:"-"`
}

Remove cache tags using an expression.

func (*RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression) UnmarshalJSON added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation string

The operation to perform on the cache tags.

const (
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationAdd    RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "add"
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationRemove RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "remove"
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationSet    RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "set"
)

func (RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation) IsKnown added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues added in v7.9.0

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

Remove cache tags using a list of values.

func (*RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues) UnmarshalJSON added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation string

The operation to perform on the cache tags.

const (
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationAdd    RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "add"
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationRemove RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "remove"
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationSet    RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "set"
)

func (RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation) IsKnown added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression 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 RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation `json:"operation" api:"required"`
	JSON      rulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionJSON      `json:"-"`
}

Set cache tags using an expression.

func (*RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression) UnmarshalJSON added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation string

The operation to perform on the cache tags.

const (
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationAdd    RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "add"
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationRemove RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "remove"
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationSet    RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "set"
)

func (RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation) IsKnown added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues added in v7.9.0

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

Set cache tags using a list of values.

func (*RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues) UnmarshalJSON added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation string

The operation to perform on the cache tags.

const (
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationAdd    RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "add"
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationRemove RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "remove"
	RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationSet    RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "set"
)

func (RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation) IsKnown added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleExposedCredentialCheck added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleExposedCredentialCheck 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               rulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleExposedCredentialCheck) UnmarshalJSON added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleRatelimit added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleRatelimit 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                    rulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*RulesetUpdateResponseEnvelopeResultRulesRulesetsSetCacheTagsRuleRatelimit) UnmarshalJSON added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRule added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRule 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 RulesetUpdateResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleAction `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters RulesetUpdateResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleActionParameters `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 RulesetUpdateResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleExposedCredentialCheck `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 RulesetUpdateResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                                                                        `json:"ref"`
	JSON rulesetUpdateResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleJSON `json:"-"`
}

func (*RulesetUpdateResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRule) UnmarshalJSON added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleAction added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleAction string

The action to perform when the rule matches.

const (
	RulesetUpdateResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleActionTransformResponseHTML RulesetUpdateResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleAction = "transform_response_html"
)

func (RulesetUpdateResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleAction) IsKnown added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleActionParameters added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleActionParameters struct {
	// Enables the link maze transformation on the response.
	LinkMaze interface{}                                                                                   `json:"link_maze" api:"required"`
	JSON     rulesetUpdateResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleActionParametersJSON `json:"-"`
}

The parameters configuring the rule's action.

func (*RulesetUpdateResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleActionParameters) UnmarshalJSON added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleExposedCredentialCheck added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleExposedCredentialCheck 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               rulesetUpdateResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*RulesetUpdateResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleExposedCredentialCheck) UnmarshalJSON added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleRatelimit added in v7.9.0

type RulesetUpdateResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleRatelimit 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                    rulesetUpdateResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*RulesetUpdateResponseEnvelopeResultRulesRulesetsTransformResponseHTMLRuleRatelimit) UnmarshalJSON added in v7.9.0

type RulesetUpdateResponseEnvelopeSuccess

type RulesetUpdateResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	RulesetUpdateResponseEnvelopeSuccessTrue RulesetUpdateResponseEnvelopeSuccess = true
)

func (RulesetUpdateResponseEnvelopeSuccess) IsKnown

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

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

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

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

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

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

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"`
	// Controls whether Cloudflare fetches a large asset from the origin as a series of
	// range requests instead of one whole-body request.
	OriginRangeRequests SetCacheSettingsRuleActionParametersOriginRangeRequests `json:"origin_range_requests"`
	// 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"`
	// Controls how cached responses vary based on request headers. `default` is
	// required by the API and applies to any Vary response header that does not have a
	// per-header override.
	Vary SetCacheSettingsRuleActionParametersVary `json:"vary"`
	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

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

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

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

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

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

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

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

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

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

type SetCacheSettingsRuleActionParametersCacheKeyCustomKeyQueryStringExcludeAll

type SetCacheSettingsRuleActionParametersCacheKeyCustomKeyQueryStringExcludeAll bool

Whether to exclude all query string parameters from the cache key.

const (
	SetCacheSettingsRuleActionParametersCacheKeyCustomKeyQueryStringExcludeAllTrue SetCacheSettingsRuleActionParametersCacheKeyCustomKeyQueryStringExcludeAll = true
)

func (SetCacheSettingsRuleActionParametersCacheKeyCustomKeyQueryStringExcludeAll) IsKnown

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

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

type SetCacheSettingsRuleActionParametersCacheKeyCustomKeyQueryStringIncludeAll

type SetCacheSettingsRuleActionParametersCacheKeyCustomKeyQueryStringIncludeAll bool

Whether to include all query string parameters in the cache key.

const (
	SetCacheSettingsRuleActionParametersCacheKeyCustomKeyQueryStringIncludeAllTrue SetCacheSettingsRuleActionParametersCacheKeyCustomKeyQueryStringIncludeAll = true
)

func (SetCacheSettingsRuleActionParametersCacheKeyCustomKeyQueryStringIncludeAll) IsKnown

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

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

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

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

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

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

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

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

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

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

type SetCacheSettingsRuleActionParametersOriginRangeRequests added in v7.10.0

type SetCacheSettingsRuleActionParametersOriginRangeRequests struct {
	// Whether to use range requests. `default` is the behaviour the zone gets without
	// this rule.
	Mode SetCacheSettingsRuleActionParametersOriginRangeRequestsMode `json:"mode" api:"required"`
	JSON setCacheSettingsRuleActionParametersOriginRangeRequestsJSON `json:"-"`
}

Controls whether Cloudflare fetches a large asset from the origin as a series of range requests instead of one whole-body request.

func (*SetCacheSettingsRuleActionParametersOriginRangeRequests) UnmarshalJSON added in v7.10.0

type SetCacheSettingsRuleActionParametersOriginRangeRequestsMode added in v7.10.0

type SetCacheSettingsRuleActionParametersOriginRangeRequestsMode string

Whether to use range requests. `default` is the behaviour the zone gets without this rule.

const (
	SetCacheSettingsRuleActionParametersOriginRangeRequestsModeOn      SetCacheSettingsRuleActionParametersOriginRangeRequestsMode = "on"
	SetCacheSettingsRuleActionParametersOriginRangeRequestsModeOff     SetCacheSettingsRuleActionParametersOriginRangeRequestsMode = "off"
	SetCacheSettingsRuleActionParametersOriginRangeRequestsModeDefault SetCacheSettingsRuleActionParametersOriginRangeRequestsMode = "default"
)

func (SetCacheSettingsRuleActionParametersOriginRangeRequestsMode) IsKnown added in v7.10.0

type SetCacheSettingsRuleActionParametersOriginRangeRequestsParam added in v7.10.0

type SetCacheSettingsRuleActionParametersOriginRangeRequestsParam struct {
	// Whether to use range requests. `default` is the behaviour the zone gets without
	// this rule.
	Mode param.Field[SetCacheSettingsRuleActionParametersOriginRangeRequestsMode] `json:"mode" api:"required"`
}

Controls whether Cloudflare fetches a large asset from the origin as a series of range requests instead of one whole-body request.

func (SetCacheSettingsRuleActionParametersOriginRangeRequestsParam) MarshalJSON added in v7.10.0

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"`
	// Controls whether Cloudflare fetches a large asset from the origin as a series of
	// range requests instead of one whole-body request.
	OriginRangeRequests param.Field[SetCacheSettingsRuleActionParametersOriginRangeRequestsParam] `json:"origin_range_requests"`
	// 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"`
	// Controls how cached responses vary based on request headers. `default` is
	// required by the API and applies to any Vary response header that does not have a
	// per-header override.
	Vary param.Field[SetCacheSettingsRuleActionParametersVaryParam] `json:"vary"`
}

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

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

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

type SetCacheSettingsRuleActionParametersSharedDictionaryParam

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

type SetCacheSettingsRuleActionParametersVary added in v7.7.0

type SetCacheSettingsRuleActionParametersVary struct {
	// Controls how response Vary headers without a per-header override contribute to
	// the cache key.
	Default SetCacheSettingsRuleActionParametersVaryDefault `json:"default"`
	// A mapping of lowercase request header names to their vary configuration.
	Headers map[string]SetCacheSettingsRuleActionParametersVaryHeader `json:"headers"`
	JSON    setCacheSettingsRuleActionParametersVaryJSON              `json:"-"`
}

Controls how cached responses vary based on request headers. `default` is required by the API and applies to any Vary response header that does not have a per-header override.

func (*SetCacheSettingsRuleActionParametersVary) UnmarshalJSON added in v7.7.0

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

type SetCacheSettingsRuleActionParametersVaryDefault added in v7.7.0

type SetCacheSettingsRuleActionParametersVaryDefault struct {
	// How the header value is treated when building the cache key.
	Action SetCacheSettingsRuleActionParametersVaryDefaultAction `json:"action" api:"required"`
	JSON   setCacheSettingsRuleActionParametersVaryDefaultJSON   `json:"-"`
}

Controls how response Vary headers without a per-header override contribute to the cache key.

func (*SetCacheSettingsRuleActionParametersVaryDefault) UnmarshalJSON added in v7.7.0

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

type SetCacheSettingsRuleActionParametersVaryDefaultAction added in v7.7.0

type SetCacheSettingsRuleActionParametersVaryDefaultAction string

How the header value is treated when building the cache key.

const (
	SetCacheSettingsRuleActionParametersVaryDefaultActionBypass      SetCacheSettingsRuleActionParametersVaryDefaultAction = "bypass"
	SetCacheSettingsRuleActionParametersVaryDefaultActionPassthrough SetCacheSettingsRuleActionParametersVaryDefaultAction = "passthrough"
	SetCacheSettingsRuleActionParametersVaryDefaultActionNormalize   SetCacheSettingsRuleActionParametersVaryDefaultAction = "normalize"
)

func (SetCacheSettingsRuleActionParametersVaryDefaultAction) IsKnown added in v7.7.0

type SetCacheSettingsRuleActionParametersVaryDefaultParam added in v7.7.0

type SetCacheSettingsRuleActionParametersVaryDefaultParam struct {
	// How the header value is treated when building the cache key.
	Action param.Field[SetCacheSettingsRuleActionParametersVaryDefaultAction] `json:"action" api:"required"`
}

Controls how response Vary headers without a per-header override contribute to the cache key.

func (SetCacheSettingsRuleActionParametersVaryDefaultParam) MarshalJSON added in v7.7.0

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

type SetCacheSettingsRuleActionParametersVaryHeader added in v7.7.0

type SetCacheSettingsRuleActionParametersVaryHeader struct {
	// How the header value is treated when building the cache key.
	Action SetCacheSettingsRuleActionParametersVaryHeadersAction `json:"action" api:"required"`
	// The set of languages to normalize against. Only valid for the `accept-language`
	// header.
	Languages []string `json:"languages"`
	// The set of media types to normalize against. Only valid for the `accept` header.
	MediaTypes []string                                           `json:"media_types"`
	JSON       setCacheSettingsRuleActionParametersVaryHeaderJSON `json:"-"`
}

Controls how a single request header contributes to the cache key.

func (*SetCacheSettingsRuleActionParametersVaryHeader) UnmarshalJSON added in v7.7.0

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

type SetCacheSettingsRuleActionParametersVaryHeaderParam added in v7.7.0

type SetCacheSettingsRuleActionParametersVaryHeaderParam struct {
	// How the header value is treated when building the cache key.
	Action param.Field[SetCacheSettingsRuleActionParametersVaryHeadersAction] `json:"action" api:"required"`
	// The set of languages to normalize against. Only valid for the `accept-language`
	// header.
	Languages param.Field[[]string] `json:"languages"`
	// The set of media types to normalize against. Only valid for the `accept` header.
	MediaTypes param.Field[[]string] `json:"media_types"`
}

Controls how a single request header contributes to the cache key.

func (SetCacheSettingsRuleActionParametersVaryHeaderParam) MarshalJSON added in v7.7.0

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

type SetCacheSettingsRuleActionParametersVaryHeadersAction added in v7.7.0

type SetCacheSettingsRuleActionParametersVaryHeadersAction string

How the header value is treated when building the cache key.

const (
	SetCacheSettingsRuleActionParametersVaryHeadersActionBypass      SetCacheSettingsRuleActionParametersVaryHeadersAction = "bypass"
	SetCacheSettingsRuleActionParametersVaryHeadersActionPassthrough SetCacheSettingsRuleActionParametersVaryHeadersAction = "passthrough"
	SetCacheSettingsRuleActionParametersVaryHeadersActionNormalize   SetCacheSettingsRuleActionParametersVaryHeadersAction = "normalize"
)

func (SetCacheSettingsRuleActionParametersVaryHeadersAction) IsKnown added in v7.7.0

type SetCacheSettingsRuleActionParametersVaryParam added in v7.7.0

type SetCacheSettingsRuleActionParametersVaryParam struct {
	// Controls how response Vary headers without a per-header override contribute to
	// the cache key.
	Default param.Field[SetCacheSettingsRuleActionParametersVaryDefaultParam] `json:"default"`
	// A mapping of lowercase request header names to their vary configuration.
	Headers param.Field[map[string]SetCacheSettingsRuleActionParametersVaryHeaderParam] `json:"headers"`
}

Controls how cached responses vary based on request headers. `default` is required by the API and applies to any Vary response header that does not have a per-header override.

func (SetCacheSettingsRuleActionParametersVaryParam) MarshalJSON added in v7.7.0

func (r SetCacheSettingsRuleActionParametersVaryParam) 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).
	//
	// Deprecated: Signed Exchanges (SXG) is deprecated.
	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

type SetConfigRuleActionParametersDisablePayPerCrawl

type SetConfigRuleActionParametersDisablePayPerCrawl bool

Whether to disable Pay Per Crawl.

const (
	SetConfigRuleActionParametersDisablePayPerCrawlTrue SetConfigRuleActionParametersDisablePayPerCrawl = true
)

func (SetConfigRuleActionParametersDisablePayPerCrawl) IsKnown

type SetConfigRuleActionParametersDisableRUM

type SetConfigRuleActionParametersDisableRUM bool

Whether to disable Real User Monitoring (RUM).

const (
	SetConfigRuleActionParametersDisableRUMTrue SetConfigRuleActionParametersDisableRUM = true
)

func (SetConfigRuleActionParametersDisableRUM) IsKnown

type SetConfigRuleActionParametersDisableZaraz

type SetConfigRuleActionParametersDisableZaraz bool

Whether to disable Zaraz.

const (
	SetConfigRuleActionParametersDisableZarazTrue SetConfigRuleActionParametersDisableZaraz = true
)

func (SetConfigRuleActionParametersDisableZaraz) IsKnown

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).
	//
	// Deprecated: Signed Exchanges (SXG) is deprecated.
	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

type SetConfigRuleActionParametersRequestBodyBuffering

type SetConfigRuleActionParametersRequestBodyBuffering string

The request body buffering mode.

const (
	SetConfigRuleActionParametersRequestBodyBufferingNone     SetConfigRuleActionParametersRequestBodyBuffering = "none"
	SetConfigRuleActionParametersRequestBodyBufferingStandard SetConfigRuleActionParametersRequestBodyBuffering = "standard"
	SetConfigRuleActionParametersRequestBodyBufferingFull     SetConfigRuleActionParametersRequestBodyBuffering = "full"
)

func (SetConfigRuleActionParametersRequestBodyBuffering) IsKnown

type SetConfigRuleActionParametersResponseBodyBuffering

type SetConfigRuleActionParametersResponseBodyBuffering string

The response body buffering mode.

const (
	SetConfigRuleActionParametersResponseBodyBufferingNone     SetConfigRuleActionParametersResponseBodyBuffering = "none"
	SetConfigRuleActionParametersResponseBodyBufferingStandard SetConfigRuleActionParametersResponseBodyBuffering = "standard"
)

func (SetConfigRuleActionParametersResponseBodyBuffering) IsKnown

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

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

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

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

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"`
	// Validates the request without persisting changes when set to `true`. Responses
	// that normally return 200 return `result: null`; endpoints that normally return
	// 204 continue to return 204.
	DryRun param.Field[bool] `query:"dry_run"`
}

func (VersionDeleteParams) URLQuery added in v7.9.0

func (r VersionDeleteParams) URLQuery() (v url.Values)

URLQuery serializes VersionDeleteParams's query parameters as `url.Values`.

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

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],
	// [VersionGetResponseRulesRulesetsTransformResponseHTMLRuleActionParameters].
	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],
	// [VersionGetResponseRulesRulesetsTransformResponseHTMLRuleExposedCredentialCheck].
	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],
	// [VersionGetResponseRulesRulesetsTransformResponseHTMLRuleRatelimit].
	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) 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"
	VersionGetResponseRulesActionTransformResponseHTML VersionGetResponseRulesAction = "transform_response_html"
)

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

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

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

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

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

type VersionGetResponseRulesRulesetsSetCacheControlRule

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

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

type VersionGetResponseRulesRulesetsSetCacheControlRuleAction

type VersionGetResponseRulesRulesetsSetCacheControlRuleAction string

The action to perform when the rule matches.

const (
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionSetCacheControl VersionGetResponseRulesRulesetsSetCacheControlRuleAction = "set_cache_control"
)

func (VersionGetResponseRulesRulesetsSetCacheControlRuleAction) IsKnown

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParameters

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

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutable

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) UnmarshalJSON

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation string

The operation to perform on the cache-control directive.

const (
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperationSet    VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation = "set"
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperationRemove VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation = "remove"
)

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableOperation) IsKnown

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective

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

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperationSet    VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation = "set"
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperationRemove VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation = "remove"
)

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirectiveOperation) IsKnown

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective

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

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperationSet    VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation = "set"
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperationRemove VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation = "remove"
)

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirectiveOperation) IsKnown

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableUnion

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

A cache-control directive configuration.

Union satisfied by VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableSetDirective or VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersImmutableRemoveDirective.

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAge

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) UnmarshalJSON

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation string

The operation to perform on the cache-control directive.

const (
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperationSet    VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation = "set"
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperationRemove VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation = "remove"
)

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeOperation) IsKnown

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirective

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

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperationSet    VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation = "set"
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperationRemove VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation = "remove"
)

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeRemoveDirectiveOperation) IsKnown

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirective

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

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperationSet    VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation = "set"
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperationRemove VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation = "remove"
)

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeSetDirectiveOperation) IsKnown

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMaxAgeUnion

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

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) UnmarshalJSON

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation string

The operation to perform on the cache-control directive.

const (
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperationSet    VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation = "set"
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperationRemove VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation = "remove"
)

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateOperation) IsKnown

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective

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

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperationSet    VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation = "set"
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperationRemove VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation = "remove"
)

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirectiveOperation) IsKnown

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective

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

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperationSet    VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation = "set"
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperationRemove VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation = "remove"
)

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirectiveOperation) IsKnown

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateUnion

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

A cache-control directive configuration.

Union satisfied by VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateSetDirective or VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustRevalidateRemoveDirective.

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstand

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) UnmarshalJSON

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation string

The operation to perform on the cache-control directive.

const (
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperationSet    VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation = "set"
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperationRemove VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation = "remove"
)

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandOperation) IsKnown

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective

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

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperationSet    VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation = "set"
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperationRemove VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation = "remove"
)

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirectiveOperation) IsKnown

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective

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

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperationSet    VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation = "set"
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperationRemove VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation = "remove"
)

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirectiveOperation) IsKnown

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandUnion

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

A cache-control directive configuration.

Union satisfied by VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandSetDirective or VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersMustUnderstandRemoveDirective.

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCache

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) UnmarshalJSON

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation string

The operation to perform on the cache-control directive.

const (
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperationSet    VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation = "set"
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperationRemove VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation = "remove"
)

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheOperation) IsKnown

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirective

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

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperationSet    VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation = "set"
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperationRemove VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation = "remove"
)

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheRemoveDirectiveOperation) IsKnown

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirective

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

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperationSet    VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation = "set"
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperationRemove VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation = "remove"
)

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheSetDirectiveOperation) IsKnown

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoCacheUnion

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

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) UnmarshalJSON

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation string

The operation to perform on the cache-control directive.

const (
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperationSet    VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation = "set"
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperationRemove VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation = "remove"
)

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreOperation) IsKnown

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective

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

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperationSet    VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation = "set"
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperationRemove VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation = "remove"
)

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirectiveOperation) IsKnown

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective

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

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperationSet    VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation = "set"
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperationRemove VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation = "remove"
)

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirectiveOperation) IsKnown

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreUnion

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

A cache-control directive configuration.

Union satisfied by VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreSetDirective or VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoStoreRemoveDirective.

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransform

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) UnmarshalJSON

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation string

The operation to perform on the cache-control directive.

const (
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperationSet    VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation = "set"
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperationRemove VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation = "remove"
)

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformOperation) IsKnown

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective

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

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperationSet    VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation = "set"
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperationRemove VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation = "remove"
)

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirectiveOperation) IsKnown

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective

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

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperationSet    VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation = "set"
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperationRemove VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation = "remove"
)

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirectiveOperation) IsKnown

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformUnion

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

A cache-control directive configuration.

Union satisfied by VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformSetDirective or VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersNoTransformRemoveDirective.

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivate

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) UnmarshalJSON

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation string

The operation to perform on the cache-control directive.

const (
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperationSet    VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation = "set"
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperationRemove VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation = "remove"
)

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateOperation) IsKnown

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirective

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

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperationSet    VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation = "set"
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperationRemove VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation = "remove"
)

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateRemoveDirectiveOperation) IsKnown

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirective

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

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperationSet    VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation = "set"
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperationRemove VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation = "remove"
)

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateSetDirectiveOperation) IsKnown

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPrivateUnion

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

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) UnmarshalJSON

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation string

The operation to perform on the cache-control directive.

const (
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperationSet    VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation = "set"
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperationRemove VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation = "remove"
)

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateOperation) IsKnown

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective

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

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperationSet    VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation = "set"
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperationRemove VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation = "remove"
)

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirectiveOperation) IsKnown

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective

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

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperationSet    VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation = "set"
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperationRemove VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation = "remove"
)

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirectiveOperation) IsKnown

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateUnion

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

A cache-control directive configuration.

Union satisfied by VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateSetDirective or VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersProxyRevalidateRemoveDirective.

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublic

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) UnmarshalJSON

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation string

The operation to perform on the cache-control directive.

const (
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperationSet    VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation = "set"
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperationRemove VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation = "remove"
)

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicOperation) IsKnown

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective

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

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperationSet    VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation = "set"
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperationRemove VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation = "remove"
)

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirectiveOperation) IsKnown

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective

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

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperationSet    VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation = "set"
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperationRemove VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation = "remove"
)

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirectiveOperation) IsKnown

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicUnion

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

A cache-control directive configuration.

Union satisfied by VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicSetDirective or VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersPublicRemoveDirective.

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxage

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) UnmarshalJSON

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation string

The operation to perform on the cache-control directive.

const (
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperationSet    VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation = "set"
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperationRemove VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation = "remove"
)

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageOperation) IsKnown

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirective

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

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperationSet    VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation = "set"
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperationRemove VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation = "remove"
)

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageRemoveDirectiveOperation) IsKnown

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirective

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

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperationSet    VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation = "set"
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperationRemove VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation = "remove"
)

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageSetDirectiveOperation) IsKnown

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersSMaxageUnion

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

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) UnmarshalJSON

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation string

The operation to perform on the cache-control directive.

const (
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperationSet    VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation = "set"
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperationRemove VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation = "remove"
)

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorOperation) IsKnown

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirective

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

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperationSet    VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation = "set"
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperationRemove VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation = "remove"
)

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorRemoveDirectiveOperation) IsKnown

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirective

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

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperationSet    VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation = "set"
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperationRemove VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation = "remove"
)

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorSetDirectiveOperation) IsKnown

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleIfErrorUnion

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

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) UnmarshalJSON

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation string

The operation to perform on the cache-control directive.

const (
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperationSet    VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation = "set"
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperationRemove VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation = "remove"
)

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateOperation) IsKnown

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirective

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

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperationSet    VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation = "set"
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperationRemove VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation = "remove"
)

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateRemoveDirectiveOperation) IsKnown

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirective

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

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation string

The operation to perform on the cache-control directive.

const (
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperationSet    VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation = "set"
	VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperationRemove VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation = "remove"
)

func (VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateSetDirectiveOperation) IsKnown

type VersionGetResponseRulesRulesetsSetCacheControlRuleActionParametersStaleWhileRevalidateUnion

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

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

type VersionGetResponseRulesRulesetsSetCacheControlRuleRatelimit

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

type VersionGetResponseRulesRulesetsSetCacheTagsRule

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

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

type VersionGetResponseRulesRulesetsSetCacheTagsRuleAction

type VersionGetResponseRulesRulesetsSetCacheTagsRuleAction string

The action to perform when the rule matches.

const (
	VersionGetResponseRulesRulesetsSetCacheTagsRuleActionSetCacheTags VersionGetResponseRulesRulesetsSetCacheTagsRuleAction = "set_cache_tags"
)

func (VersionGetResponseRulesRulesetsSetCacheTagsRuleAction) IsKnown

type VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParameters

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) UnmarshalJSON

type VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpression

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

type VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation

type VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation string

The operation to perform on the cache tags.

const (
	VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationAdd    VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "add"
	VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationRemove VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "remove"
	VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperationSet    VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation = "set"
)

func (VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsExpressionOperation) IsKnown

type VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValues

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

type VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation

type VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation string

The operation to perform on the cache tags.

const (
	VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationAdd    VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "add"
	VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationRemove VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "remove"
	VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperationSet    VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation = "set"
)

func (VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersAddCacheTagsValuesOperation) IsKnown

type VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation

type VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation string

The operation to perform on the cache tags.

const (
	VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersOperationAdd    VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation = "add"
	VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersOperationRemove VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation = "remove"
	VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersOperationSet    VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation = "set"
)

func (VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersOperation) IsKnown

type VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpression

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

type VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation

type VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation string

The operation to perform on the cache tags.

const (
	VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationAdd    VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "add"
	VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationRemove VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "remove"
	VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperationSet    VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation = "set"
)

func (VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsExpressionOperation) IsKnown

type VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValues

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

type VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation

type VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation string

The operation to perform on the cache tags.

const (
	VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationAdd    VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "add"
	VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationRemove VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "remove"
	VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperationSet    VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation = "set"
)

func (VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersRemoveCacheTagsValuesOperation) IsKnown

type VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpression

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

type VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation

type VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation string

The operation to perform on the cache tags.

const (
	VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationAdd    VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "add"
	VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationRemove VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "remove"
	VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperationSet    VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation = "set"
)

func (VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsExpressionOperation) IsKnown

type VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValues

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

type VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation

type VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation string

The operation to perform on the cache tags.

const (
	VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationAdd    VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "add"
	VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationRemove VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "remove"
	VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperationSet    VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation = "set"
)

func (VersionGetResponseRulesRulesetsSetCacheTagsRuleActionParametersSetCacheTagsValuesOperation) IsKnown

type VersionGetResponseRulesRulesetsSetCacheTagsRuleExposedCredentialCheck

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

type VersionGetResponseRulesRulesetsSetCacheTagsRuleRatelimit

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

type VersionGetResponseRulesRulesetsTransformResponseHTMLRule added in v7.7.0

type VersionGetResponseRulesRulesetsTransformResponseHTMLRule 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 VersionGetResponseRulesRulesetsTransformResponseHTMLRuleAction `json:"action"`
	// The parameters configuring the rule's action.
	ActionParameters VersionGetResponseRulesRulesetsTransformResponseHTMLRuleActionParameters `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 VersionGetResponseRulesRulesetsTransformResponseHTMLRuleExposedCredentialCheck `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 VersionGetResponseRulesRulesetsTransformResponseHTMLRuleRatelimit `json:"ratelimit"`
	// The reference of the rule (the rule's ID by default).
	Ref  string                                                       `json:"ref"`
	JSON versionGetResponseRulesRulesetsTransformResponseHTMLRuleJSON `json:"-"`
}

func (*VersionGetResponseRulesRulesetsTransformResponseHTMLRule) UnmarshalJSON added in v7.7.0

type VersionGetResponseRulesRulesetsTransformResponseHTMLRuleAction added in v7.7.0

type VersionGetResponseRulesRulesetsTransformResponseHTMLRuleAction string

The action to perform when the rule matches.

const (
	VersionGetResponseRulesRulesetsTransformResponseHTMLRuleActionTransformResponseHTML VersionGetResponseRulesRulesetsTransformResponseHTMLRuleAction = "transform_response_html"
)

func (VersionGetResponseRulesRulesetsTransformResponseHTMLRuleAction) IsKnown added in v7.7.0

type VersionGetResponseRulesRulesetsTransformResponseHTMLRuleActionParameters added in v7.7.0

type VersionGetResponseRulesRulesetsTransformResponseHTMLRuleActionParameters struct {
	// Enables the link maze transformation on the response.
	LinkMaze interface{}                                                                  `json:"link_maze" api:"required"`
	JSON     versionGetResponseRulesRulesetsTransformResponseHTMLRuleActionParametersJSON `json:"-"`
}

The parameters configuring the rule's action.

func (*VersionGetResponseRulesRulesetsTransformResponseHTMLRuleActionParameters) UnmarshalJSON added in v7.7.0

type VersionGetResponseRulesRulesetsTransformResponseHTMLRuleExposedCredentialCheck added in v7.7.0

type VersionGetResponseRulesRulesetsTransformResponseHTMLRuleExposedCredentialCheck 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               versionGetResponseRulesRulesetsTransformResponseHTMLRuleExposedCredentialCheckJSON `json:"-"`
}

Configuration for exposed credential checking.

func (*VersionGetResponseRulesRulesetsTransformResponseHTMLRuleExposedCredentialCheck) UnmarshalJSON added in v7.7.0

type VersionGetResponseRulesRulesetsTransformResponseHTMLRuleRatelimit added in v7.7.0

type VersionGetResponseRulesRulesetsTransformResponseHTMLRuleRatelimit 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                    versionGetResponseRulesRulesetsTransformResponseHTMLRuleRatelimitJSON `json:"-"`
}

An object configuring the rule's rate limit behavior.

func (*VersionGetResponseRulesRulesetsTransformResponseHTMLRuleRatelimit) UnmarshalJSON added in v7.7.0

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, params 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

Fetches the versions of an account or zone ruleset.

func (*VersionService) ListAutoPaging

Fetches the versions of an account or zone ruleset.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL