cache

package
v3.0.1 Latest Latest
Warning

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

 Go to latest Published: Sep 23, 2024 License: Apache-2.0 Imports: 11 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 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 CloudflareTunnelTunTypeWARPConnector = shared.CloudflareTunnelTunTypeWARPConnector

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

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 CachePurgeParams 

type CachePurgeParams struct {
	ZoneID param.Field[string]       `path:"zone_id,required"`
	Body   CachePurgeParamsBodyUnion `json:"body,required"`
}

func (CachePurgeParams) MarshalJSON 

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

type CachePurgeParamsBody 

type CachePurgeParamsBody struct {
	Tags     param.Field[interface{}] `json:"tags,required"`
	Hosts    param.Field[interface{}] `json:"hosts,required"`
	Prefixes param.Field[interface{}] `json:"prefixes,required"`
	// For more information, please refer to
	// [purge everything documentation page](https://developers.cloudflare.com/cache/how-to/purge-cache/purge-everything/).
	PurgeEverything param.Field[bool]        `json:"purge_everything"`
	Files           param.Field[interface{}] `json:"files,required"`
}

func (CachePurgeParamsBody) MarshalJSON 

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

type CachePurgeParamsBodyCachePurgeEverything 

type CachePurgeParamsBodyCachePurgeEverything struct {
	// For more information, please refer to
	// [purge everything documentation page](https://developers.cloudflare.com/cache/how-to/purge-cache/purge-everything/).
	PurgeEverything param.Field[bool] `json:"purge_everything"`
}

func (CachePurgeParamsBodyCachePurgeEverything) MarshalJSON 

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

type CachePurgeParamsBodyCachePurgeFlexPurgeByHostnames 

type CachePurgeParamsBodyCachePurgeFlexPurgeByHostnames struct {
	// For more information purging by hostnames, please refer to
	// [purge by hostname documentation page](https://developers.cloudflare.com/cache/how-to/purge-cache/purge-by-hostname/).
	Hosts param.Field[[]string] `json:"hosts"`
}

func (CachePurgeParamsBodyCachePurgeFlexPurgeByHostnames) MarshalJSON 

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

type CachePurgeParamsBodyCachePurgeFlexPurgeByPrefixes 

type CachePurgeParamsBodyCachePurgeFlexPurgeByPrefixes struct {
	// For more information on purging by prefixes, please refer to
	// [purge by prefix documentation page](https://developers.cloudflare.com/cache/how-to/purge-cache/purge_by_prefix/).
	Prefixes param.Field[[]string] `json:"prefixes"`
}

func (CachePurgeParamsBodyCachePurgeFlexPurgeByPrefixes) MarshalJSON 

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

type CachePurgeParamsBodyCachePurgeFlexPurgeByTags 

type CachePurgeParamsBodyCachePurgeFlexPurgeByTags struct {
	// For more information on cache tags and purging by tags, please refer to
	// [purge by cache-tags documentation page](https://developers.cloudflare.com/cache/how-to/purge-cache/purge-by-tags/#purge-cache-by-cache-tags-enterprise-only).
	Tags param.Field[[]string] `json:"tags"`
}

func (CachePurgeParamsBodyCachePurgeFlexPurgeByTags) MarshalJSON 

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

type CachePurgeParamsBodyCachePurgeSingleFile 

type CachePurgeParamsBodyCachePurgeSingleFile struct {
	// For more information on purging files, please refer to
	// [purge by single-file documentation page](https://developers.cloudflare.com/cache/how-to/purge-cache/purge-by-single-file/).
	Files param.Field[[]string] `json:"files"`
}

func (CachePurgeParamsBodyCachePurgeSingleFile) MarshalJSON 

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

type CachePurgeParamsBodyCachePurgeSingleFileWithURLAndHeaders 

type CachePurgeParamsBodyCachePurgeSingleFileWithURLAndHeaders struct {
	// For more information on purging files with URL and headers, please refer to
	// [purge by single-file documentation page](https://developers.cloudflare.com/cache/how-to/purge-cache/purge-by-single-file/).
	Files param.Field[[]CachePurgeParamsBodyCachePurgeSingleFileWithURLAndHeadersFile] `json:"files"`
}

func (CachePurgeParamsBodyCachePurgeSingleFileWithURLAndHeaders) MarshalJSON 

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

type CachePurgeParamsBodyCachePurgeSingleFileWithURLAndHeadersFile 

type CachePurgeParamsBodyCachePurgeSingleFileWithURLAndHeadersFile struct {
	Headers param.Field[interface{}] `json:"headers"`
	URL     param.Field[string]      `json:"url"`
}

func (CachePurgeParamsBodyCachePurgeSingleFileWithURLAndHeadersFile) MarshalJSON 

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

type CachePurgeParamsBodyUnion 

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

Satisfied by cache.CachePurgeParamsBodyCachePurgeFlexPurgeByTags, cache.CachePurgeParamsBodyCachePurgeFlexPurgeByHostnames, cache.CachePurgeParamsBodyCachePurgeFlexPurgeByPrefixes, cache.CachePurgeParamsBodyCachePurgeEverything, cache.CachePurgeParamsBodyCachePurgeSingleFile, cache.CachePurgeParamsBodyCachePurgeSingleFileWithURLAndHeaders, CachePurgeParamsBody.

type CachePurgeResponse 

type CachePurgeResponse struct {
	// Identifier
	ID   string                 `json:"id,required"`
	JSON cachePurgeResponseJSON `json:"-"`
}

func (*CachePurgeResponse) UnmarshalJSON 

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

type CachePurgeResponseEnvelope 

type CachePurgeResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Whether the API call was successful
	Success CachePurgeResponseEnvelopeSuccess `json:"success,required"`
	Result  CachePurgeResponse                `json:"result,nullable"`
	JSON    cachePurgeResponseEnvelopeJSON    `json:"-"`
}

func (*CachePurgeResponseEnvelope) UnmarshalJSON 

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

type CachePurgeResponseEnvelopeSuccess 

type CachePurgeResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	CachePurgeResponseEnvelopeSuccessTrue CachePurgeResponseEnvelopeSuccess = true
)

func (CachePurgeResponseEnvelopeSuccess) IsKnown 

func (r CachePurgeResponseEnvelopeSuccess) IsKnown() bool

type CacheReserve 

type CacheReserve string

ID of the zone setting. 

const (
	CacheReserveCacheReserve CacheReserve = "cache_reserve"
)

func (CacheReserve) IsKnown 

func (r CacheReserve) IsKnown() bool

type CacheReserveClear 

type CacheReserveClear string

ID of the zone setting. 

const (
	CacheReserveClearCacheReserveClear CacheReserveClear = "cache_reserve_clear"
)

func (CacheReserveClear) IsKnown 

func (r CacheReserveClear) IsKnown() bool

type CacheReserveClearParams 

type CacheReserveClearParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	Body   interface{}         `json:"body,required"`
}

func (CacheReserveClearParams) MarshalJSON 

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

type CacheReserveClearResponse 

type CacheReserveClearResponse struct {
	// ID of the zone setting.
	ID CacheReserveClear `json:"id,required"`
	// last time this setting was modified.
	ModifiedOn time.Time `json:"modified_on,required,nullable" format:"date-time"`
	// The time that the latest Cache Reserve Clear operation started.
	StartTs time.Time `json:"start_ts,required" format:"date-time"`
	// The current state of the Cache Reserve Clear operation.
	State State `json:"state,required"`
	// The time that the latest Cache Reserve Clear operation completed.
	EndTs time.Time                     `json:"end_ts" format:"date-time"`
	JSON  cacheReserveClearResponseJSON `json:"-"`
}

You can use Cache Reserve Clear to clear your Cache Reserve, but you must first disable Cache Reserve. In most cases, this will be accomplished within 24 hours. You cannot re-enable Cache Reserve while this process is ongoing. Keep in mind that you cannot undo or cancel this operation.

func (*CacheReserveClearResponse) UnmarshalJSON 

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

type CacheReserveClearResponseEnvelope 

type CacheReserveClearResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// You can use Cache Reserve Clear to clear your Cache Reserve, but you must first
	// disable Cache Reserve. In most cases, this will be accomplished within 24 hours.
	// You cannot re-enable Cache Reserve while this process is ongoing. Keep in mind
	// that you cannot undo or cancel this operation.
	Result CacheReserveClearResponse `json:"result,required"`
	// Whether the API call was successful
	Success CacheReserveClearResponseEnvelopeSuccess `json:"success,required"`
	JSON    cacheReserveClearResponseEnvelopeJSON    `json:"-"`
}

func (*CacheReserveClearResponseEnvelope) UnmarshalJSON 

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

type CacheReserveClearResponseEnvelopeSuccess 

type CacheReserveClearResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	CacheReserveClearResponseEnvelopeSuccessTrue CacheReserveClearResponseEnvelopeSuccess = true
)

func (CacheReserveClearResponseEnvelopeSuccess) IsKnown 

func (r CacheReserveClearResponseEnvelopeSuccess) IsKnown() bool

type CacheReserveEditParams 

type CacheReserveEditParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	// Value of the Cache Reserve zone setting.
	Value param.Field[CacheReserveEditParamsValue] `json:"value,required"`
}

func (CacheReserveEditParams) MarshalJSON 

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

type CacheReserveEditParamsValue 

type CacheReserveEditParamsValue string

Value of the Cache Reserve zone setting. 

const (
	CacheReserveEditParamsValueOn  CacheReserveEditParamsValue = "on"
	CacheReserveEditParamsValueOff CacheReserveEditParamsValue = "off"
)

func (CacheReserveEditParamsValue) IsKnown 

func (r CacheReserveEditParamsValue) IsKnown() bool

type CacheReserveEditResponse 

type CacheReserveEditResponse struct {
	// ID of the zone setting.
	ID CacheReserve `json:"id,required"`
	// last time this setting was modified.
	ModifiedOn time.Time `json:"modified_on,required,nullable" format:"date-time"`
	// Value of the Cache Reserve zone setting.
	Value CacheReserveEditResponseValue `json:"value,required"`
	JSON  cacheReserveEditResponseJSON  `json:"-"`
}

Increase cache lifetimes by automatically storing all cacheable files into Cloudflare's persistent object storage buckets. Requires Cache Reserve subscription. Note: using Tiered Cache with Cache Reserve is highly recommended to reduce Reserve operations costs. See the [developer docs](https://developers.cloudflare.com/cache/about/cache-reserve) for more information.

func (*CacheReserveEditResponse) UnmarshalJSON 

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

type CacheReserveEditResponseEnvelope 

type CacheReserveEditResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Increase cache lifetimes by automatically storing all cacheable files into
	// Cloudflare's persistent object storage buckets. Requires Cache Reserve
	// subscription. Note: using Tiered Cache with Cache Reserve is highly recommended
	// to reduce Reserve operations costs. See the
	// [developer docs](https://developers.cloudflare.com/cache/about/cache-reserve)
	// for more information.
	Result CacheReserveEditResponse `json:"result,required"`
	// Whether the API call was successful
	Success CacheReserveEditResponseEnvelopeSuccess `json:"success,required"`
	JSON    cacheReserveEditResponseEnvelopeJSON    `json:"-"`
}

func (*CacheReserveEditResponseEnvelope) UnmarshalJSON 

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

type CacheReserveEditResponseEnvelopeSuccess 

type CacheReserveEditResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	CacheReserveEditResponseEnvelopeSuccessTrue CacheReserveEditResponseEnvelopeSuccess = true
)

func (CacheReserveEditResponseEnvelopeSuccess) IsKnown 

func (r CacheReserveEditResponseEnvelopeSuccess) IsKnown() bool

type CacheReserveEditResponseValue 

type CacheReserveEditResponseValue string

Value of the Cache Reserve zone setting. 

const (
	CacheReserveEditResponseValueOn  CacheReserveEditResponseValue = "on"
	CacheReserveEditResponseValueOff CacheReserveEditResponseValue = "off"
)

func (CacheReserveEditResponseValue) IsKnown 

func (r CacheReserveEditResponseValue) IsKnown() bool

type CacheReserveGetParams 

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

type CacheReserveGetResponse 

type CacheReserveGetResponse struct {
	// ID of the zone setting.
	ID CacheReserve `json:"id,required"`
	// last time this setting was modified.
	ModifiedOn time.Time `json:"modified_on,required,nullable" format:"date-time"`
	// Value of the Cache Reserve zone setting.
	Value CacheReserveGetResponseValue `json:"value,required"`
	JSON  cacheReserveGetResponseJSON  `json:"-"`
}

Increase cache lifetimes by automatically storing all cacheable files into Cloudflare's persistent object storage buckets. Requires Cache Reserve subscription. Note: using Tiered Cache with Cache Reserve is highly recommended to reduce Reserve operations costs. See the [developer docs](https://developers.cloudflare.com/cache/about/cache-reserve) for more information.

func (*CacheReserveGetResponse) UnmarshalJSON 

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

type CacheReserveGetResponseEnvelope 

type CacheReserveGetResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Increase cache lifetimes by automatically storing all cacheable files into
	// Cloudflare's persistent object storage buckets. Requires Cache Reserve
	// subscription. Note: using Tiered Cache with Cache Reserve is highly recommended
	// to reduce Reserve operations costs. See the
	// [developer docs](https://developers.cloudflare.com/cache/about/cache-reserve)
	// for more information.
	Result CacheReserveGetResponse `json:"result,required"`
	// Whether the API call was successful
	Success CacheReserveGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    cacheReserveGetResponseEnvelopeJSON    `json:"-"`
}

func (*CacheReserveGetResponseEnvelope) UnmarshalJSON 

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

type CacheReserveGetResponseEnvelopeSuccess 

type CacheReserveGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	CacheReserveGetResponseEnvelopeSuccessTrue CacheReserveGetResponseEnvelopeSuccess = true
)

func (CacheReserveGetResponseEnvelopeSuccess) IsKnown 

func (r CacheReserveGetResponseEnvelopeSuccess) IsKnown() bool

type CacheReserveGetResponseValue 

type CacheReserveGetResponseValue string

Value of the Cache Reserve zone setting. 

const (
	CacheReserveGetResponseValueOn  CacheReserveGetResponseValue = "on"
	CacheReserveGetResponseValueOff CacheReserveGetResponseValue = "off"
)

func (CacheReserveGetResponseValue) IsKnown 

func (r CacheReserveGetResponseValue) IsKnown() bool

type CacheReserveService 

type CacheReserveService struct {
	Options []option.RequestOption
}

CacheReserveService 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 NewCacheReserveService method instead.

func NewCacheReserveService 

func NewCacheReserveService(opts ...option.RequestOption) (r *CacheReserveService)

NewCacheReserveService 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 (*CacheReserveService) Clear 

func (r *CacheReserveService) Clear(ctx context.Context, params CacheReserveClearParams, opts ...option.RequestOption) (res *CacheReserveClearResponse, err error)

You can use Cache Reserve Clear to clear your Cache Reserve, but you must first disable Cache Reserve. In most cases, this will be accomplished within 24 hours. You cannot re-enable Cache Reserve while this process is ongoing. Keep in mind that you cannot undo or cancel this operation.

func (*CacheReserveService) Edit 

func (r *CacheReserveService) Edit(ctx context.Context, params CacheReserveEditParams, opts ...option.RequestOption) (res *CacheReserveEditResponse, err error)

Increase cache lifetimes by automatically storing all cacheable files into Cloudflare's persistent object storage buckets. Requires Cache Reserve subscription. Note: using Tiered Cache with Cache Reserve is highly recommended to reduce Reserve operations costs. See the [developer docs](https://developers.cloudflare.com/cache/about/cache-reserve) for more information.

func (*CacheReserveService) Get 

func (r *CacheReserveService) Get(ctx context.Context, query CacheReserveGetParams, opts ...option.RequestOption) (res *CacheReserveGetResponse, err error)

Increase cache lifetimes by automatically storing all cacheable files into Cloudflare's persistent object storage buckets. Requires Cache Reserve subscription. Note: using Tiered Cache with Cache Reserve is highly recommended to reduce Reserve operations costs. See the [developer docs](https://developers.cloudflare.com/cache/about/cache-reserve) for more information.

func (*CacheReserveService) Status 

func (r *CacheReserveService) Status(ctx context.Context, query CacheReserveStatusParams, opts ...option.RequestOption) (res *CacheReserveStatusResponse, err error)

You can use Cache Reserve Clear to clear your Cache Reserve, but you must first disable Cache Reserve. In most cases, this will be accomplished within 24 hours. You cannot re-enable Cache Reserve while this process is ongoing. Keep in mind that you cannot undo or cancel this operation.

type CacheReserveStatusParams 

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

type CacheReserveStatusResponse 

type CacheReserveStatusResponse struct {
	// ID of the zone setting.
	ID CacheReserveClear `json:"id,required"`
	// last time this setting was modified.
	ModifiedOn time.Time `json:"modified_on,required,nullable" format:"date-time"`
	// The time that the latest Cache Reserve Clear operation started.
	StartTs time.Time `json:"start_ts,required" format:"date-time"`
	// The current state of the Cache Reserve Clear operation.
	State State `json:"state,required"`
	// The time that the latest Cache Reserve Clear operation completed.
	EndTs time.Time                      `json:"end_ts" format:"date-time"`
	JSON  cacheReserveStatusResponseJSON `json:"-"`
}

You can use Cache Reserve Clear to clear your Cache Reserve, but you must first disable Cache Reserve. In most cases, this will be accomplished within 24 hours. You cannot re-enable Cache Reserve while this process is ongoing. Keep in mind that you cannot undo or cancel this operation.

func (*CacheReserveStatusResponse) UnmarshalJSON 

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

type CacheReserveStatusResponseEnvelope 

type CacheReserveStatusResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// You can use Cache Reserve Clear to clear your Cache Reserve, but you must first
	// disable Cache Reserve. In most cases, this will be accomplished within 24 hours.
	// You cannot re-enable Cache Reserve while this process is ongoing. Keep in mind
	// that you cannot undo or cancel this operation.
	Result CacheReserveStatusResponse `json:"result,required"`
	// Whether the API call was successful
	Success CacheReserveStatusResponseEnvelopeSuccess `json:"success,required"`
	JSON    cacheReserveStatusResponseEnvelopeJSON    `json:"-"`
}

func (*CacheReserveStatusResponseEnvelope) UnmarshalJSON 

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

type CacheReserveStatusResponseEnvelopeSuccess 

type CacheReserveStatusResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	CacheReserveStatusResponseEnvelopeSuccessTrue CacheReserveStatusResponseEnvelopeSuccess = true
)

func (CacheReserveStatusResponseEnvelopeSuccess) IsKnown 

func (r CacheReserveStatusResponseEnvelopeSuccess) IsKnown() bool

type CacheService 

type CacheService struct {
	Options             []option.RequestOption
	CacheReserve        *CacheReserveService
	SmartTieredCache    *SmartTieredCacheService
	Variants            *VariantService
	RegionalTieredCache *RegionalTieredCacheService
}

CacheService 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 NewCacheService method instead.

func NewCacheService 

func NewCacheService(opts ...option.RequestOption) (r *CacheService)

NewCacheService 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 (*CacheService) Purge 

func (r *CacheService) Purge(ctx context.Context, params CachePurgeParams, opts ...option.RequestOption) (res *CachePurgeResponse, err error)

### Purge All Cached Content

Removes ALL files from Cloudflare's cache. All tiers can purge everything.

``` {"purge_everything": true} ```

### Purge Cached Content by URL

Granularly removes one or more files from Cloudflare's cache by specifying URLs. All tiers can purge by URL.

To purge files with custom cache keys, include the headers used to compute the cache key as in the example. If you have a device type or geo in your cache key, you will need to include the CF-Device-Type or CF-IPCountry headers. If you have lang in your cache key, you will need to include the Accept-Language header.

**NB:** When including the Origin header, be sure to include the **scheme** and **hostname**. The port number can be omitted if it is the default port (80 for http, 443 for https), but must be included otherwise.

**NB:** For Zones on Free/Pro/Business plan, you may purge up to 30 URLs in one API call. For Zones on Enterprise plan, you may purge up to 500 URLs in one API call.

Single file purge example with files:

``` {"files": ["http://www.example.com/css/styles.css", "http://www.example.com/js/index.js"]} ```

Single file purge example with url and header pairs:

``` {"files": [{url: "http://www.example.com/cat_picture.jpg", headers: { "CF-IPCountry": "US", "CF-Device-Type": "desktop", "Accept-Language": "zh-CN" }}, {url: "http://www.example.com/dog_picture.jpg", headers: { "CF-IPCountry": "EU", "CF-Device-Type": "mobile", "Accept-Language": "en-US" }}]} ```

### Purge Cached Content by Tag, Host or Prefix

Granularly removes one or more files from Cloudflare's cache either by specifying the host, the associated Cache-Tag, or a Prefix. Only Enterprise customers are permitted to purge by Tag, Host or Prefix.

**NB:** Cache-Tag, host, and prefix purging each have a rate limit of 30,000 purge API calls in every 24 hour period. You may purge up to 30 tags, hosts, or prefixes in one API call. This rate limit can be raised for customers who need to purge at higher volume.

Flex purge with tags:

``` {"tags": ["a-cache-tag", "another-cache-tag"]} ```

Flex purge with hosts:

``` {"hosts": ["www.example.com", "images.example.com"]} ```

Flex purge with prefixes:

``` {"prefixes": ["www.example.com/foo", "images.example.com/bar/baz"]} ```

type CacheVariant 

type CacheVariant struct {
	// ID of the zone setting.
	ID CacheVariantIdentifier `json:"id,required"`
	// last time this setting was modified.
	ModifiedOn time.Time        `json:"modified_on,required,nullable" format:"date-time"`
	JSON       cacheVariantJSON `json:"-"`
}

Variant support enables caching variants of images with certain file extensions in addition to the original. This only applies when the origin server sends the 'Vary: Accept' response header. If the origin server sends 'Vary: Accept' but does not serve the variant requested, the response will not be cached. This will be indicated with BYPASS cache status in the response headers.

func (*CacheVariant) UnmarshalJSON 

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

type CacheVariantIdentifier 

type CacheVariantIdentifier string

ID of the zone setting. 

const (
	CacheVariantIdentifierVariants CacheVariantIdentifier = "variants"
)

func (CacheVariantIdentifier) IsKnown 

func (r CacheVariantIdentifier) IsKnown() bool

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

type Error = apierror.Error

type ErrorData 

type ErrorData = shared.ErrorData

This is an alias to an internal type.

type MemberParam 

type MemberParam = shared.MemberParam

This is an alias to an internal type.

type MemberRoleParam 

type MemberRoleParam = shared.MemberRoleParam

This is an alias to an internal type.

type MemberRolesPermissionsParam 

type MemberRolesPermissionsParam = shared.MemberRolesPermissionsParam

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 MemberUserParam 

type MemberUserParam = shared.MemberUserParam

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 RatePlan 

type RatePlan = shared.RatePlan

The rate plan applied to the subscription.

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 RegionalTieredCache 

type RegionalTieredCache string

ID of the zone setting. 

const (
	RegionalTieredCacheTcRegional RegionalTieredCache = "tc_regional"
)

func (RegionalTieredCache) IsKnown 

func (r RegionalTieredCache) IsKnown() bool

type RegionalTieredCacheEditParams 

type RegionalTieredCacheEditParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	// Value of the Regional Tiered Cache zone setting.
	Value param.Field[RegionalTieredCacheEditParamsValue] `json:"value,required"`
}

func (RegionalTieredCacheEditParams) MarshalJSON 

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

type RegionalTieredCacheEditParamsValue 

type RegionalTieredCacheEditParamsValue string

Value of the Regional Tiered Cache zone setting. 

const (
	RegionalTieredCacheEditParamsValueOn  RegionalTieredCacheEditParamsValue = "on"
	RegionalTieredCacheEditParamsValueOff RegionalTieredCacheEditParamsValue = "off"
)

func (RegionalTieredCacheEditParamsValue) IsKnown 

func (r RegionalTieredCacheEditParamsValue) IsKnown() bool

type RegionalTieredCacheEditResponse 

type RegionalTieredCacheEditResponse struct {
	// ID of the zone setting.
	ID RegionalTieredCache `json:"id,required"`
	// last time this setting was modified.
	ModifiedOn time.Time `json:"modified_on,required,nullable" format:"date-time"`
	// Instructs Cloudflare to check a regional hub data center on the way to your
	// upper tier. This can help improve performance for smart and custom tiered cache
	// topologies.
	Value RegionalTieredCacheEditResponseValue `json:"value,required"`
	JSON  regionalTieredCacheEditResponseJSON  `json:"-"`
}

Instructs Cloudflare to check a regional hub data center on the way to your upper tier. This can help improve performance for smart and custom tiered cache topologies.

func (*RegionalTieredCacheEditResponse) UnmarshalJSON 

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

type RegionalTieredCacheEditResponseEnvelope 

type RegionalTieredCacheEditResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Instructs Cloudflare to check a regional hub data center on the way to your
	// upper tier. This can help improve performance for smart and custom tiered cache
	// topologies.
	Result RegionalTieredCacheEditResponse `json:"result,required"`
	// Whether the API call was successful
	Success RegionalTieredCacheEditResponseEnvelopeSuccess `json:"success,required"`
	JSON    regionalTieredCacheEditResponseEnvelopeJSON    `json:"-"`
}

func (*RegionalTieredCacheEditResponseEnvelope) UnmarshalJSON 

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

type RegionalTieredCacheEditResponseEnvelopeSuccess 

type RegionalTieredCacheEditResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	RegionalTieredCacheEditResponseEnvelopeSuccessTrue RegionalTieredCacheEditResponseEnvelopeSuccess = true
)

func (RegionalTieredCacheEditResponseEnvelopeSuccess) IsKnown 

func (r RegionalTieredCacheEditResponseEnvelopeSuccess) IsKnown() bool

type RegionalTieredCacheEditResponseValue 

type RegionalTieredCacheEditResponseValue struct {
	// ID of the zone setting.
	ID RegionalTieredCache `json:"id,required"`
	// last time this setting was modified.
	ModifiedOn time.Time                                `json:"modified_on,required,nullable" format:"date-time"`
	JSON       regionalTieredCacheEditResponseValueJSON `json:"-"`
}

Instructs Cloudflare to check a regional hub data center on the way to your upper tier. This can help improve performance for smart and custom tiered cache topologies.

func (*RegionalTieredCacheEditResponseValue) UnmarshalJSON 

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

type RegionalTieredCacheGetParams 

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

type RegionalTieredCacheGetResponse 

type RegionalTieredCacheGetResponse struct {
	// ID of the zone setting.
	ID RegionalTieredCache `json:"id,required"`
	// last time this setting was modified.
	ModifiedOn time.Time `json:"modified_on,required,nullable" format:"date-time"`
	// Instructs Cloudflare to check a regional hub data center on the way to your
	// upper tier. This can help improve performance for smart and custom tiered cache
	// topologies.
	Value RegionalTieredCacheGetResponseValue `json:"value,required"`
	JSON  regionalTieredCacheGetResponseJSON  `json:"-"`
}

Instructs Cloudflare to check a regional hub data center on the way to your upper tier. This can help improve performance for smart and custom tiered cache topologies.

func (*RegionalTieredCacheGetResponse) UnmarshalJSON 

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

type RegionalTieredCacheGetResponseEnvelope 

type RegionalTieredCacheGetResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Instructs Cloudflare to check a regional hub data center on the way to your
	// upper tier. This can help improve performance for smart and custom tiered cache
	// topologies.
	Result RegionalTieredCacheGetResponse `json:"result,required"`
	// Whether the API call was successful
	Success RegionalTieredCacheGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    regionalTieredCacheGetResponseEnvelopeJSON    `json:"-"`
}

func (*RegionalTieredCacheGetResponseEnvelope) UnmarshalJSON 

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

type RegionalTieredCacheGetResponseEnvelopeSuccess 

type RegionalTieredCacheGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	RegionalTieredCacheGetResponseEnvelopeSuccessTrue RegionalTieredCacheGetResponseEnvelopeSuccess = true
)

func (RegionalTieredCacheGetResponseEnvelopeSuccess) IsKnown 

func (r RegionalTieredCacheGetResponseEnvelopeSuccess) IsKnown() bool

type RegionalTieredCacheGetResponseValue 

type RegionalTieredCacheGetResponseValue struct {
	// ID of the zone setting.
	ID RegionalTieredCache `json:"id,required"`
	// last time this setting was modified.
	ModifiedOn time.Time                               `json:"modified_on,required,nullable" format:"date-time"`
	JSON       regionalTieredCacheGetResponseValueJSON `json:"-"`
}

Instructs Cloudflare to check a regional hub data center on the way to your upper tier. This can help improve performance for smart and custom tiered cache topologies.

func (*RegionalTieredCacheGetResponseValue) UnmarshalJSON 

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

type RegionalTieredCacheService 

type RegionalTieredCacheService struct {
	Options []option.RequestOption
}

RegionalTieredCacheService 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 NewRegionalTieredCacheService method instead.

func NewRegionalTieredCacheService 

func NewRegionalTieredCacheService(opts ...option.RequestOption) (r *RegionalTieredCacheService)

NewRegionalTieredCacheService 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 (*RegionalTieredCacheService) Edit 

func (r *RegionalTieredCacheService) Edit(ctx context.Context, params RegionalTieredCacheEditParams, opts ...option.RequestOption) (res *RegionalTieredCacheEditResponse, err error)

Instructs Cloudflare to check a regional hub data center on the way to your upper tier. This can help improve performance for smart and custom tiered cache topologies.

func (*RegionalTieredCacheService) Get 

func (r *RegionalTieredCacheService) Get(ctx context.Context, query RegionalTieredCacheGetParams, opts ...option.RequestOption) (res *RegionalTieredCacheGetResponse, err error)

Instructs Cloudflare to check a regional hub data center on the way to your upper tier. This can help improve performance for smart and custom tiered cache topologies.

type ResponseInfo 

type ResponseInfo = shared.ResponseInfo

This is an alias to an internal type.

type Role 

type Role = shared.Role

This is an alias to an internal type.

type SmartTieredCacheDeleteParams 

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

type SmartTieredCacheDeleteResponse 

type SmartTieredCacheDeleteResponse struct {
	// The identifier of the caching setting
	ID string `json:"id,required"`
	// Whether the setting is editable
	Editable bool `json:"editable,required"`
	// The time when the setting was last modified
	ModifiedOn time.Time `json:"modified_on,required" format:"date-time"`
	// The status of the feature being on / off
	Value SmartTieredCacheDeleteResponseValue `json:"value,required"`
	JSON  smartTieredCacheDeleteResponseJSON  `json:"-"`
}

func (*SmartTieredCacheDeleteResponse) UnmarshalJSON 

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

type SmartTieredCacheDeleteResponseEnvelope 

type SmartTieredCacheDeleteResponseEnvelope struct {
	Errors   []shared.ResponseInfo          `json:"errors,required"`
	Messages []shared.ResponseInfo          `json:"messages,required"`
	Result   SmartTieredCacheDeleteResponse `json:"result,required"`
	// Whether the API call was successful
	Success SmartTieredCacheDeleteResponseEnvelopeSuccess `json:"success,required"`
	JSON    smartTieredCacheDeleteResponseEnvelopeJSON    `json:"-"`
}

func (*SmartTieredCacheDeleteResponseEnvelope) UnmarshalJSON 

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

type SmartTieredCacheDeleteResponseEnvelopeSuccess 

type SmartTieredCacheDeleteResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	SmartTieredCacheDeleteResponseEnvelopeSuccessTrue SmartTieredCacheDeleteResponseEnvelopeSuccess = true
)

func (SmartTieredCacheDeleteResponseEnvelopeSuccess) IsKnown 

func (r SmartTieredCacheDeleteResponseEnvelopeSuccess) IsKnown() bool

type SmartTieredCacheDeleteResponseValue 

type SmartTieredCacheDeleteResponseValue string

The status of the feature being on / off 

const (
	SmartTieredCacheDeleteResponseValueOn  SmartTieredCacheDeleteResponseValue = "on"
	SmartTieredCacheDeleteResponseValueOff SmartTieredCacheDeleteResponseValue = "off"
)

func (SmartTieredCacheDeleteResponseValue) IsKnown 

func (r SmartTieredCacheDeleteResponseValue) IsKnown() bool

type SmartTieredCacheEditParams 

type SmartTieredCacheEditParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	// Enable or disable the Smart Tiered Cache
	Value param.Field[SmartTieredCacheEditParamsValue] `json:"value,required"`
}

func (SmartTieredCacheEditParams) MarshalJSON 

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

type SmartTieredCacheEditParamsValue 

type SmartTieredCacheEditParamsValue string

Enable or disable the Smart Tiered Cache 

const (
	SmartTieredCacheEditParamsValueOn  SmartTieredCacheEditParamsValue = "on"
	SmartTieredCacheEditParamsValueOff SmartTieredCacheEditParamsValue = "off"
)

func (SmartTieredCacheEditParamsValue) IsKnown 

func (r SmartTieredCacheEditParamsValue) IsKnown() bool

type SmartTieredCacheEditResponse 

type SmartTieredCacheEditResponse struct {
	// The identifier of the caching setting
	ID string `json:"id,required"`
	// Whether the setting is editable
	Editable bool `json:"editable,required"`
	// The time when the setting was last modified
	ModifiedOn time.Time `json:"modified_on,required" format:"date-time"`
	// The status of the feature being on / off
	Value SmartTieredCacheEditResponseValue `json:"value,required"`
	JSON  smartTieredCacheEditResponseJSON  `json:"-"`
}

func (*SmartTieredCacheEditResponse) UnmarshalJSON 

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

type SmartTieredCacheEditResponseEnvelope 

type SmartTieredCacheEditResponseEnvelope struct {
	Errors   []shared.ResponseInfo        `json:"errors,required"`
	Messages []shared.ResponseInfo        `json:"messages,required"`
	Result   SmartTieredCacheEditResponse `json:"result,required"`
	// Whether the API call was successful
	Success SmartTieredCacheEditResponseEnvelopeSuccess `json:"success,required"`
	JSON    smartTieredCacheEditResponseEnvelopeJSON    `json:"-"`
}

func (*SmartTieredCacheEditResponseEnvelope) UnmarshalJSON 

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

type SmartTieredCacheEditResponseEnvelopeSuccess 

type SmartTieredCacheEditResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	SmartTieredCacheEditResponseEnvelopeSuccessTrue SmartTieredCacheEditResponseEnvelopeSuccess = true
)

func (SmartTieredCacheEditResponseEnvelopeSuccess) IsKnown 

func (r SmartTieredCacheEditResponseEnvelopeSuccess) IsKnown() bool

type SmartTieredCacheEditResponseValue 

type SmartTieredCacheEditResponseValue string

The status of the feature being on / off 

const (
	SmartTieredCacheEditResponseValueOn  SmartTieredCacheEditResponseValue = "on"
	SmartTieredCacheEditResponseValueOff SmartTieredCacheEditResponseValue = "off"
)

func (SmartTieredCacheEditResponseValue) IsKnown 

func (r SmartTieredCacheEditResponseValue) IsKnown() bool

type SmartTieredCacheGetParams 

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

type SmartTieredCacheGetResponse 

type SmartTieredCacheGetResponse struct {
	// The identifier of the caching setting
	ID string `json:"id,required"`
	// Whether the setting is editable
	Editable bool `json:"editable,required"`
	// The time when the setting was last modified
	ModifiedOn time.Time `json:"modified_on,required" format:"date-time"`
	// The status of the feature being on / off
	Value SmartTieredCacheGetResponseValue `json:"value,required"`
	JSON  smartTieredCacheGetResponseJSON  `json:"-"`
}

func (*SmartTieredCacheGetResponse) UnmarshalJSON 

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

type SmartTieredCacheGetResponseEnvelope 

type SmartTieredCacheGetResponseEnvelope struct {
	Errors   []shared.ResponseInfo       `json:"errors,required"`
	Messages []shared.ResponseInfo       `json:"messages,required"`
	Result   SmartTieredCacheGetResponse `json:"result,required"`
	// Whether the API call was successful
	Success SmartTieredCacheGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    smartTieredCacheGetResponseEnvelopeJSON    `json:"-"`
}

func (*SmartTieredCacheGetResponseEnvelope) UnmarshalJSON 

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

type SmartTieredCacheGetResponseEnvelopeSuccess 

type SmartTieredCacheGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	SmartTieredCacheGetResponseEnvelopeSuccessTrue SmartTieredCacheGetResponseEnvelopeSuccess = true
)

func (SmartTieredCacheGetResponseEnvelopeSuccess) IsKnown 

func (r SmartTieredCacheGetResponseEnvelopeSuccess) IsKnown() bool

type SmartTieredCacheGetResponseValue 

type SmartTieredCacheGetResponseValue string

The status of the feature being on / off 

const (
	SmartTieredCacheGetResponseValueOn  SmartTieredCacheGetResponseValue = "on"
	SmartTieredCacheGetResponseValueOff SmartTieredCacheGetResponseValue = "off"
)

func (SmartTieredCacheGetResponseValue) IsKnown 

func (r SmartTieredCacheGetResponseValue) IsKnown() bool

type SmartTieredCacheService 

type SmartTieredCacheService struct {
	Options []option.RequestOption
}

SmartTieredCacheService 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 NewSmartTieredCacheService method instead.

func NewSmartTieredCacheService 

func NewSmartTieredCacheService(opts ...option.RequestOption) (r *SmartTieredCacheService)

NewSmartTieredCacheService 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 (*SmartTieredCacheService) Delete 

func (r *SmartTieredCacheService) Delete(ctx context.Context, body SmartTieredCacheDeleteParams, opts ...option.RequestOption) (res *SmartTieredCacheDeleteResponse, err error)

Remvoves enablement of Smart Tiered Cache

func (*SmartTieredCacheService) Edit 

func (r *SmartTieredCacheService) Edit(ctx context.Context, params SmartTieredCacheEditParams, opts ...option.RequestOption) (res *SmartTieredCacheEditResponse, err error)

Updates enablement of Tiered Cache

func (*SmartTieredCacheService) Get 

func (r *SmartTieredCacheService) Get(ctx context.Context, query SmartTieredCacheGetParams, opts ...option.RequestOption) (res *SmartTieredCacheGetResponse, err error)

Get Smart Tiered Cache setting

type SortDirection 

type SortDirection = shared.SortDirection

Direction to order DNS records in.

This is an alias to an internal type.

type State 

type State string

The current state of the Cache Reserve Clear operation. 

const (
	StateInProgress State = "In-progress"
	StateCompleted  State = "Completed"
)

func (State) IsKnown 

func (r State) IsKnown() bool

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 VariantDeleteParams 

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

type VariantDeleteResponseEnvelope 

type VariantDeleteResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Variant support enables caching variants of images with certain file extensions
	// in addition to the original. This only applies when the origin server sends the
	// 'Vary: Accept' response header. If the origin server sends 'Vary: Accept' but
	// does not serve the variant requested, the response will not be cached. This will
	// be indicated with BYPASS cache status in the response headers.
	Result CacheVariant `json:"result,required"`
	// Whether the API call was successful
	Success VariantDeleteResponseEnvelopeSuccess `json:"success,required"`
	JSON    variantDeleteResponseEnvelopeJSON    `json:"-"`
}

func (*VariantDeleteResponseEnvelope) UnmarshalJSON 

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

type VariantDeleteResponseEnvelopeSuccess 

type VariantDeleteResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	VariantDeleteResponseEnvelopeSuccessTrue VariantDeleteResponseEnvelopeSuccess = true
)

func (VariantDeleteResponseEnvelopeSuccess) IsKnown 

func (r VariantDeleteResponseEnvelopeSuccess) IsKnown() bool

type VariantEditParams 

type VariantEditParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	// Value of the zone setting.
	Value param.Field[VariantEditParamsValue] `json:"value,required"`
}

func (VariantEditParams) MarshalJSON 

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

type VariantEditParamsValue 

type VariantEditParamsValue struct {
	// List of strings with the MIME types of all the variants that should be served
	// for avif.
	AVIF param.Field[[]string] `json:"avif"`
	// List of strings with the MIME types of all the variants that should be served
	// for bmp.
	BMP param.Field[[]string] `json:"bmp"`
	// List of strings with the MIME types of all the variants that should be served
	// for gif.
	GIF param.Field[[]string] `json:"gif"`
	// List of strings with the MIME types of all the variants that should be served
	// for jp2.
	JP2 param.Field[[]string] `json:"jp2"`
	// List of strings with the MIME types of all the variants that should be served
	// for jpeg.
	JPEG param.Field[[]string] `json:"jpeg"`
	// List of strings with the MIME types of all the variants that should be served
	// for jpg.
	JPG param.Field[[]string] `json:"jpg"`
	// List of strings with the MIME types of all the variants that should be served
	// for jpg2.
	JPG2 param.Field[[]string] `json:"jpg2"`
	// List of strings with the MIME types of all the variants that should be served
	// for png.
	PNG param.Field[[]string] `json:"png"`
	// List of strings with the MIME types of all the variants that should be served
	// for tif.
	TIF param.Field[[]string] `json:"tif"`
	// List of strings with the MIME types of all the variants that should be served
	// for tiff.
	TIFF param.Field[[]string] `json:"tiff"`
	// List of strings with the MIME types of all the variants that should be served
	// for webp.
	WebP param.Field[[]string] `json:"webp"`
}

Value of the zone setting.

func (VariantEditParamsValue) MarshalJSON 

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

type VariantEditResponse 

type VariantEditResponse struct {
	// ID of the zone setting.
	ID CacheVariantIdentifier `json:"id,required"`
	// last time this setting was modified.
	ModifiedOn time.Time `json:"modified_on,required,nullable" format:"date-time"`
	// Value of the zone setting.
	Value VariantEditResponseValue `json:"value,required"`
	JSON  variantEditResponseJSON  `json:"-"`
}

Variant support enables caching variants of images with certain file extensions in addition to the original. This only applies when the origin server sends the 'Vary: Accept' response header. If the origin server sends 'Vary: Accept' but does not serve the variant requested, the response will not be cached. This will be indicated with BYPASS cache status in the response headers.

func (*VariantEditResponse) UnmarshalJSON 

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

type VariantEditResponseEnvelope 

type VariantEditResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Variant support enables caching variants of images with certain file extensions
	// in addition to the original. This only applies when the origin server sends the
	// 'Vary: Accept' response header. If the origin server sends 'Vary: Accept' but
	// does not serve the variant requested, the response will not be cached. This will
	// be indicated with BYPASS cache status in the response headers.
	Result VariantEditResponse `json:"result,required"`
	// Whether the API call was successful
	Success VariantEditResponseEnvelopeSuccess `json:"success,required"`
	JSON    variantEditResponseEnvelopeJSON    `json:"-"`
}

func (*VariantEditResponseEnvelope) UnmarshalJSON 

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

type VariantEditResponseEnvelopeSuccess 

type VariantEditResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	VariantEditResponseEnvelopeSuccessTrue VariantEditResponseEnvelopeSuccess = true
)

func (VariantEditResponseEnvelopeSuccess) IsKnown 

func (r VariantEditResponseEnvelopeSuccess) IsKnown() bool

type VariantEditResponseValue 

type VariantEditResponseValue struct {
	// List of strings with the MIME types of all the variants that should be served
	// for avif.
	AVIF []string `json:"avif"`
	// List of strings with the MIME types of all the variants that should be served
	// for bmp.
	BMP []string `json:"bmp"`
	// List of strings with the MIME types of all the variants that should be served
	// for gif.
	GIF []string `json:"gif"`
	// List of strings with the MIME types of all the variants that should be served
	// for jp2.
	JP2 []string `json:"jp2"`
	// List of strings with the MIME types of all the variants that should be served
	// for jpeg.
	JPEG []string `json:"jpeg"`
	// List of strings with the MIME types of all the variants that should be served
	// for jpg.
	JPG []string `json:"jpg"`
	// List of strings with the MIME types of all the variants that should be served
	// for jpg2.
	JPG2 []string `json:"jpg2"`
	// List of strings with the MIME types of all the variants that should be served
	// for png.
	PNG []string `json:"png"`
	// List of strings with the MIME types of all the variants that should be served
	// for tif.
	TIF []string `json:"tif"`
	// List of strings with the MIME types of all the variants that should be served
	// for tiff.
	TIFF []string `json:"tiff"`
	// List of strings with the MIME types of all the variants that should be served
	// for webp.
	WebP []string                     `json:"webp"`
	JSON variantEditResponseValueJSON `json:"-"`
}

Value of the zone setting.

func (*VariantEditResponseValue) UnmarshalJSON 

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

type VariantGetParams 

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

type VariantGetResponse 

type VariantGetResponse struct {
	// ID of the zone setting.
	ID CacheVariantIdentifier `json:"id,required"`
	// last time this setting was modified.
	ModifiedOn time.Time `json:"modified_on,required,nullable" format:"date-time"`
	// Value of the zone setting.
	Value VariantGetResponseValue `json:"value,required"`
	JSON  variantGetResponseJSON  `json:"-"`
}

Variant support enables caching variants of images with certain file extensions in addition to the original. This only applies when the origin server sends the 'Vary: Accept' response header. If the origin server sends 'Vary: Accept' but does not serve the variant requested, the response will not be cached. This will be indicated with BYPASS cache status in the response headers.

func (*VariantGetResponse) UnmarshalJSON 

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

type VariantGetResponseEnvelope 

type VariantGetResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Variant support enables caching variants of images with certain file extensions
	// in addition to the original. This only applies when the origin server sends the
	// 'Vary: Accept' response header. If the origin server sends 'Vary: Accept' but
	// does not serve the variant requested, the response will not be cached. This will
	// be indicated with BYPASS cache status in the response headers.
	Result VariantGetResponse `json:"result,required"`
	// Whether the API call was successful
	Success VariantGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    variantGetResponseEnvelopeJSON    `json:"-"`
}

func (*VariantGetResponseEnvelope) UnmarshalJSON 

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

type VariantGetResponseEnvelopeSuccess 

type VariantGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	VariantGetResponseEnvelopeSuccessTrue VariantGetResponseEnvelopeSuccess = true
)

func (VariantGetResponseEnvelopeSuccess) IsKnown 

func (r VariantGetResponseEnvelopeSuccess) IsKnown() bool

type VariantGetResponseValue 

type VariantGetResponseValue struct {
	// List of strings with the MIME types of all the variants that should be served
	// for avif.
	AVIF []string `json:"avif"`
	// List of strings with the MIME types of all the variants that should be served
	// for bmp.
	BMP []string `json:"bmp"`
	// List of strings with the MIME types of all the variants that should be served
	// for gif.
	GIF []string `json:"gif"`
	// List of strings with the MIME types of all the variants that should be served
	// for jp2.
	JP2 []string `json:"jp2"`
	// List of strings with the MIME types of all the variants that should be served
	// for jpeg.
	JPEG []string `json:"jpeg"`
	// List of strings with the MIME types of all the variants that should be served
	// for jpg.
	JPG []string `json:"jpg"`
	// List of strings with the MIME types of all the variants that should be served
	// for jpg2.
	JPG2 []string `json:"jpg2"`
	// List of strings with the MIME types of all the variants that should be served
	// for png.
	PNG []string `json:"png"`
	// List of strings with the MIME types of all the variants that should be served
	// for tif.
	TIF []string `json:"tif"`
	// List of strings with the MIME types of all the variants that should be served
	// for tiff.
	TIFF []string `json:"tiff"`
	// List of strings with the MIME types of all the variants that should be served
	// for webp.
	WebP []string                    `json:"webp"`
	JSON variantGetResponseValueJSON `json:"-"`
}

Value of the zone setting.

func (*VariantGetResponseValue) UnmarshalJSON 

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

type VariantService 

type VariantService struct {
	Options []option.RequestOption
}

VariantService 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 NewVariantService method instead.

func NewVariantService 

func NewVariantService(opts ...option.RequestOption) (r *VariantService)

NewVariantService 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 (*VariantService) Delete 

func (r *VariantService) Delete(ctx context.Context, body VariantDeleteParams, opts ...option.RequestOption) (res *CacheVariant, err error)

Variant support enables caching variants of images with certain file extensions in addition to the original. This only applies when the origin server sends the 'Vary: Accept' response header. If the origin server sends 'Vary: Accept' but does not serve the variant requested, the response will not be cached. This will be indicated with BYPASS cache status in the response headers.

func (*VariantService) Edit 

func (r *VariantService) Edit(ctx context.Context, params VariantEditParams, opts ...option.RequestOption) (res *VariantEditResponse, err error)

Variant support enables caching variants of images with certain file extensions in addition to the original. This only applies when the origin server sends the 'Vary: Accept' response header. If the origin server sends 'Vary: Accept' but does not serve the variant requested, the response will not be cached. This will be indicated with BYPASS cache status in the response headers.

func (*VariantService) Get 

func (r *VariantService) Get(ctx context.Context, query VariantGetParams, opts ...option.RequestOption) (res *VariantGetResponse, err error)

Variant support enables caching variants of images with certain file extensions in addition to the original. This only applies when the origin server sends the 'Vary: Accept' response header. If the origin server sends 'Vary: Accept' but does not serve the variant requested, the response will not be cached. This will be indicated with BYPASS cache status in the response headers.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.