Documentation
¶
Index ¶
- Constants
- type ASN
- type ASNParam
- type AuditLog
- type AuditLogAction
- type AuditLogActor
- type AuditLogActorType
- type AuditLogOwner
- type AuditLogResource
- type CertificateCA
- type CertificateRequestType
- type CloudflareTunnel
- type CloudflareTunnelConfigSrc
- type CloudflareTunnelConnection
- type CloudflareTunnelStatus
- type CloudflareTunnelTunType
- type ContentScanningDisableParams
- type ContentScanningDisableResponse
- type ContentScanningDisableResponseEnvelope
- type ContentScanningDisableResponseEnvelopeSuccess
- type ContentScanningEnableParams
- type ContentScanningEnableResponse
- type ContentScanningEnableResponseEnvelope
- type ContentScanningEnableResponseEnvelopeSuccess
- type ContentScanningGetParams
- type ContentScanningGetResponse
- type ContentScanningGetResponseEnvelope
- type ContentScanningGetResponseEnvelopeSuccess
- type ContentScanningNewParams
- type ContentScanningNewParamsValue
- type ContentScanningNewResponse
- type ContentScanningNewResponseEnvelope
- type ContentScanningNewResponseEnvelopeSuccess
- type ContentScanningService
- func (r *ContentScanningService) Disable(ctx context.Context, body ContentScanningDisableParams, ...) (res *ContentScanningDisableResponse, err error)
- func (r *ContentScanningService) Enable(ctx context.Context, body ContentScanningEnableParams, ...) (res *ContentScanningEnableResponse, err error)
- func (r *ContentScanningService) Get(ctx context.Context, query ContentScanningGetParams, ...) (res *ContentScanningGetResponse, err error)
- func (r *ContentScanningService) New(ctx context.Context, params ContentScanningNewParams, ...) (res *ContentScanningNewResponse, err error)
- func (r *ContentScanningService) Update(ctx context.Context, params ContentScanningUpdateParams, ...) (res *ContentScanningUpdateResponse, err error)
- type ContentScanningUpdateParams
- type ContentScanningUpdateParamsValue
- type ContentScanningUpdateResponse
- type ContentScanningUpdateResponseEnvelope
- type ContentScanningUpdateResponseEnvelopeSuccess
- 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 PayloadDeleteParams
- type PayloadDeleteResponse
- type PayloadListParams
- type PayloadListResponse
- type PayloadNewParams
- type PayloadNewParamsBody
- type PayloadNewResponse
- type PayloadService
- func (r *PayloadService) Delete(ctx context.Context, expressionID string, body PayloadDeleteParams, ...) (res *pagination.SinglePage[PayloadDeleteResponse], err error)
- func (r *PayloadService) DeleteAutoPaging(ctx context.Context, expressionID string, body PayloadDeleteParams, ...) *pagination.SinglePageAutoPager[PayloadDeleteResponse]
- func (r *PayloadService) List(ctx context.Context, query PayloadListParams, opts ...option.RequestOption) (res *pagination.SinglePage[PayloadListResponse], err error)
- func (r *PayloadService) ListAutoPaging(ctx context.Context, query PayloadListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[PayloadListResponse]
- func (r *PayloadService) New(ctx context.Context, params PayloadNewParams, opts ...option.RequestOption) (res *pagination.SinglePage[PayloadNewResponse], err error)
- func (r *PayloadService) NewAutoPaging(ctx context.Context, params PayloadNewParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[PayloadNewResponse]
- type Permission
- type PermissionGrant
- type PermissionGrantParam
- type RatePlan
- type RatePlanID
- type RatePlanParam
- type ResponseInfo
- type ResponseInfoSource
- type Role
- type RoleParam
- type RolePermissions
- type RolePermissionsParam
- type SettingGetParams
- type SettingGetResponse
- type SettingGetResponseEnvelope
- type SettingGetResponseEnvelopeSuccess
- type SettingService
- type SortDirection
- 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
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 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 ContentScanningDisableResponse ¶
type ContentScanningDisableResponse = interface{}
type ContentScanningDisableResponseEnvelope ¶
type ContentScanningDisableResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
Result ContentScanningDisableResponse `json:"result,required"`
// Whether the API call was successful.
Success ContentScanningDisableResponseEnvelopeSuccess `json:"success,required"`
JSON contentScanningDisableResponseEnvelopeJSON `json:"-"`
}
func (*ContentScanningDisableResponseEnvelope) UnmarshalJSON ¶
func (r *ContentScanningDisableResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type ContentScanningDisableResponseEnvelopeSuccess ¶
type ContentScanningDisableResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
ContentScanningDisableResponseEnvelopeSuccessTrue ContentScanningDisableResponseEnvelopeSuccess = true
)
func (ContentScanningDisableResponseEnvelopeSuccess) IsKnown ¶
func (r ContentScanningDisableResponseEnvelopeSuccess) IsKnown() bool
type ContentScanningEnableResponse ¶
type ContentScanningEnableResponse = interface{}
type ContentScanningEnableResponseEnvelope ¶
type ContentScanningEnableResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
Result ContentScanningEnableResponse `json:"result,required"`
// Whether the API call was successful.
Success ContentScanningEnableResponseEnvelopeSuccess `json:"success,required"`
JSON contentScanningEnableResponseEnvelopeJSON `json:"-"`
}
func (*ContentScanningEnableResponseEnvelope) UnmarshalJSON ¶
func (r *ContentScanningEnableResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type ContentScanningEnableResponseEnvelopeSuccess ¶
type ContentScanningEnableResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
ContentScanningEnableResponseEnvelopeSuccessTrue ContentScanningEnableResponseEnvelopeSuccess = true
)
func (ContentScanningEnableResponseEnvelopeSuccess) IsKnown ¶
func (r ContentScanningEnableResponseEnvelopeSuccess) IsKnown() bool
type ContentScanningGetParams ¶ added in v6.2.0
type ContentScanningGetResponse ¶ added in v6.2.0
type ContentScanningGetResponse struct {
// Defines the last modification date (ISO 8601) of the Content Scanning status.
Modified string `json:"modified"`
// Defines the status of Content Scanning.
Value string `json:"value"`
JSON contentScanningGetResponseJSON `json:"-"`
}
Defines the status for Content Scanning.
func (*ContentScanningGetResponse) UnmarshalJSON ¶ added in v6.2.0
func (r *ContentScanningGetResponse) UnmarshalJSON(data []byte) (err error)
type ContentScanningGetResponseEnvelope ¶ added in v6.2.0
type ContentScanningGetResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
// Defines the status for Content Scanning.
Result ContentScanningGetResponse `json:"result,required"`
// Whether the API call was successful.
Success ContentScanningGetResponseEnvelopeSuccess `json:"success,required"`
JSON contentScanningGetResponseEnvelopeJSON `json:"-"`
}
func (*ContentScanningGetResponseEnvelope) UnmarshalJSON ¶ added in v6.2.0
func (r *ContentScanningGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type ContentScanningGetResponseEnvelopeSuccess ¶ added in v6.2.0
type ContentScanningGetResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
ContentScanningGetResponseEnvelopeSuccessTrue ContentScanningGetResponseEnvelopeSuccess = true
)
func (ContentScanningGetResponseEnvelopeSuccess) IsKnown ¶ added in v6.2.0
func (r ContentScanningGetResponseEnvelopeSuccess) IsKnown() bool
type ContentScanningNewParams ¶ added in v6.2.0
type ContentScanningNewParams struct {
// Defines an identifier.
ZoneID param.Field[string] `path:"zone_id,required"`
// The status value for Content Scanning.
Value param.Field[ContentScanningNewParamsValue] `json:"value,required"`
}
func (ContentScanningNewParams) MarshalJSON ¶ added in v6.2.0
func (r ContentScanningNewParams) MarshalJSON() (data []byte, err error)
type ContentScanningNewParamsValue ¶ added in v6.2.0
type ContentScanningNewParamsValue string
The status value for Content Scanning.
const ( ContentScanningNewParamsValueEnabled ContentScanningNewParamsValue = "enabled" ContentScanningNewParamsValueDisabled ContentScanningNewParamsValue = "disabled" )
func (ContentScanningNewParamsValue) IsKnown ¶ added in v6.2.0
func (r ContentScanningNewParamsValue) IsKnown() bool
type ContentScanningNewResponse ¶ added in v6.2.0
type ContentScanningNewResponse struct {
// Defines the last modification date (ISO 8601) of the Content Scanning status.
Modified string `json:"modified"`
// Defines the status of Content Scanning.
Value string `json:"value"`
JSON contentScanningNewResponseJSON `json:"-"`
}
Defines the status for Content Scanning.
func (*ContentScanningNewResponse) UnmarshalJSON ¶ added in v6.2.0
func (r *ContentScanningNewResponse) UnmarshalJSON(data []byte) (err error)
type ContentScanningNewResponseEnvelope ¶ added in v6.2.0
type ContentScanningNewResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
// Defines the status for Content Scanning.
Result ContentScanningNewResponse `json:"result,required"`
// Whether the API call was successful.
Success ContentScanningNewResponseEnvelopeSuccess `json:"success,required"`
JSON contentScanningNewResponseEnvelopeJSON `json:"-"`
}
func (*ContentScanningNewResponseEnvelope) UnmarshalJSON ¶ added in v6.2.0
func (r *ContentScanningNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type ContentScanningNewResponseEnvelopeSuccess ¶ added in v6.2.0
type ContentScanningNewResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
ContentScanningNewResponseEnvelopeSuccessTrue ContentScanningNewResponseEnvelopeSuccess = true
)
func (ContentScanningNewResponseEnvelopeSuccess) IsKnown ¶ added in v6.2.0
func (r ContentScanningNewResponseEnvelopeSuccess) IsKnown() bool
type ContentScanningService ¶
type ContentScanningService struct {
Options []option.RequestOption
Payloads *PayloadService
Settings *SettingService
}
ContentScanningService 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 NewContentScanningService method instead.
func NewContentScanningService ¶
func NewContentScanningService(opts ...option.RequestOption) (r *ContentScanningService)
NewContentScanningService 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 (*ContentScanningService) Disable ¶
func (r *ContentScanningService) Disable(ctx context.Context, body ContentScanningDisableParams, opts ...option.RequestOption) (res *ContentScanningDisableResponse, err error)
Disable Content Scanning.
func (*ContentScanningService) Enable ¶
func (r *ContentScanningService) Enable(ctx context.Context, body ContentScanningEnableParams, opts ...option.RequestOption) (res *ContentScanningEnableResponse, err error)
Enable Content Scanning.
func (*ContentScanningService) Get ¶ added in v6.2.0
func (r *ContentScanningService) Get(ctx context.Context, query ContentScanningGetParams, opts ...option.RequestOption) (res *ContentScanningGetResponse, err error)
Retrieve the current status of Content Scanning.
func (*ContentScanningService) New ¶ added in v6.2.0
func (r *ContentScanningService) New(ctx context.Context, params ContentScanningNewParams, opts ...option.RequestOption) (res *ContentScanningNewResponse, err error)
Update the Content Scanning status.
func (*ContentScanningService) Update ¶ added in v6.2.0
func (r *ContentScanningService) Update(ctx context.Context, params ContentScanningUpdateParams, opts ...option.RequestOption) (res *ContentScanningUpdateResponse, err error)
Update the Content Scanning status.
type ContentScanningUpdateParams ¶ added in v6.2.0
type ContentScanningUpdateParams struct {
// Defines an identifier.
ZoneID param.Field[string] `path:"zone_id,required"`
// The status value for Content Scanning.
Value param.Field[ContentScanningUpdateParamsValue] `json:"value,required"`
}
func (ContentScanningUpdateParams) MarshalJSON ¶ added in v6.2.0
func (r ContentScanningUpdateParams) MarshalJSON() (data []byte, err error)
type ContentScanningUpdateParamsValue ¶ added in v6.2.0
type ContentScanningUpdateParamsValue string
The status value for Content Scanning.
const ( ContentScanningUpdateParamsValueEnabled ContentScanningUpdateParamsValue = "enabled" ContentScanningUpdateParamsValueDisabled ContentScanningUpdateParamsValue = "disabled" )
func (ContentScanningUpdateParamsValue) IsKnown ¶ added in v6.2.0
func (r ContentScanningUpdateParamsValue) IsKnown() bool
type ContentScanningUpdateResponse ¶ added in v6.2.0
type ContentScanningUpdateResponse struct {
// Defines the last modification date (ISO 8601) of the Content Scanning status.
Modified string `json:"modified"`
// Defines the status of Content Scanning.
Value string `json:"value"`
JSON contentScanningUpdateResponseJSON `json:"-"`
}
Defines the status for Content Scanning.
func (*ContentScanningUpdateResponse) UnmarshalJSON ¶ added in v6.2.0
func (r *ContentScanningUpdateResponse) UnmarshalJSON(data []byte) (err error)
type ContentScanningUpdateResponseEnvelope ¶ added in v6.2.0
type ContentScanningUpdateResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
// Defines the status for Content Scanning.
Result ContentScanningUpdateResponse `json:"result,required"`
// Whether the API call was successful.
Success ContentScanningUpdateResponseEnvelopeSuccess `json:"success,required"`
JSON contentScanningUpdateResponseEnvelopeJSON `json:"-"`
}
func (*ContentScanningUpdateResponseEnvelope) UnmarshalJSON ¶ added in v6.2.0
func (r *ContentScanningUpdateResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type ContentScanningUpdateResponseEnvelopeSuccess ¶ added in v6.2.0
type ContentScanningUpdateResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
ContentScanningUpdateResponseEnvelopeSuccessTrue ContentScanningUpdateResponseEnvelopeSuccess = true
)
func (ContentScanningUpdateResponseEnvelopeSuccess) IsKnown ¶ added in v6.2.0
func (r ContentScanningUpdateResponseEnvelopeSuccess) IsKnown() bool
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 PayloadDeleteParams ¶
type PayloadDeleteResponse ¶
type PayloadDeleteResponse struct {
// defines the unique ID for this custom scan expression.
ID string `json:"id"`
// Defines the ruleset expression to use in matching content objects.
Payload string `json:"payload"`
JSON payloadDeleteResponseJSON `json:"-"`
}
Defines a custom scan expression to match Content Scanning on.
func (*PayloadDeleteResponse) UnmarshalJSON ¶
func (r *PayloadDeleteResponse) UnmarshalJSON(data []byte) (err error)
type PayloadListParams ¶
type PayloadListResponse ¶
type PayloadListResponse struct {
// defines the unique ID for this custom scan expression.
ID string `json:"id"`
// Defines the ruleset expression to use in matching content objects.
Payload string `json:"payload"`
JSON payloadListResponseJSON `json:"-"`
}
Defines a custom scan expression to match Content Scanning on.
func (*PayloadListResponse) UnmarshalJSON ¶
func (r *PayloadListResponse) UnmarshalJSON(data []byte) (err error)
type PayloadNewParams ¶
type PayloadNewParams struct {
// Defines an identifier.
ZoneID param.Field[string] `path:"zone_id,required"`
Body []PayloadNewParamsBody `json:"body,required"`
}
func (PayloadNewParams) MarshalJSON ¶
func (r PayloadNewParams) MarshalJSON() (data []byte, err error)
type PayloadNewParamsBody ¶
type PayloadNewParamsBody struct {
// Defines the ruleset expression to use in matching content objects.
Payload param.Field[string] `json:"payload,required"`
}
func (PayloadNewParamsBody) MarshalJSON ¶
func (r PayloadNewParamsBody) MarshalJSON() (data []byte, err error)
type PayloadNewResponse ¶
type PayloadNewResponse struct {
// defines the unique ID for this custom scan expression.
ID string `json:"id"`
// Defines the ruleset expression to use in matching content objects.
Payload string `json:"payload"`
JSON payloadNewResponseJSON `json:"-"`
}
Defines a custom scan expression to match Content Scanning on.
func (*PayloadNewResponse) UnmarshalJSON ¶
func (r *PayloadNewResponse) UnmarshalJSON(data []byte) (err error)
type PayloadService ¶
type PayloadService struct {
Options []option.RequestOption
}
PayloadService 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 NewPayloadService method instead.
func NewPayloadService ¶
func NewPayloadService(opts ...option.RequestOption) (r *PayloadService)
NewPayloadService 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 (*PayloadService) Delete ¶
func (r *PayloadService) Delete(ctx context.Context, expressionID string, body PayloadDeleteParams, opts ...option.RequestOption) (res *pagination.SinglePage[PayloadDeleteResponse], err error)
Delete a Content Scan Custom Expression.
func (*PayloadService) DeleteAutoPaging ¶
func (r *PayloadService) DeleteAutoPaging(ctx context.Context, expressionID string, body PayloadDeleteParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[PayloadDeleteResponse]
Delete a Content Scan Custom Expression.
func (*PayloadService) List ¶
func (r *PayloadService) List(ctx context.Context, query PayloadListParams, opts ...option.RequestOption) (res *pagination.SinglePage[PayloadListResponse], err error)
Get a list of existing custom scan expressions for Content Scanning.
func (*PayloadService) ListAutoPaging ¶
func (r *PayloadService) ListAutoPaging(ctx context.Context, query PayloadListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[PayloadListResponse]
Get a list of existing custom scan expressions for Content Scanning.
func (*PayloadService) New ¶
func (r *PayloadService) New(ctx context.Context, params PayloadNewParams, opts ...option.RequestOption) (res *pagination.SinglePage[PayloadNewResponse], err error)
Add custom scan expressions for Content Scanning.
func (*PayloadService) NewAutoPaging ¶
func (r *PayloadService) NewAutoPaging(ctx context.Context, params PayloadNewParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[PayloadNewResponse]
Add custom scan expressions for Content Scanning.
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 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 SettingGetParams ¶
type SettingGetResponse ¶
type SettingGetResponse struct {
// Defines the last modification date (ISO 8601) of the Content Scanning status.
Modified string `json:"modified"`
// Defines the status of Content Scanning.
Value string `json:"value"`
JSON settingGetResponseJSON `json:"-"`
}
Defines the status for Content Scanning.
func (*SettingGetResponse) UnmarshalJSON ¶
func (r *SettingGetResponse) UnmarshalJSON(data []byte) (err error)
type SettingGetResponseEnvelope ¶
type SettingGetResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
// Defines the status for Content Scanning.
Result SettingGetResponse `json:"result,required"`
// Whether the API call was successful.
Success SettingGetResponseEnvelopeSuccess `json:"success,required"`
JSON settingGetResponseEnvelopeJSON `json:"-"`
}
func (*SettingGetResponseEnvelope) UnmarshalJSON ¶
func (r *SettingGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type SettingGetResponseEnvelopeSuccess ¶
type SettingGetResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
SettingGetResponseEnvelopeSuccessTrue SettingGetResponseEnvelopeSuccess = true
)
func (SettingGetResponseEnvelopeSuccess) IsKnown ¶
func (r SettingGetResponseEnvelopeSuccess) IsKnown() bool
type SettingService ¶
type SettingService struct {
Options []option.RequestOption
}
SettingService 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 NewSettingService method instead.
func NewSettingService ¶
func NewSettingService(opts ...option.RequestOption) (r *SettingService)
NewSettingService 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 (*SettingService) Get ¶
func (r *SettingService) Get(ctx context.Context, query SettingGetParams, opts ...option.RequestOption) (res *SettingGetResponse, err error)
Retrieve the current status of Content Scanning.
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.