Documentation
¶
Index ¶
- Constants
- type ASN
- type ASNParam
- type AuditLog
- type AuditLogAction
- type AuditLogActor
- type AuditLogActorType
- type AuditLogOwner
- type AuditLogResource
- type CachePurgeParams
- type CachePurgeParamsBody
- type CachePurgeParamsBodyCachePurgeEverything
- type CachePurgeParamsBodyCachePurgeFlexPurgeByHostnames
- type CachePurgeParamsBodyCachePurgeFlexPurgeByPrefixes
- type CachePurgeParamsBodyCachePurgeFlexPurgeByTags
- type CachePurgeParamsBodyCachePurgeSingleFile
- type CachePurgeParamsBodyCachePurgeSingleFileWithURLAndHeaders
- type CachePurgeParamsBodyCachePurgeSingleFileWithURLAndHeadersFile
- type CachePurgeParamsBodyUnion
- type CachePurgeResponse
- type CachePurgeResponseEnvelope
- type CacheReserve
- type CacheReserveClear
- type CacheReserveClearParams
- type CacheReserveClearResponse
- type CacheReserveClearResponseEnvelope
- type CacheReserveClearResponseEnvelopeSuccess
- type CacheReserveEditParams
- type CacheReserveEditParamsValue
- type CacheReserveEditResponse
- type CacheReserveEditResponseEnvelope
- type CacheReserveEditResponseEnvelopeSuccess
- type CacheReserveEditResponseValue
- type CacheReserveGetParams
- type CacheReserveGetResponse
- type CacheReserveGetResponseEnvelope
- type CacheReserveGetResponseEnvelopeSuccess
- type CacheReserveGetResponseValue
- type CacheReserveService
- func (r *CacheReserveService) Clear(ctx context.Context, params CacheReserveClearParams, ...) (res *CacheReserveClearResponse, err error)
- func (r *CacheReserveService) Edit(ctx context.Context, params CacheReserveEditParams, ...) (res *CacheReserveEditResponse, err error)
- func (r *CacheReserveService) Get(ctx context.Context, query CacheReserveGetParams, opts ...option.RequestOption) (res *CacheReserveGetResponse, err error)
- func (r *CacheReserveService) Status(ctx context.Context, query CacheReserveStatusParams, ...) (res *CacheReserveStatusResponse, err error)
- type CacheReserveStatusParams
- type CacheReserveStatusResponse
- type CacheReserveStatusResponseEnvelope
- type CacheReserveStatusResponseEnvelopeSuccess
- type CacheService
- type CertificateCA
- type CertificateRequestType
- type CloudflareTunnel
- type CloudflareTunnelConfigSrc
- type CloudflareTunnelConnection
- type CloudflareTunnelStatus
- type CloudflareTunnelTunType
- type Error
- type ErrorData
- type ErrorDataSource
- type Member
- type MemberPoliciesAccess
- type MemberPoliciesPermissionGroup
- type MemberPoliciesPermissionGroupsMeta
- type MemberPoliciesResourceGroup
- type MemberPoliciesResourceGroupsMeta
- type MemberPoliciesResourceGroupsScope
- type MemberPoliciesResourceGroupsScopeObject
- type MemberPolicy
- type MemberStatus
- type MemberUser
- type OriginCloudRegion
- type OriginCloudRegionBulkDeleteParams
- type OriginCloudRegionBulkDeleteResponse
- type OriginCloudRegionBulkDeleteResponseEnvelope
- type OriginCloudRegionBulkDeleteResponseEnvelopeSuccess
- type OriginCloudRegionBulkDeleteResponseID
- type OriginCloudRegionBulkDeleteResponseValue
- type OriginCloudRegionBulkDeleteResponseValueFailed
- type OriginCloudRegionBulkDeleteResponseValueSucceeded
- type OriginCloudRegionBulkEditParams
- type OriginCloudRegionBulkEditParamsBody
- type OriginCloudRegionBulkEditParamsBodyVendor
- type OriginCloudRegionBulkEditResponse
- type OriginCloudRegionBulkEditResponseEnvelope
- type OriginCloudRegionBulkEditResponseEnvelopeSuccess
- type OriginCloudRegionBulkEditResponseID
- type OriginCloudRegionBulkEditResponseValue
- type OriginCloudRegionBulkEditResponseValueFailed
- type OriginCloudRegionBulkEditResponseValueSucceeded
- type OriginCloudRegionDeleteParams
- type OriginCloudRegionDeleteResponse
- type OriginCloudRegionDeleteResponseEnvelope
- type OriginCloudRegionDeleteResponseEnvelopeSuccess
- type OriginCloudRegionDeleteResponseID
- type OriginCloudRegionEditParams
- type OriginCloudRegionEditParamsVendor
- type OriginCloudRegionEditResponse
- type OriginCloudRegionEditResponseEnvelope
- type OriginCloudRegionEditResponseEnvelopeSuccess
- type OriginCloudRegionEditResponseID
- type OriginCloudRegionGetParams
- type OriginCloudRegionGetResponse
- type OriginCloudRegionGetResponseEnvelope
- type OriginCloudRegionGetResponseEnvelopeSuccess
- type OriginCloudRegionGetResponseID
- type OriginCloudRegionListParams
- type OriginCloudRegionListResponse
- type OriginCloudRegionListResponseEnvelope
- type OriginCloudRegionListResponseEnvelopeSuccess
- type OriginCloudRegionListResponseID
- type OriginCloudRegionNewParams
- type OriginCloudRegionNewParamsVendor
- type OriginCloudRegionNewResponse
- type OriginCloudRegionNewResponseEnvelope
- type OriginCloudRegionNewResponseEnvelopeSuccess
- type OriginCloudRegionNewResponseID
- type OriginCloudRegionService
- func (r *OriginCloudRegionService) BulkDelete(ctx context.Context, body OriginCloudRegionBulkDeleteParams, ...) (res *OriginCloudRegionBulkDeleteResponse, err error)
- func (r *OriginCloudRegionService) BulkEdit(ctx context.Context, params OriginCloudRegionBulkEditParams, ...) (res *OriginCloudRegionBulkEditResponse, err error)
- func (r *OriginCloudRegionService) Delete(ctx context.Context, originIP string, body OriginCloudRegionDeleteParams, ...) (res *OriginCloudRegionDeleteResponse, err error)
- func (r *OriginCloudRegionService) Edit(ctx context.Context, params OriginCloudRegionEditParams, ...) (res *OriginCloudRegionEditResponse, err error)
- func (r *OriginCloudRegionService) Get(ctx context.Context, originIP string, query OriginCloudRegionGetParams, ...) (res *OriginCloudRegionGetResponse, err error)
- func (r *OriginCloudRegionService) List(ctx context.Context, query OriginCloudRegionListParams, ...) (res *OriginCloudRegionListResponse, err error)
- func (r *OriginCloudRegionService) New(ctx context.Context, params OriginCloudRegionNewParams, ...) (res *OriginCloudRegionNewResponse, err error)
- func (r *OriginCloudRegionService) SupportedRegions(ctx context.Context, query OriginCloudRegionSupportedRegionsParams, ...) (res *OriginCloudRegionSupportedRegionsResponse, err error)
- type OriginCloudRegionSupportedRegionsParams
- type OriginCloudRegionSupportedRegionsResponse
- type OriginCloudRegionSupportedRegionsResponseEnvelope
- type OriginCloudRegionSupportedRegionsResponseEnvelopeSuccess
- type OriginCloudRegionSupportedRegionsResponseVendor
- type OriginCloudRegionVendor
- type Permission
- type PermissionGrant
- type PermissionGrantParam
- type RatePlan
- type RatePlanID
- type RatePlanParam
- type RegionalTieredCache
- type RegionalTieredCacheEditParams
- type RegionalTieredCacheEditParamsValue
- type RegionalTieredCacheEditResponse
- type RegionalTieredCacheEditResponseEnvelope
- type RegionalTieredCacheEditResponseEnvelopeSuccess
- type RegionalTieredCacheEditResponseValue
- type RegionalTieredCacheGetParams
- type RegionalTieredCacheGetResponse
- type RegionalTieredCacheGetResponseEnvelope
- type RegionalTieredCacheGetResponseEnvelopeSuccess
- type RegionalTieredCacheGetResponseValue
- type RegionalTieredCacheService
- func (r *RegionalTieredCacheService) Edit(ctx context.Context, params RegionalTieredCacheEditParams, ...) (res *RegionalTieredCacheEditResponse, err error)
- func (r *RegionalTieredCacheService) Get(ctx context.Context, query RegionalTieredCacheGetParams, ...) (res *RegionalTieredCacheGetResponse, err error)
- type ResponseInfo
- type ResponseInfoSource
- type Role
- type RoleParam
- type RolePermissions
- type RolePermissionsParam
- type SmartTieredCacheDeleteParams
- type SmartTieredCacheDeleteResponse
- type SmartTieredCacheDeleteResponseEnvelope
- type SmartTieredCacheDeleteResponseEnvelopeSuccess
- type SmartTieredCacheDeleteResponseID
- type SmartTieredCacheEditParams
- type SmartTieredCacheEditParamsValue
- type SmartTieredCacheEditResponse
- type SmartTieredCacheEditResponseEnvelope
- type SmartTieredCacheEditResponseEnvelopeSuccess
- type SmartTieredCacheEditResponseID
- type SmartTieredCacheEditResponseValue
- type SmartTieredCacheGetParams
- type SmartTieredCacheGetResponse
- type SmartTieredCacheGetResponseEnvelope
- type SmartTieredCacheGetResponseEnvelopeSuccess
- type SmartTieredCacheGetResponseID
- type SmartTieredCacheGetResponseValue
- type SmartTieredCacheService
- func (r *SmartTieredCacheService) Delete(ctx context.Context, body SmartTieredCacheDeleteParams, ...) (res *SmartTieredCacheDeleteResponse, err error)
- func (r *SmartTieredCacheService) Edit(ctx context.Context, params SmartTieredCacheEditParams, ...) (res *SmartTieredCacheEditResponse, err error)
- func (r *SmartTieredCacheService) Get(ctx context.Context, query SmartTieredCacheGetParams, ...) (res *SmartTieredCacheGetResponse, err error)
- type SortDirection
- type State
- type Subscription
- type SubscriptionFrequency
- type SubscriptionParam
- type SubscriptionState
- type Token
- type TokenCondition
- type TokenConditionCIDRList
- type TokenConditionCIDRListParam
- type TokenConditionParam
- type TokenConditionRequestIP
- type TokenConditionRequestIPParam
- type TokenParam
- type TokenPolicy
- type TokenPolicyEffect
- type TokenPolicyParam
- type TokenPolicyPermissionGroup
- type TokenPolicyPermissionGroupParam
- type TokenPolicyPermissionGroupsMeta
- type TokenPolicyPermissionGroupsMetaParam
- type TokenPolicyResourcesIAMResourcesTypeObjectNested
- type TokenPolicyResourcesIAMResourcesTypeObjectNestedParam
- type TokenPolicyResourcesIAMResourcesTypeObjectString
- type TokenPolicyResourcesIAMResourcesTypeObjectStringParam
- type TokenPolicyResourcesUnion
- type TokenPolicyResourcesUnionParam
- type TokenStatus
- type TokenValue
- type VariantDeleteParams
- type VariantDeleteResponse
- type VariantDeleteResponseEnvelope
- type VariantDeleteResponseEnvelopeSuccess
- type VariantDeleteResponseID
- type VariantEditParams
- type VariantEditParamsValue
- type VariantEditResponse
- type VariantEditResponseEnvelope
- type VariantEditResponseEnvelopeSuccess
- type VariantEditResponseID
- type VariantEditResponseValue
- type VariantGetParams
- type VariantGetResponse
- type VariantGetResponseEnvelope
- type VariantGetResponseEnvelopeSuccess
- type VariantGetResponseID
- type VariantGetResponseValue
- type VariantService
- func (r *VariantService) Delete(ctx context.Context, body VariantDeleteParams, opts ...option.RequestOption) (res *VariantDeleteResponse, err error)
- func (r *VariantService) Edit(ctx context.Context, params VariantEditParams, opts ...option.RequestOption) (res *VariantEditResponse, err error)
- func (r *VariantService) Get(ctx context.Context, query VariantGetParams, opts ...option.RequestOption) (res *VariantGetResponse, err error)
Constants ¶
const AuditLogActorTypeAdmin = shared.AuditLogActorTypeAdmin
This is an alias to an internal value.
const AuditLogActorTypeCloudflare = shared.AuditLogActorTypeCloudflare
This is an alias to an internal value.
const AuditLogActorTypeUser = shared.AuditLogActorTypeUser
This is an alias to an internal value.
const CertificateCADigicert = shared.CertificateCADigicert
This is an alias to an internal value.
const CertificateCAGoogle = shared.CertificateCAGoogle
This is an alias to an internal value.
const CertificateCALetsEncrypt = shared.CertificateCALetsEncrypt
This is an alias to an internal value.
const CertificateCASSLCom = shared.CertificateCASSLCom
This is an alias to an internal value.
const CertificateRequestTypeKeylessCertificate = shared.CertificateRequestTypeKeylessCertificate
This is an alias to an internal value.
const CertificateRequestTypeOriginECC = shared.CertificateRequestTypeOriginECC
This is an alias to an internal value.
const CertificateRequestTypeOriginRSA = shared.CertificateRequestTypeOriginRSA
This is an alias to an internal value.
const CloudflareTunnelConfigSrcCloudflare = shared.CloudflareTunnelConfigSrcCloudflare
This is an alias to an internal value.
const CloudflareTunnelConfigSrcLocal = shared.CloudflareTunnelConfigSrcLocal
This is an alias to an internal value.
const CloudflareTunnelStatusDegraded = shared.CloudflareTunnelStatusDegraded
This is an alias to an internal value.
const CloudflareTunnelStatusDown = shared.CloudflareTunnelStatusDown
This is an alias to an internal value.
const CloudflareTunnelStatusHealthy = shared.CloudflareTunnelStatusHealthy
This is an alias to an internal value.
const CloudflareTunnelStatusInactive = shared.CloudflareTunnelStatusInactive
This is an alias to an internal value.
const CloudflareTunnelTunTypeCNI = shared.CloudflareTunnelTunTypeCNI
This is an alias to an internal value.
const CloudflareTunnelTunTypeCfdTunnel = shared.CloudflareTunnelTunTypeCfdTunnel
This is an alias to an internal value.
const CloudflareTunnelTunTypeGRE = shared.CloudflareTunnelTunTypeGRE
This is an alias to an internal value.
const CloudflareTunnelTunTypeIPSec = shared.CloudflareTunnelTunTypeIPSec
This is an alias to an internal value.
const CloudflareTunnelTunTypeMagic = shared.CloudflareTunnelTunTypeMagic
This is an alias to an internal value.
const CloudflareTunnelTunTypeWARP = shared.CloudflareTunnelTunTypeWARP
This is an alias to an internal value.
const CloudflareTunnelTunTypeWARPConnector = shared.CloudflareTunnelTunTypeWARPConnector
This is an alias to an internal value.
const MemberPoliciesAccessAllow = shared.MemberPoliciesAccessAllow
This is an alias to an internal value.
const MemberPoliciesAccessDeny = shared.MemberPoliciesAccessDeny
This is an alias to an internal value.
const MemberStatusAccepted = shared.MemberStatusAccepted
This is an alias to an internal value.
const MemberStatusPending = shared.MemberStatusPending
This is an alias to an internal value.
const RatePlanIDBusiness = shared.RatePlanIDBusiness
This is an alias to an internal value.
const RatePlanIDEnterprise = shared.RatePlanIDEnterprise
This is an alias to an internal value.
const RatePlanIDFree = shared.RatePlanIDFree
This is an alias to an internal value.
const RatePlanIDLite = shared.RatePlanIDLite
This is an alias to an internal value.
const RatePlanIDPartnersBusiness = shared.RatePlanIDPartnersBusiness
This is an alias to an internal value.
const RatePlanIDPartnersEnterprise = shared.RatePlanIDPartnersEnterprise
This is an alias to an internal value.
const RatePlanIDPartnersFree = shared.RatePlanIDPartnersFree
This is an alias to an internal value.
const RatePlanIDPartnersPro = shared.RatePlanIDPartnersPro
This is an alias to an internal value.
const RatePlanIDPro = shared.RatePlanIDPro
This is an alias to an internal value.
const RatePlanIDProPlus = shared.RatePlanIDProPlus
This is an alias to an internal value.
const SortDirectionAsc = shared.SortDirectionAsc
This is an alias to an internal value.
const SortDirectionDesc = shared.SortDirectionDesc
This is an alias to an internal value.
const SubscriptionFrequencyMonthly = shared.SubscriptionFrequencyMonthly
This is an alias to an internal value.
const SubscriptionFrequencyQuarterly = shared.SubscriptionFrequencyQuarterly
This is an alias to an internal value.
const SubscriptionFrequencyWeekly = shared.SubscriptionFrequencyWeekly
This is an alias to an internal value.
const SubscriptionFrequencyYearly = shared.SubscriptionFrequencyYearly
This is an alias to an internal value.
const SubscriptionStateAwaitingPayment = shared.SubscriptionStateAwaitingPayment
This is an alias to an internal value.
const SubscriptionStateCancelled = shared.SubscriptionStateCancelled
This is an alias to an internal value.
const SubscriptionStateExpired = shared.SubscriptionStateExpired
This is an alias to an internal value.
const SubscriptionStateFailed = shared.SubscriptionStateFailed
This is an alias to an internal value.
const SubscriptionStatePaid = shared.SubscriptionStatePaid
This is an alias to an internal value.
const SubscriptionStateProvisioned = shared.SubscriptionStateProvisioned
This is an alias to an internal value.
const SubscriptionStateTrial = shared.SubscriptionStateTrial
This is an alias to an internal value.
const TokenPolicyEffectAllow = shared.TokenPolicyEffectAllow
This is an alias to an internal value.
const TokenPolicyEffectDeny = shared.TokenPolicyEffectDeny
This is an alias to an internal value.
const TokenStatusActive = shared.TokenStatusActive
This is an alias to an internal value.
const TokenStatusDisabled = shared.TokenStatusDisabled
This is an alias to an internal value.
const TokenStatusExpired = shared.TokenStatusExpired
This is an alias to an internal value.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AuditLogAction ¶
type AuditLogAction = shared.AuditLogAction
This is an alias to an internal type.
type AuditLogActor ¶
type AuditLogActor = shared.AuditLogActor
This is an alias to an internal type.
type AuditLogActorType ¶
type AuditLogActorType = shared.AuditLogActorType
The type of actor, whether a User, Cloudflare Admin, or an Automated System.
This is an alias to an internal type.
type AuditLogOwner ¶
type AuditLogOwner = shared.AuditLogOwner
This is an alias to an internal type.
type AuditLogResource ¶
type AuditLogResource = shared.AuditLogResource
This is an alias to an internal type.
type CachePurgeParams ¶
type CachePurgeParams struct {
ZoneID param.Field[string] `path:"zone_id" api:"required"`
Body CachePurgeParamsBodyUnion `json:"body" api:"required"`
}
func (CachePurgeParams) MarshalJSON ¶
func (r CachePurgeParams) MarshalJSON() (data []byte, err error)
type CachePurgeParamsBody ¶
type CachePurgeParamsBody struct {
Files param.Field[interface{}] `json:"files"`
Hosts param.Field[interface{}] `json:"hosts"`
Prefixes param.Field[interface{}] `json:"prefixes"`
// 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"`
Tags param.Field[interface{}] `json:"tags"`
}
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/).
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[map[string]string] `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 {
ID string `json:"id" api:"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" api:"required"`
Messages []shared.ResponseInfo `json:"messages" api:"required"`
// Indicates the API call's success or failure.
Success bool `json:"success" api:"required"`
Result CachePurgeResponse `json:"result" api:"nullable"`
JSON cachePurgeResponseEnvelopeJSON `json:"-"`
}
func (*CachePurgeResponseEnvelope) UnmarshalJSON ¶
func (r *CachePurgeResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type CacheReserve ¶
type CacheReserve string
The identifier of the caching 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" api:"required"`
Body interface{} `json:"body" api:"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" api:"required"`
// The time that the latest Cache Reserve Clear operation started.
StartTs time.Time `json:"start_ts" api:"required" format:"date-time"`
// The current state of the Cache Reserve Clear operation.
State State `json:"state" api:"required"`
// The time that the latest Cache Reserve Clear operation completed.
EndTs time.Time `json:"end_ts" format:"date-time"`
// Last time this setting was modified.
ModifiedOn time.Time `json:"modified_on" api:"nullable" 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" api:"required"`
Messages []shared.ResponseInfo `json:"messages" api:"required"`
// Whether the API call was successful.
Success CacheReserveClearResponseEnvelopeSuccess `json:"success" api:"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"`
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" api:"required"`
// Value of the Cache Reserve zone setting.
Value param.Field[CacheReserveEditParamsValue] `json:"value" api:"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 {
// The identifier of the caching setting.
ID CacheReserve `json:"id" api:"required"`
// Whether the setting is editable.
Editable bool `json:"editable" api:"required"`
// Value of the Cache Reserve zone setting.
Value CacheReserveEditResponseValue `json:"value" api:"required"`
// Last time this setting was modified.
ModifiedOn time.Time `json:"modified_on" api:"nullable" format:"date-time"`
JSON cacheReserveEditResponseJSON `json:"-"`
}
func (*CacheReserveEditResponse) UnmarshalJSON ¶
func (r *CacheReserveEditResponse) UnmarshalJSON(data []byte) (err error)
type CacheReserveEditResponseEnvelope ¶
type CacheReserveEditResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors" api:"required"`
Messages []shared.ResponseInfo `json:"messages" api:"required"`
// Whether the API call was successful.
Success CacheReserveEditResponseEnvelopeSuccess `json:"success" api:"required"`
Result CacheReserveEditResponse `json:"result"`
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 CacheReserveGetResponse ¶
type CacheReserveGetResponse struct {
// The identifier of the caching setting.
ID CacheReserve `json:"id" api:"required"`
// Whether the setting is editable.
Editable bool `json:"editable" api:"required"`
// Value of the Cache Reserve zone setting.
Value CacheReserveGetResponseValue `json:"value" api:"required"`
// Last time this setting was modified.
ModifiedOn time.Time `json:"modified_on" api:"nullable" format:"date-time"`
JSON cacheReserveGetResponseJSON `json:"-"`
}
func (*CacheReserveGetResponse) UnmarshalJSON ¶
func (r *CacheReserveGetResponse) UnmarshalJSON(data []byte) (err error)
type CacheReserveGetResponseEnvelope ¶
type CacheReserveGetResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors" api:"required"`
Messages []shared.ResponseInfo `json:"messages" api:"required"`
// Whether the API call was successful.
Success CacheReserveGetResponseEnvelopeSuccess `json:"success" api:"required"`
Result CacheReserveGetResponse `json:"result"`
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 CacheReserveStatusResponse ¶
type CacheReserveStatusResponse struct {
// ID of the zone setting.
ID CacheReserveClear `json:"id" api:"required"`
// The time that the latest Cache Reserve Clear operation started.
StartTs time.Time `json:"start_ts" api:"required" format:"date-time"`
// The current state of the Cache Reserve Clear operation.
State State `json:"state" api:"required"`
// The time that the latest Cache Reserve Clear operation completed.
EndTs time.Time `json:"end_ts" format:"date-time"`
// Last time this setting was modified.
ModifiedOn time.Time `json:"modified_on" api:"nullable" 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" api:"required"`
Messages []shared.ResponseInfo `json:"messages" api:"required"`
// Whether the API call was successful.
Success CacheReserveStatusResponseEnvelopeSuccess `json:"success" api:"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"`
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
OriginCloudRegions *OriginCloudRegionService
}
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.
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.
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"]} ```
### Availability and limits
please refer to [purge cache availability and limits documentation page](https://developers.cloudflare.com/cache/how-to/purge-cache/#availability-and-limits).
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 ErrorDataSource ¶
type ErrorDataSource = shared.ErrorDataSource
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 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 OriginCloudRegion ¶ added in v6.10.0
type OriginCloudRegion struct {
// The origin IP address (IPv4 or IPv6, canonicalized).
OriginIP string `json:"origin-ip" api:"required"`
// Cloud vendor region identifier.
Region string `json:"region" api:"required"`
// Cloud vendor hosting the origin.
Vendor OriginCloudRegionVendor `json:"vendor" api:"required"`
// Time this mapping was last modified.
ModifiedOn time.Time `json:"modified_on" format:"date-time"`
JSON originCloudRegionJSON `json:"-"`
}
A single origin IP-to-cloud-region mapping.
func (*OriginCloudRegion) UnmarshalJSON ¶ added in v6.10.0
func (r *OriginCloudRegion) UnmarshalJSON(data []byte) (err error)
type OriginCloudRegionBulkDeleteParams ¶ added in v6.10.0
type OriginCloudRegionBulkDeleteResponse ¶ added in v6.10.0
type OriginCloudRegionBulkDeleteResponse struct {
ID OriginCloudRegionBulkDeleteResponseID `json:"id" api:"required"`
// Whether the setting can be modified by the current user.
Editable bool `json:"editable" api:"required"`
Value OriginCloudRegionBulkDeleteResponseValue `json:"value" api:"required"`
// Time the mapping set was last modified. Null when no items were successfully
// applied.
ModifiedOn time.Time `json:"modified_on" api:"nullable" format:"date-time"`
JSON originCloudRegionBulkDeleteResponseJSON `json:"-"`
}
Response result for a batch origin cloud region operation.
func (*OriginCloudRegionBulkDeleteResponse) UnmarshalJSON ¶ added in v6.10.0
func (r *OriginCloudRegionBulkDeleteResponse) UnmarshalJSON(data []byte) (err error)
type OriginCloudRegionBulkDeleteResponseEnvelope ¶ added in v6.10.0
type OriginCloudRegionBulkDeleteResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors" api:"required"`
Messages []shared.ResponseInfo `json:"messages" api:"required"`
// Whether the API call was successful.
Success OriginCloudRegionBulkDeleteResponseEnvelopeSuccess `json:"success" api:"required"`
// Response result for a batch origin cloud region operation.
Result OriginCloudRegionBulkDeleteResponse `json:"result"`
JSON originCloudRegionBulkDeleteResponseEnvelopeJSON `json:"-"`
}
func (*OriginCloudRegionBulkDeleteResponseEnvelope) UnmarshalJSON ¶ added in v6.10.0
func (r *OriginCloudRegionBulkDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type OriginCloudRegionBulkDeleteResponseEnvelopeSuccess ¶ added in v6.10.0
type OriginCloudRegionBulkDeleteResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
OriginCloudRegionBulkDeleteResponseEnvelopeSuccessTrue OriginCloudRegionBulkDeleteResponseEnvelopeSuccess = true
)
func (OriginCloudRegionBulkDeleteResponseEnvelopeSuccess) IsKnown ¶ added in v6.10.0
func (r OriginCloudRegionBulkDeleteResponseEnvelopeSuccess) IsKnown() bool
type OriginCloudRegionBulkDeleteResponseID ¶ added in v6.10.0
type OriginCloudRegionBulkDeleteResponseID string
const (
OriginCloudRegionBulkDeleteResponseIDOriginPublicCloudRegion OriginCloudRegionBulkDeleteResponseID = "origin_public_cloud_region"
)
func (OriginCloudRegionBulkDeleteResponseID) IsKnown ¶ added in v6.10.0
func (r OriginCloudRegionBulkDeleteResponseID) IsKnown() bool
type OriginCloudRegionBulkDeleteResponseValue ¶ added in v6.10.0
type OriginCloudRegionBulkDeleteResponseValue struct {
// Items that could not be applied, with error details.
Failed []OriginCloudRegionBulkDeleteResponseValueFailed `json:"failed" api:"required"`
// Items that were successfully applied.
Succeeded []OriginCloudRegionBulkDeleteResponseValueSucceeded `json:"succeeded" api:"required"`
JSON originCloudRegionBulkDeleteResponseValueJSON `json:"-"`
}
func (*OriginCloudRegionBulkDeleteResponseValue) UnmarshalJSON ¶ added in v6.10.0
func (r *OriginCloudRegionBulkDeleteResponseValue) UnmarshalJSON(data []byte) (err error)
type OriginCloudRegionBulkDeleteResponseValueFailed ¶ added in v6.10.0
type OriginCloudRegionBulkDeleteResponseValueFailed struct {
// The origin IP address for this item.
OriginIP string `json:"origin-ip" api:"required"`
// Error message explaining why the item failed. Present only on failed items.
Error string `json:"error"`
// Cloud vendor region identifier. Present on succeeded items for patch operations.
Region string `json:"region"`
// Cloud vendor identifier. Present on succeeded items for patch operations.
Vendor string `json:"vendor"`
JSON originCloudRegionBulkDeleteResponseValueFailedJSON `json:"-"`
}
Result for a single item in a batch operation.
func (*OriginCloudRegionBulkDeleteResponseValueFailed) UnmarshalJSON ¶ added in v6.10.0
func (r *OriginCloudRegionBulkDeleteResponseValueFailed) UnmarshalJSON(data []byte) (err error)
type OriginCloudRegionBulkDeleteResponseValueSucceeded ¶ added in v6.10.0
type OriginCloudRegionBulkDeleteResponseValueSucceeded struct {
// The origin IP address for this item.
OriginIP string `json:"origin-ip" api:"required"`
// Error message explaining why the item failed. Present only on failed items.
Error string `json:"error"`
// Cloud vendor region identifier. Present on succeeded items for patch operations.
Region string `json:"region"`
// Cloud vendor identifier. Present on succeeded items for patch operations.
Vendor string `json:"vendor"`
JSON originCloudRegionBulkDeleteResponseValueSucceededJSON `json:"-"`
}
Result for a single item in a batch operation.
func (*OriginCloudRegionBulkDeleteResponseValueSucceeded) UnmarshalJSON ¶ added in v6.10.0
func (r *OriginCloudRegionBulkDeleteResponseValueSucceeded) UnmarshalJSON(data []byte) (err error)
type OriginCloudRegionBulkEditParams ¶ added in v6.10.0
type OriginCloudRegionBulkEditParams struct {
// Identifier.
ZoneID param.Field[string] `path:"zone_id" api:"required"`
Body []OriginCloudRegionBulkEditParamsBody `json:"body" api:"required"`
}
func (OriginCloudRegionBulkEditParams) MarshalJSON ¶ added in v6.10.0
func (r OriginCloudRegionBulkEditParams) MarshalJSON() (data []byte, err error)
type OriginCloudRegionBulkEditParamsBody ¶ added in v6.10.0
type OriginCloudRegionBulkEditParamsBody struct {
// Origin IP address (IPv4 or IPv6). Normalized to canonical form before storage
// (RFC 5952 for IPv6).
IP param.Field[string] `json:"ip" api:"required"`
// Cloud vendor region identifier. Must be a valid region for the specified vendor
// as returned by the supported_regions endpoint.
Region param.Field[string] `json:"region" api:"required"`
// Cloud vendor hosting the origin. Must be one of the supported vendors.
Vendor param.Field[OriginCloudRegionBulkEditParamsBodyVendor] `json:"vendor" api:"required"`
}
Request body for creating or updating an origin cloud region mapping.
func (OriginCloudRegionBulkEditParamsBody) MarshalJSON ¶ added in v6.10.0
func (r OriginCloudRegionBulkEditParamsBody) MarshalJSON() (data []byte, err error)
type OriginCloudRegionBulkEditParamsBodyVendor ¶ added in v6.10.0
type OriginCloudRegionBulkEditParamsBodyVendor string
Cloud vendor hosting the origin. Must be one of the supported vendors.
const ( OriginCloudRegionBulkEditParamsBodyVendorAws OriginCloudRegionBulkEditParamsBodyVendor = "aws" OriginCloudRegionBulkEditParamsBodyVendorAzure OriginCloudRegionBulkEditParamsBodyVendor = "azure" OriginCloudRegionBulkEditParamsBodyVendorGcp OriginCloudRegionBulkEditParamsBodyVendor = "gcp" OriginCloudRegionBulkEditParamsBodyVendorOci OriginCloudRegionBulkEditParamsBodyVendor = "oci" )
func (OriginCloudRegionBulkEditParamsBodyVendor) IsKnown ¶ added in v6.10.0
func (r OriginCloudRegionBulkEditParamsBodyVendor) IsKnown() bool
type OriginCloudRegionBulkEditResponse ¶ added in v6.10.0
type OriginCloudRegionBulkEditResponse struct {
ID OriginCloudRegionBulkEditResponseID `json:"id" api:"required"`
// Whether the setting can be modified by the current user.
Editable bool `json:"editable" api:"required"`
Value OriginCloudRegionBulkEditResponseValue `json:"value" api:"required"`
// Time the mapping set was last modified. Null when no items were successfully
// applied.
ModifiedOn time.Time `json:"modified_on" api:"nullable" format:"date-time"`
JSON originCloudRegionBulkEditResponseJSON `json:"-"`
}
Response result for a batch origin cloud region operation.
func (*OriginCloudRegionBulkEditResponse) UnmarshalJSON ¶ added in v6.10.0
func (r *OriginCloudRegionBulkEditResponse) UnmarshalJSON(data []byte) (err error)
type OriginCloudRegionBulkEditResponseEnvelope ¶ added in v6.10.0
type OriginCloudRegionBulkEditResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors" api:"required"`
Messages []shared.ResponseInfo `json:"messages" api:"required"`
// Whether the API call was successful.
Success OriginCloudRegionBulkEditResponseEnvelopeSuccess `json:"success" api:"required"`
// Response result for a batch origin cloud region operation.
Result OriginCloudRegionBulkEditResponse `json:"result"`
JSON originCloudRegionBulkEditResponseEnvelopeJSON `json:"-"`
}
func (*OriginCloudRegionBulkEditResponseEnvelope) UnmarshalJSON ¶ added in v6.10.0
func (r *OriginCloudRegionBulkEditResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type OriginCloudRegionBulkEditResponseEnvelopeSuccess ¶ added in v6.10.0
type OriginCloudRegionBulkEditResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
OriginCloudRegionBulkEditResponseEnvelopeSuccessTrue OriginCloudRegionBulkEditResponseEnvelopeSuccess = true
)
func (OriginCloudRegionBulkEditResponseEnvelopeSuccess) IsKnown ¶ added in v6.10.0
func (r OriginCloudRegionBulkEditResponseEnvelopeSuccess) IsKnown() bool
type OriginCloudRegionBulkEditResponseID ¶ added in v6.10.0
type OriginCloudRegionBulkEditResponseID string
const (
OriginCloudRegionBulkEditResponseIDOriginPublicCloudRegion OriginCloudRegionBulkEditResponseID = "origin_public_cloud_region"
)
func (OriginCloudRegionBulkEditResponseID) IsKnown ¶ added in v6.10.0
func (r OriginCloudRegionBulkEditResponseID) IsKnown() bool
type OriginCloudRegionBulkEditResponseValue ¶ added in v6.10.0
type OriginCloudRegionBulkEditResponseValue struct {
// Items that could not be applied, with error details.
Failed []OriginCloudRegionBulkEditResponseValueFailed `json:"failed" api:"required"`
// Items that were successfully applied.
Succeeded []OriginCloudRegionBulkEditResponseValueSucceeded `json:"succeeded" api:"required"`
JSON originCloudRegionBulkEditResponseValueJSON `json:"-"`
}
func (*OriginCloudRegionBulkEditResponseValue) UnmarshalJSON ¶ added in v6.10.0
func (r *OriginCloudRegionBulkEditResponseValue) UnmarshalJSON(data []byte) (err error)
type OriginCloudRegionBulkEditResponseValueFailed ¶ added in v6.10.0
type OriginCloudRegionBulkEditResponseValueFailed struct {
// The origin IP address for this item.
OriginIP string `json:"origin-ip" api:"required"`
// Error message explaining why the item failed. Present only on failed items.
Error string `json:"error"`
// Cloud vendor region identifier. Present on succeeded items for patch operations.
Region string `json:"region"`
// Cloud vendor identifier. Present on succeeded items for patch operations.
Vendor string `json:"vendor"`
JSON originCloudRegionBulkEditResponseValueFailedJSON `json:"-"`
}
Result for a single item in a batch operation.
func (*OriginCloudRegionBulkEditResponseValueFailed) UnmarshalJSON ¶ added in v6.10.0
func (r *OriginCloudRegionBulkEditResponseValueFailed) UnmarshalJSON(data []byte) (err error)
type OriginCloudRegionBulkEditResponseValueSucceeded ¶ added in v6.10.0
type OriginCloudRegionBulkEditResponseValueSucceeded struct {
// The origin IP address for this item.
OriginIP string `json:"origin-ip" api:"required"`
// Error message explaining why the item failed. Present only on failed items.
Error string `json:"error"`
// Cloud vendor region identifier. Present on succeeded items for patch operations.
Region string `json:"region"`
// Cloud vendor identifier. Present on succeeded items for patch operations.
Vendor string `json:"vendor"`
JSON originCloudRegionBulkEditResponseValueSucceededJSON `json:"-"`
}
Result for a single item in a batch operation.
func (*OriginCloudRegionBulkEditResponseValueSucceeded) UnmarshalJSON ¶ added in v6.10.0
func (r *OriginCloudRegionBulkEditResponseValueSucceeded) UnmarshalJSON(data []byte) (err error)
type OriginCloudRegionDeleteParams ¶ added in v6.10.0
type OriginCloudRegionDeleteResponse ¶ added in v6.10.0
type OriginCloudRegionDeleteResponse struct {
ID OriginCloudRegionDeleteResponseID `json:"id" api:"required"`
// Whether the setting can be modified by the current user.
Editable bool `json:"editable" api:"required"`
// A single origin IP-to-cloud-region mapping.
Value OriginCloudRegion `json:"value" api:"required"`
// Time the mapping was last modified.
ModifiedOn time.Time `json:"modified_on" format:"date-time"`
JSON originCloudRegionDeleteResponseJSON `json:"-"`
}
Response result for a single origin cloud region mapping.
func (*OriginCloudRegionDeleteResponse) UnmarshalJSON ¶ added in v6.10.0
func (r *OriginCloudRegionDeleteResponse) UnmarshalJSON(data []byte) (err error)
type OriginCloudRegionDeleteResponseEnvelope ¶ added in v6.10.0
type OriginCloudRegionDeleteResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors" api:"required"`
Messages []shared.ResponseInfo `json:"messages" api:"required"`
// Whether the API call was successful.
Success OriginCloudRegionDeleteResponseEnvelopeSuccess `json:"success" api:"required"`
// Response result for a single origin cloud region mapping.
Result OriginCloudRegionDeleteResponse `json:"result"`
JSON originCloudRegionDeleteResponseEnvelopeJSON `json:"-"`
}
func (*OriginCloudRegionDeleteResponseEnvelope) UnmarshalJSON ¶ added in v6.10.0
func (r *OriginCloudRegionDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type OriginCloudRegionDeleteResponseEnvelopeSuccess ¶ added in v6.10.0
type OriginCloudRegionDeleteResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
OriginCloudRegionDeleteResponseEnvelopeSuccessTrue OriginCloudRegionDeleteResponseEnvelopeSuccess = true
)
func (OriginCloudRegionDeleteResponseEnvelopeSuccess) IsKnown ¶ added in v6.10.0
func (r OriginCloudRegionDeleteResponseEnvelopeSuccess) IsKnown() bool
type OriginCloudRegionDeleteResponseID ¶ added in v6.10.0
type OriginCloudRegionDeleteResponseID string
const (
OriginCloudRegionDeleteResponseIDOriginPublicCloudRegion OriginCloudRegionDeleteResponseID = "origin_public_cloud_region"
)
func (OriginCloudRegionDeleteResponseID) IsKnown ¶ added in v6.10.0
func (r OriginCloudRegionDeleteResponseID) IsKnown() bool
type OriginCloudRegionEditParams ¶ added in v6.10.0
type OriginCloudRegionEditParams struct {
// Identifier.
ZoneID param.Field[string] `path:"zone_id" api:"required"`
// Origin IP address (IPv4 or IPv6). Normalized to canonical form before storage
// (RFC 5952 for IPv6).
IP param.Field[string] `json:"ip" api:"required"`
// Cloud vendor region identifier. Must be a valid region for the specified vendor
// as returned by the supported_regions endpoint.
Region param.Field[string] `json:"region" api:"required"`
// Cloud vendor hosting the origin. Must be one of the supported vendors.
Vendor param.Field[OriginCloudRegionEditParamsVendor] `json:"vendor" api:"required"`
}
func (OriginCloudRegionEditParams) MarshalJSON ¶ added in v6.10.0
func (r OriginCloudRegionEditParams) MarshalJSON() (data []byte, err error)
type OriginCloudRegionEditParamsVendor ¶ added in v6.10.0
type OriginCloudRegionEditParamsVendor string
Cloud vendor hosting the origin. Must be one of the supported vendors.
const ( OriginCloudRegionEditParamsVendorAws OriginCloudRegionEditParamsVendor = "aws" OriginCloudRegionEditParamsVendorAzure OriginCloudRegionEditParamsVendor = "azure" OriginCloudRegionEditParamsVendorGcp OriginCloudRegionEditParamsVendor = "gcp" OriginCloudRegionEditParamsVendorOci OriginCloudRegionEditParamsVendor = "oci" )
func (OriginCloudRegionEditParamsVendor) IsKnown ¶ added in v6.10.0
func (r OriginCloudRegionEditParamsVendor) IsKnown() bool
type OriginCloudRegionEditResponse ¶ added in v6.10.0
type OriginCloudRegionEditResponse struct {
ID OriginCloudRegionEditResponseID `json:"id" api:"required"`
// Whether the setting can be modified by the current user.
Editable bool `json:"editable" api:"required"`
Value []OriginCloudRegion `json:"value" api:"required"`
// Time the mapping set was last modified. Null when no mappings exist.
ModifiedOn time.Time `json:"modified_on" api:"nullable" format:"date-time"`
JSON originCloudRegionEditResponseJSON `json:"-"`
}
Response result for a list of origin cloud region mappings.
func (*OriginCloudRegionEditResponse) UnmarshalJSON ¶ added in v6.10.0
func (r *OriginCloudRegionEditResponse) UnmarshalJSON(data []byte) (err error)
type OriginCloudRegionEditResponseEnvelope ¶ added in v6.10.0
type OriginCloudRegionEditResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors" api:"required"`
Messages []shared.ResponseInfo `json:"messages" api:"required"`
// Whether the API call was successful.
Success OriginCloudRegionEditResponseEnvelopeSuccess `json:"success" api:"required"`
// Response result for a list of origin cloud region mappings.
Result OriginCloudRegionEditResponse `json:"result"`
JSON originCloudRegionEditResponseEnvelopeJSON `json:"-"`
}
func (*OriginCloudRegionEditResponseEnvelope) UnmarshalJSON ¶ added in v6.10.0
func (r *OriginCloudRegionEditResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type OriginCloudRegionEditResponseEnvelopeSuccess ¶ added in v6.10.0
type OriginCloudRegionEditResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
OriginCloudRegionEditResponseEnvelopeSuccessTrue OriginCloudRegionEditResponseEnvelopeSuccess = true
)
func (OriginCloudRegionEditResponseEnvelopeSuccess) IsKnown ¶ added in v6.10.0
func (r OriginCloudRegionEditResponseEnvelopeSuccess) IsKnown() bool
type OriginCloudRegionEditResponseID ¶ added in v6.10.0
type OriginCloudRegionEditResponseID string
const (
OriginCloudRegionEditResponseIDOriginPublicCloudRegion OriginCloudRegionEditResponseID = "origin_public_cloud_region"
)
func (OriginCloudRegionEditResponseID) IsKnown ¶ added in v6.10.0
func (r OriginCloudRegionEditResponseID) IsKnown() bool
type OriginCloudRegionGetParams ¶ added in v6.10.0
type OriginCloudRegionGetResponse ¶ added in v6.10.0
type OriginCloudRegionGetResponse struct {
ID OriginCloudRegionGetResponseID `json:"id" api:"required"`
// Whether the setting can be modified by the current user.
Editable bool `json:"editable" api:"required"`
// A single origin IP-to-cloud-region mapping.
Value OriginCloudRegion `json:"value" api:"required"`
// Time the mapping was last modified.
ModifiedOn time.Time `json:"modified_on" format:"date-time"`
JSON originCloudRegionGetResponseJSON `json:"-"`
}
Response result for a single origin cloud region mapping.
func (*OriginCloudRegionGetResponse) UnmarshalJSON ¶ added in v6.10.0
func (r *OriginCloudRegionGetResponse) UnmarshalJSON(data []byte) (err error)
type OriginCloudRegionGetResponseEnvelope ¶ added in v6.10.0
type OriginCloudRegionGetResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors" api:"required"`
Messages []shared.ResponseInfo `json:"messages" api:"required"`
// Whether the API call was successful.
Success OriginCloudRegionGetResponseEnvelopeSuccess `json:"success" api:"required"`
// Response result for a single origin cloud region mapping.
Result OriginCloudRegionGetResponse `json:"result"`
JSON originCloudRegionGetResponseEnvelopeJSON `json:"-"`
}
func (*OriginCloudRegionGetResponseEnvelope) UnmarshalJSON ¶ added in v6.10.0
func (r *OriginCloudRegionGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type OriginCloudRegionGetResponseEnvelopeSuccess ¶ added in v6.10.0
type OriginCloudRegionGetResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
OriginCloudRegionGetResponseEnvelopeSuccessTrue OriginCloudRegionGetResponseEnvelopeSuccess = true
)
func (OriginCloudRegionGetResponseEnvelopeSuccess) IsKnown ¶ added in v6.10.0
func (r OriginCloudRegionGetResponseEnvelopeSuccess) IsKnown() bool
type OriginCloudRegionGetResponseID ¶ added in v6.10.0
type OriginCloudRegionGetResponseID string
const (
OriginCloudRegionGetResponseIDOriginPublicCloudRegion OriginCloudRegionGetResponseID = "origin_public_cloud_region"
)
func (OriginCloudRegionGetResponseID) IsKnown ¶ added in v6.10.0
func (r OriginCloudRegionGetResponseID) IsKnown() bool
type OriginCloudRegionListParams ¶ added in v6.10.0
type OriginCloudRegionListResponse ¶ added in v6.10.0
type OriginCloudRegionListResponse struct {
ID OriginCloudRegionListResponseID `json:"id" api:"required"`
// Whether the setting can be modified by the current user.
Editable bool `json:"editable" api:"required"`
Value []OriginCloudRegion `json:"value" api:"required"`
// Time the mapping set was last modified. Null when no mappings exist.
ModifiedOn time.Time `json:"modified_on" api:"nullable" format:"date-time"`
JSON originCloudRegionListResponseJSON `json:"-"`
}
Response result for a list of origin cloud region mappings.
func (*OriginCloudRegionListResponse) UnmarshalJSON ¶ added in v6.10.0
func (r *OriginCloudRegionListResponse) UnmarshalJSON(data []byte) (err error)
type OriginCloudRegionListResponseEnvelope ¶ added in v6.10.0
type OriginCloudRegionListResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors" api:"required"`
Messages []shared.ResponseInfo `json:"messages" api:"required"`
// Whether the API call was successful.
Success OriginCloudRegionListResponseEnvelopeSuccess `json:"success" api:"required"`
// Response result for a list of origin cloud region mappings.
Result OriginCloudRegionListResponse `json:"result"`
JSON originCloudRegionListResponseEnvelopeJSON `json:"-"`
}
func (*OriginCloudRegionListResponseEnvelope) UnmarshalJSON ¶ added in v6.10.0
func (r *OriginCloudRegionListResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type OriginCloudRegionListResponseEnvelopeSuccess ¶ added in v6.10.0
type OriginCloudRegionListResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
OriginCloudRegionListResponseEnvelopeSuccessTrue OriginCloudRegionListResponseEnvelopeSuccess = true
)
func (OriginCloudRegionListResponseEnvelopeSuccess) IsKnown ¶ added in v6.10.0
func (r OriginCloudRegionListResponseEnvelopeSuccess) IsKnown() bool
type OriginCloudRegionListResponseID ¶ added in v6.10.0
type OriginCloudRegionListResponseID string
const (
OriginCloudRegionListResponseIDOriginPublicCloudRegion OriginCloudRegionListResponseID = "origin_public_cloud_region"
)
func (OriginCloudRegionListResponseID) IsKnown ¶ added in v6.10.0
func (r OriginCloudRegionListResponseID) IsKnown() bool
type OriginCloudRegionNewParams ¶ added in v6.10.0
type OriginCloudRegionNewParams struct {
// Identifier.
ZoneID param.Field[string] `path:"zone_id" api:"required"`
// Origin IP address (IPv4 or IPv6). Normalized to canonical form before storage
// (RFC 5952 for IPv6).
IP param.Field[string] `json:"ip" api:"required"`
// Cloud vendor region identifier. Must be a valid region for the specified vendor
// as returned by the supported_regions endpoint.
Region param.Field[string] `json:"region" api:"required"`
// Cloud vendor hosting the origin. Must be one of the supported vendors.
Vendor param.Field[OriginCloudRegionNewParamsVendor] `json:"vendor" api:"required"`
}
func (OriginCloudRegionNewParams) MarshalJSON ¶ added in v6.10.0
func (r OriginCloudRegionNewParams) MarshalJSON() (data []byte, err error)
type OriginCloudRegionNewParamsVendor ¶ added in v6.10.0
type OriginCloudRegionNewParamsVendor string
Cloud vendor hosting the origin. Must be one of the supported vendors.
const ( OriginCloudRegionNewParamsVendorAws OriginCloudRegionNewParamsVendor = "aws" OriginCloudRegionNewParamsVendorAzure OriginCloudRegionNewParamsVendor = "azure" OriginCloudRegionNewParamsVendorGcp OriginCloudRegionNewParamsVendor = "gcp" OriginCloudRegionNewParamsVendorOci OriginCloudRegionNewParamsVendor = "oci" )
func (OriginCloudRegionNewParamsVendor) IsKnown ¶ added in v6.10.0
func (r OriginCloudRegionNewParamsVendor) IsKnown() bool
type OriginCloudRegionNewResponse ¶ added in v6.10.0
type OriginCloudRegionNewResponse struct {
ID OriginCloudRegionNewResponseID `json:"id" api:"required"`
// Whether the setting can be modified by the current user.
Editable bool `json:"editable" api:"required"`
// A single origin IP-to-cloud-region mapping.
Value OriginCloudRegion `json:"value" api:"required"`
// Time the mapping was last modified.
ModifiedOn time.Time `json:"modified_on" format:"date-time"`
JSON originCloudRegionNewResponseJSON `json:"-"`
}
Response result for a single origin cloud region mapping.
func (*OriginCloudRegionNewResponse) UnmarshalJSON ¶ added in v6.10.0
func (r *OriginCloudRegionNewResponse) UnmarshalJSON(data []byte) (err error)
type OriginCloudRegionNewResponseEnvelope ¶ added in v6.10.0
type OriginCloudRegionNewResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors" api:"required"`
Messages []shared.ResponseInfo `json:"messages" api:"required"`
// Whether the API call was successful.
Success OriginCloudRegionNewResponseEnvelopeSuccess `json:"success" api:"required"`
// Response result for a single origin cloud region mapping.
Result OriginCloudRegionNewResponse `json:"result"`
JSON originCloudRegionNewResponseEnvelopeJSON `json:"-"`
}
func (*OriginCloudRegionNewResponseEnvelope) UnmarshalJSON ¶ added in v6.10.0
func (r *OriginCloudRegionNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type OriginCloudRegionNewResponseEnvelopeSuccess ¶ added in v6.10.0
type OriginCloudRegionNewResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
OriginCloudRegionNewResponseEnvelopeSuccessTrue OriginCloudRegionNewResponseEnvelopeSuccess = true
)
func (OriginCloudRegionNewResponseEnvelopeSuccess) IsKnown ¶ added in v6.10.0
func (r OriginCloudRegionNewResponseEnvelopeSuccess) IsKnown() bool
type OriginCloudRegionNewResponseID ¶ added in v6.10.0
type OriginCloudRegionNewResponseID string
const (
OriginCloudRegionNewResponseIDOriginPublicCloudRegion OriginCloudRegionNewResponseID = "origin_public_cloud_region"
)
func (OriginCloudRegionNewResponseID) IsKnown ¶ added in v6.10.0
func (r OriginCloudRegionNewResponseID) IsKnown() bool
type OriginCloudRegionService ¶ added in v6.10.0
type OriginCloudRegionService struct {
Options []option.RequestOption
}
OriginCloudRegionService 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 NewOriginCloudRegionService method instead.
func NewOriginCloudRegionService ¶ added in v6.10.0
func NewOriginCloudRegionService(opts ...option.RequestOption) (r *OriginCloudRegionService)
NewOriginCloudRegionService 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 (*OriginCloudRegionService) BulkDelete ¶ added in v6.10.0
func (r *OriginCloudRegionService) BulkDelete(ctx context.Context, body OriginCloudRegionBulkDeleteParams, opts ...option.RequestOption) (res *OriginCloudRegionBulkDeleteResponse, err error)
Removes up to 100 IP-to-cloud-region mappings in a single request. Each IP is validated independently — successfully deleted items are returned in the `succeeded` array and IPs that could not be found or are invalid are returned in the `failed` array.
func (*OriginCloudRegionService) BulkEdit ¶ added in v6.10.0
func (r *OriginCloudRegionService) BulkEdit(ctx context.Context, params OriginCloudRegionBulkEditParams, opts ...option.RequestOption) (res *OriginCloudRegionBulkEditResponse, err error)
Adds or updates up to 100 IP-to-cloud-region mappings in a single request. Each item is validated independently — valid items are applied and invalid items are returned in the `failed` array. The vendor and region for every item are validated against the list from `GET /zones/{zone_id}/cache/origin_cloud_regions/supported_regions`.
func (*OriginCloudRegionService) Delete ¶ added in v6.10.0
func (r *OriginCloudRegionService) Delete(ctx context.Context, originIP string, body OriginCloudRegionDeleteParams, opts ...option.RequestOption) (res *OriginCloudRegionDeleteResponse, err error)
Removes the cloud region mapping for a single origin IP address. The IP path parameter is normalized before lookup. Returns the deleted entry on success. Returns 404 (code 1163) if no mapping exists for the specified IP. When the last mapping for the zone is removed the underlying rule record is also deleted.
func (*OriginCloudRegionService) Edit ¶ added in v6.10.0
func (r *OriginCloudRegionService) Edit(ctx context.Context, params OriginCloudRegionEditParams, opts ...option.RequestOption) (res *OriginCloudRegionEditResponse, err error)
Adds or updates a single IP-to-cloud-region mapping for the zone. Unlike POST, this operation is idempotent — if a mapping for the IP already exists it is overwritten. Returns the complete updated list of all mappings for the zone. Returns 403 (code 1164) when the zone has reached the limit of 3,500 IP mappings.
func (*OriginCloudRegionService) Get ¶ added in v6.10.0
func (r *OriginCloudRegionService) Get(ctx context.Context, originIP string, query OriginCloudRegionGetParams, opts ...option.RequestOption) (res *OriginCloudRegionGetResponse, err error)
Returns the cloud region mapping for a single origin IP address. The IP path parameter is normalized before lookup (RFC 5952 for IPv6). Returns 404 (code 1142) if the zone has no mappings or if the specified IP has no mapping.
func (*OriginCloudRegionService) List ¶ added in v6.10.0
func (r *OriginCloudRegionService) List(ctx context.Context, query OriginCloudRegionListParams, opts ...option.RequestOption) (res *OriginCloudRegionListResponse, err error)
Returns all IP-to-cloud-region mappings configured for the zone. Each mapping tells Cloudflare which cloud vendor and region hosts the origin at that IP, enabling the edge to route via the nearest Tiered Cache upper-tier co-located with that cloud provider. Returns an empty array when no mappings exist.
func (*OriginCloudRegionService) New ¶ added in v6.10.0
func (r *OriginCloudRegionService) New(ctx context.Context, params OriginCloudRegionNewParams, opts ...option.RequestOption) (res *OriginCloudRegionNewResponse, err error)
Adds a single IP-to-cloud-region mapping for the zone. The IP must be a valid IPv4 or IPv6 address and is normalized to canonical form before storage (RFC 5952 for IPv6). Returns 400 (code 1145) if a mapping for that IP already exists — use PATCH to update an existing entry. The vendor and region are validated against the list from `GET /zones/{zone_id}/cache/origin_cloud_regions/supported_regions`.
func (*OriginCloudRegionService) SupportedRegions ¶ added in v6.10.0
func (r *OriginCloudRegionService) SupportedRegions(ctx context.Context, query OriginCloudRegionSupportedRegionsParams, opts ...option.RequestOption) (res *OriginCloudRegionSupportedRegionsResponse, err error)
Returns the cloud vendors and regions that are valid values for origin cloud region mappings. Each region includes the Tiered Cache upper-tier colocation codes that will be used for cache routing when a mapping targeting that region is active. Requires the zone to have Tiered Cache enabled.
type OriginCloudRegionSupportedRegionsParams ¶ added in v6.10.0
type OriginCloudRegionSupportedRegionsResponse ¶ added in v6.10.0
type OriginCloudRegionSupportedRegionsResponse struct {
// Whether Cloudflare airport codes (IATA colo identifiers) were successfully
// resolved for the `upper_tier_colos` field on each region. When `false`, the
// `upper_tier_colos` arrays may be empty or incomplete.
ObtainedCodes bool `json:"obtained_codes" api:"required"`
// Map of vendor name to list of supported regions.
Vendors map[string][]OriginCloudRegionSupportedRegionsResponseVendor `json:"vendors" api:"required"`
JSON originCloudRegionSupportedRegionsResponseJSON `json:"-"`
}
Cloud vendors and their supported regions for origin cloud region mappings.
func (*OriginCloudRegionSupportedRegionsResponse) UnmarshalJSON ¶ added in v6.10.0
func (r *OriginCloudRegionSupportedRegionsResponse) UnmarshalJSON(data []byte) (err error)
type OriginCloudRegionSupportedRegionsResponseEnvelope ¶ added in v6.10.0
type OriginCloudRegionSupportedRegionsResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors" api:"required"`
Messages []shared.ResponseInfo `json:"messages" api:"required"`
// Whether the API call was successful.
Success OriginCloudRegionSupportedRegionsResponseEnvelopeSuccess `json:"success" api:"required"`
// Cloud vendors and their supported regions for origin cloud region mappings.
Result OriginCloudRegionSupportedRegionsResponse `json:"result"`
JSON originCloudRegionSupportedRegionsResponseEnvelopeJSON `json:"-"`
}
func (*OriginCloudRegionSupportedRegionsResponseEnvelope) UnmarshalJSON ¶ added in v6.10.0
func (r *OriginCloudRegionSupportedRegionsResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type OriginCloudRegionSupportedRegionsResponseEnvelopeSuccess ¶ added in v6.10.0
type OriginCloudRegionSupportedRegionsResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
OriginCloudRegionSupportedRegionsResponseEnvelopeSuccessTrue OriginCloudRegionSupportedRegionsResponseEnvelopeSuccess = true
)
func (OriginCloudRegionSupportedRegionsResponseEnvelopeSuccess) IsKnown ¶ added in v6.10.0
func (r OriginCloudRegionSupportedRegionsResponseEnvelopeSuccess) IsKnown() bool
type OriginCloudRegionSupportedRegionsResponseVendor ¶ added in v6.10.0
type OriginCloudRegionSupportedRegionsResponseVendor struct {
// Cloud vendor region identifier.
Name string `json:"name" api:"required"`
// Cloudflare Tiered Cache upper-tier colocation codes co-located with this cloud
// region. Requests from zones with a matching origin mapping will be routed
// through these colos.
UpperTierColos []string `json:"upper_tier_colos" api:"required"`
JSON originCloudRegionSupportedRegionsResponseVendorJSON `json:"-"`
}
A single supported cloud region with associated Tiered Cache upper-tier colocations.
func (*OriginCloudRegionSupportedRegionsResponseVendor) UnmarshalJSON ¶ added in v6.10.0
func (r *OriginCloudRegionSupportedRegionsResponseVendor) UnmarshalJSON(data []byte) (err error)
type OriginCloudRegionVendor ¶ added in v6.10.0
type OriginCloudRegionVendor string
Cloud vendor hosting the origin.
const ( OriginCloudRegionVendorAws OriginCloudRegionVendor = "aws" OriginCloudRegionVendorAzure OriginCloudRegionVendor = "azure" OriginCloudRegionVendorGcp OriginCloudRegionVendor = "gcp" OriginCloudRegionVendorOci OriginCloudRegionVendor = "oci" )
func (OriginCloudRegionVendor) IsKnown ¶ added in v6.10.0
func (r OriginCloudRegionVendor) IsKnown() bool
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 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 RegionalTieredCache ¶
type RegionalTieredCache string
The identifier of the caching 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" api:"required"`
// Value of the Regional Tiered Cache zone setting.
Value param.Field[RegionalTieredCacheEditParamsValue] `json:"value" api:"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 {
// The identifier of the caching setting.
ID RegionalTieredCache `json:"id" api:"required"`
// Whether the setting is editable.
Editable bool `json:"editable" api:"required"`
// Value of the Regional Tiered Cache zone setting.
Value RegionalTieredCacheEditResponseValue `json:"value" api:"required"`
// Last time this setting was modified.
ModifiedOn time.Time `json:"modified_on" api:"nullable" format:"date-time"`
JSON regionalTieredCacheEditResponseJSON `json:"-"`
}
func (*RegionalTieredCacheEditResponse) UnmarshalJSON ¶
func (r *RegionalTieredCacheEditResponse) UnmarshalJSON(data []byte) (err error)
type RegionalTieredCacheEditResponseEnvelope ¶
type RegionalTieredCacheEditResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors" api:"required"`
Messages []shared.ResponseInfo `json:"messages" api:"required"`
// Whether the API call was successful.
Success RegionalTieredCacheEditResponseEnvelopeSuccess `json:"success" api:"required"`
Result RegionalTieredCacheEditResponse `json:"result"`
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 string
Value of the Regional Tiered Cache zone setting.
const ( RegionalTieredCacheEditResponseValueOn RegionalTieredCacheEditResponseValue = "on" RegionalTieredCacheEditResponseValueOff RegionalTieredCacheEditResponseValue = "off" )
func (RegionalTieredCacheEditResponseValue) IsKnown ¶
func (r RegionalTieredCacheEditResponseValue) IsKnown() bool
type RegionalTieredCacheGetResponse ¶
type RegionalTieredCacheGetResponse struct {
// The identifier of the caching setting.
ID RegionalTieredCache `json:"id" api:"required"`
// Whether the setting is editable.
Editable bool `json:"editable" api:"required"`
// Value of the Regional Tiered Cache zone setting.
Value RegionalTieredCacheGetResponseValue `json:"value" api:"required"`
// Last time this setting was modified.
ModifiedOn time.Time `json:"modified_on" api:"nullable" format:"date-time"`
JSON regionalTieredCacheGetResponseJSON `json:"-"`
}
func (*RegionalTieredCacheGetResponse) UnmarshalJSON ¶
func (r *RegionalTieredCacheGetResponse) UnmarshalJSON(data []byte) (err error)
type RegionalTieredCacheGetResponseEnvelope ¶
type RegionalTieredCacheGetResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors" api:"required"`
Messages []shared.ResponseInfo `json:"messages" api:"required"`
// Whether the API call was successful.
Success RegionalTieredCacheGetResponseEnvelopeSuccess `json:"success" api:"required"`
Result RegionalTieredCacheGetResponse `json:"result"`
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 string
Value of the Regional Tiered Cache zone setting.
const ( RegionalTieredCacheGetResponseValueOn RegionalTieredCacheGetResponseValue = "on" RegionalTieredCacheGetResponseValueOff RegionalTieredCacheGetResponseValue = "off" )
func (RegionalTieredCacheGetResponseValue) IsKnown ¶
func (r RegionalTieredCacheGetResponseValue) IsKnown() bool
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 ResponseInfoSource ¶
type ResponseInfoSource = shared.ResponseInfoSource
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 SmartTieredCacheDeleteResponse ¶
type SmartTieredCacheDeleteResponse struct {
// The identifier of the caching setting.
ID SmartTieredCacheDeleteResponseID `json:"id" api:"required"`
// Whether the setting is editable.
Editable bool `json:"editable" api:"required"`
// Last time this setting was modified.
ModifiedOn time.Time `json:"modified_on" api:"nullable" format:"date-time"`
JSON smartTieredCacheDeleteResponseJSON `json:"-"`
}
func (*SmartTieredCacheDeleteResponse) UnmarshalJSON ¶
func (r *SmartTieredCacheDeleteResponse) UnmarshalJSON(data []byte) (err error)
type SmartTieredCacheDeleteResponseEnvelope ¶
type SmartTieredCacheDeleteResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors" api:"required"`
Messages []shared.ResponseInfo `json:"messages" api:"required"`
// Whether the API call was successful.
Success SmartTieredCacheDeleteResponseEnvelopeSuccess `json:"success" api:"required"`
Result SmartTieredCacheDeleteResponse `json:"result"`
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 SmartTieredCacheDeleteResponseID ¶
type SmartTieredCacheDeleteResponseID string
The identifier of the caching setting.
const (
SmartTieredCacheDeleteResponseIDTieredCacheSmartTopologyEnable SmartTieredCacheDeleteResponseID = "tiered_cache_smart_topology_enable"
)
func (SmartTieredCacheDeleteResponseID) IsKnown ¶
func (r SmartTieredCacheDeleteResponseID) IsKnown() bool
type SmartTieredCacheEditParams ¶
type SmartTieredCacheEditParams struct {
// Identifier.
ZoneID param.Field[string] `path:"zone_id" api:"required"`
// Enable or disable the Smart Tiered Cache.
Value param.Field[SmartTieredCacheEditParamsValue] `json:"value" api:"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 SmartTieredCacheEditResponseID `json:"id" api:"required"`
// Whether the setting is editable.
Editable bool `json:"editable" api:"required"`
// Value of the Smart Tiered Cache zone setting.
Value SmartTieredCacheEditResponseValue `json:"value" api:"required"`
// Last time this setting was modified.
ModifiedOn time.Time `json:"modified_on" api:"nullable" format:"date-time"`
JSON smartTieredCacheEditResponseJSON `json:"-"`
}
func (*SmartTieredCacheEditResponse) UnmarshalJSON ¶
func (r *SmartTieredCacheEditResponse) UnmarshalJSON(data []byte) (err error)
type SmartTieredCacheEditResponseEnvelope ¶
type SmartTieredCacheEditResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors" api:"required"`
Messages []shared.ResponseInfo `json:"messages" api:"required"`
// Whether the API call was successful.
Success SmartTieredCacheEditResponseEnvelopeSuccess `json:"success" api:"required"`
Result SmartTieredCacheEditResponse `json:"result"`
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 SmartTieredCacheEditResponseID ¶
type SmartTieredCacheEditResponseID string
The identifier of the caching setting.
const (
SmartTieredCacheEditResponseIDTieredCacheSmartTopologyEnable SmartTieredCacheEditResponseID = "tiered_cache_smart_topology_enable"
)
func (SmartTieredCacheEditResponseID) IsKnown ¶
func (r SmartTieredCacheEditResponseID) IsKnown() bool
type SmartTieredCacheEditResponseValue ¶
type SmartTieredCacheEditResponseValue string
Value of the Smart Tiered Cache zone setting.
const ( SmartTieredCacheEditResponseValueOn SmartTieredCacheEditResponseValue = "on" SmartTieredCacheEditResponseValueOff SmartTieredCacheEditResponseValue = "off" )
func (SmartTieredCacheEditResponseValue) IsKnown ¶
func (r SmartTieredCacheEditResponseValue) IsKnown() bool
type SmartTieredCacheGetResponse ¶
type SmartTieredCacheGetResponse struct {
// The identifier of the caching setting.
ID SmartTieredCacheGetResponseID `json:"id" api:"required"`
// Whether the setting is editable.
Editable bool `json:"editable" api:"required"`
// Value of the Smart Tiered Cache zone setting.
Value SmartTieredCacheGetResponseValue `json:"value" api:"required"`
// Last time this setting was modified.
ModifiedOn time.Time `json:"modified_on" api:"nullable" format:"date-time"`
JSON smartTieredCacheGetResponseJSON `json:"-"`
}
func (*SmartTieredCacheGetResponse) UnmarshalJSON ¶
func (r *SmartTieredCacheGetResponse) UnmarshalJSON(data []byte) (err error)
type SmartTieredCacheGetResponseEnvelope ¶
type SmartTieredCacheGetResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors" api:"required"`
Messages []shared.ResponseInfo `json:"messages" api:"required"`
// Whether the API call was successful.
Success SmartTieredCacheGetResponseEnvelopeSuccess `json:"success" api:"required"`
Result SmartTieredCacheGetResponse `json:"result"`
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 SmartTieredCacheGetResponseID ¶
type SmartTieredCacheGetResponseID string
The identifier of the caching setting.
const (
SmartTieredCacheGetResponseIDTieredCacheSmartTopologyEnable SmartTieredCacheGetResponseID = "tiered_cache_smart_topology_enable"
)
func (SmartTieredCacheGetResponseID) IsKnown ¶
func (r SmartTieredCacheGetResponseID) IsKnown() bool
type SmartTieredCacheGetResponseValue ¶
type SmartTieredCacheGetResponseValue string
Value of the Smart Tiered Cache zone setting.
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)
Smart Tiered Cache dynamically selects the single closest upper tier for each of your website’s origins with no configuration required, using our in-house performance and routing data. Cloudflare collects latency data for each request to an origin, and uses the latency data to determine how well any upper-tier data center is connected with an origin. As a result, Cloudflare can select the data center with the lowest latency to be the upper-tier for an origin.
func (*SmartTieredCacheService) Edit ¶
func (r *SmartTieredCacheService) Edit(ctx context.Context, params SmartTieredCacheEditParams, opts ...option.RequestOption) (res *SmartTieredCacheEditResponse, err error)
Smart Tiered Cache dynamically selects the single closest upper tier for each of your website’s origins with no configuration required, using our in-house performance and routing data. Cloudflare collects latency data for each request to an origin, and uses the latency data to determine how well any upper-tier data center is connected with an origin. As a result, Cloudflare can select the data center with the lowest latency to be the upper-tier for an origin.
func (*SmartTieredCacheService) Get ¶
func (r *SmartTieredCacheService) Get(ctx context.Context, query SmartTieredCacheGetParams, opts ...option.RequestOption) (res *SmartTieredCacheGetResponse, err error)
Smart Tiered Cache dynamically selects the single closest upper tier for each of your website’s origins with no configuration required, using our in-house performance and routing data. Cloudflare collects latency data for each request to an origin, and uses the latency data to determine how well any upper-tier data center is connected with an origin. As a result, Cloudflare can select the data center with the lowest latency to be the upper-tier for an origin.
type SortDirection ¶
type SortDirection = shared.SortDirection
Direction to order DNS records in.
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 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 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 VariantDeleteParams ¶
type VariantDeleteResponse ¶
type VariantDeleteResponse struct {
// The identifier of the caching setting.
ID VariantDeleteResponseID `json:"id" api:"required"`
// Whether the setting is editable.
Editable bool `json:"editable" api:"required"`
// Last time this setting was modified.
ModifiedOn time.Time `json:"modified_on" api:"nullable" format:"date-time"`
JSON variantDeleteResponseJSON `json:"-"`
}
func (*VariantDeleteResponse) UnmarshalJSON ¶
func (r *VariantDeleteResponse) UnmarshalJSON(data []byte) (err error)
type VariantDeleteResponseEnvelope ¶
type VariantDeleteResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors" api:"required"`
Messages []shared.ResponseInfo `json:"messages" api:"required"`
// Whether the API call was successful.
Success VariantDeleteResponseEnvelopeSuccess `json:"success" api:"required"`
Result VariantDeleteResponse `json:"result"`
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 VariantDeleteResponseID ¶
type VariantDeleteResponseID string
The identifier of the caching setting.
const (
VariantDeleteResponseIDVariants VariantDeleteResponseID = "variants"
)
func (VariantDeleteResponseID) IsKnown ¶
func (r VariantDeleteResponseID) IsKnown() bool
type VariantEditParams ¶
type VariantEditParams struct {
// Identifier.
ZoneID param.Field[string] `path:"zone_id" api:"required"`
// Value of the zone setting.
Value param.Field[VariantEditParamsValue] `json:"value" api:"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 {
// The identifier of the caching setting.
ID VariantEditResponseID `json:"id" api:"required"`
// Whether the setting is editable.
Editable bool `json:"editable" api:"required"`
// Value of the zone setting.
Value VariantEditResponseValue `json:"value" api:"required"`
// Last time this setting was modified.
ModifiedOn time.Time `json:"modified_on" api:"nullable" format:"date-time"`
JSON variantEditResponseJSON `json:"-"`
}
func (*VariantEditResponse) UnmarshalJSON ¶
func (r *VariantEditResponse) UnmarshalJSON(data []byte) (err error)
type VariantEditResponseEnvelope ¶
type VariantEditResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors" api:"required"`
Messages []shared.ResponseInfo `json:"messages" api:"required"`
// Whether the API call was successful.
Success VariantEditResponseEnvelopeSuccess `json:"success" api:"required"`
Result VariantEditResponse `json:"result"`
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 VariantEditResponseID ¶
type VariantEditResponseID string
The identifier of the caching setting.
const (
VariantEditResponseIDVariants VariantEditResponseID = "variants"
)
func (VariantEditResponseID) IsKnown ¶
func (r VariantEditResponseID) 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 VariantGetResponse ¶
type VariantGetResponse struct {
// The identifier of the caching setting.
ID VariantGetResponseID `json:"id" api:"required"`
// Whether the setting is editable.
Editable bool `json:"editable" api:"required"`
// Value of the zone setting.
Value VariantGetResponseValue `json:"value" api:"required"`
// Last time this setting was modified.
ModifiedOn time.Time `json:"modified_on" api:"nullable" format:"date-time"`
JSON variantGetResponseJSON `json:"-"`
}
func (*VariantGetResponse) UnmarshalJSON ¶
func (r *VariantGetResponse) UnmarshalJSON(data []byte) (err error)
type VariantGetResponseEnvelope ¶
type VariantGetResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors" api:"required"`
Messages []shared.ResponseInfo `json:"messages" api:"required"`
// Whether the API call was successful.
Success VariantGetResponseEnvelopeSuccess `json:"success" api:"required"`
Result VariantGetResponse `json:"result"`
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 VariantGetResponseID ¶
type VariantGetResponseID string
The identifier of the caching setting.
const (
VariantGetResponseIDVariants VariantGetResponseID = "variants"
)
func (VariantGetResponseID) IsKnown ¶
func (r VariantGetResponseID) 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 *VariantDeleteResponse, 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.