managed_transforms

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 CloudflareTunnelConnection
• type CloudflareTunnelStatus
• type CloudflareTunnelTunType
• type Error
• type ErrorData
• type ManagedTransformEditParams
  • func (r ManagedTransformEditParams) MarshalJSON() (data []byte, err error)
• type ManagedTransformEditResponse
  • func (r *ManagedTransformEditResponse) UnmarshalJSON(data []byte) (err error)
• type ManagedTransformEditResponseManagedRequestHeader
  • func (r *ManagedTransformEditResponseManagedRequestHeader) UnmarshalJSON(data []byte) (err error)
• type ManagedTransformEditResponseManagedResponseHeader
  • func (r *ManagedTransformEditResponseManagedResponseHeader) UnmarshalJSON(data []byte) (err error)
• type ManagedTransformListParams
• type ManagedTransformListResponse
  • func (r *ManagedTransformListResponse) UnmarshalJSON(data []byte) (err error)
• type ManagedTransformService
  • func NewManagedTransformService(opts ...option.RequestOption) (r *ManagedTransformService)
  • func (r *ManagedTransformService) Edit(ctx context.Context, params ManagedTransformEditParams, ...) (res *ManagedTransformEditResponse, err error)
  • func (r *ManagedTransformService) List(ctx context.Context, query ManagedTransformListParams, ...) (res *ManagedTransformListResponse, err error)
• type MemberParam
• type MemberRoleParam
• type MemberRolesPermissionsParam
• type MemberStatus
• type MemberUserParam
• type Permission
• type PermissionGrant
• type PermissionGrantParam
• type RatePlan
• type RatePlanParam
• type RequestModel
  • func (r *RequestModel) UnmarshalJSON(data []byte) (err error)
• type RequestModelParam
  • func (r RequestModelParam) MarshalJSON() (data []byte, err error)
• type ResponseInfo
• type Role
• type SortDirection
• type Subscription
• type SubscriptionFrequency
• type SubscriptionParam
• type SubscriptionState

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

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

Types

type ASN

type ASN = shared.ASN

This is an alias to an internal type.

type ASNParam

type ASNParam = shared.ASNParam

This is an alias to an internal type.

type AuditLog

type AuditLog = shared.AuditLog

This is an alias to an internal type.

type AuditLogAction

type AuditLogAction = shared.AuditLogAction

This is an alias to an internal type.

type AuditLogActor

type AuditLogActor = shared.AuditLogActor

This is an alias to an internal type.

type AuditLogActorType

type AuditLogActorType = shared.AuditLogActorType

The type of actor, whether a User, Cloudflare Admin, or an Automated System.

This is an alias to an internal type.

type AuditLogOwner

type AuditLogOwner = shared.AuditLogOwner

This is an alias to an internal type.

type AuditLogResource

type AuditLogResource = shared.AuditLogResource

This is an alias to an internal type.

type CertificateCA

type CertificateCA = shared.CertificateCA

The Certificate Authority that will issue the certificate

This is an alias to an internal type.

type CertificateRequestType

type CertificateRequestType = shared.CertificateRequestType

Signature type desired on certificate ("origin-rsa" (rsa), "origin-ecc" (ecdsa), or "keyless-certificate" (for Keyless SSL servers).

This is an alias to an internal type.

type CloudflareTunnel

type CloudflareTunnel = shared.CloudflareTunnel

A Cloudflare Tunnel that connects your origin to Cloudflare's edge.

This is an alias to an internal type.

type CloudflareTunnelConnection

type CloudflareTunnelConnection = shared.CloudflareTunnelConnection

This is an alias to an internal type.

type CloudflareTunnelStatus

type CloudflareTunnelStatus = shared.CloudflareTunnelStatus

The status of the tunnel. Valid values are `inactive` (tunnel has never been run), `degraded` (tunnel is active and able to serve traffic but in an unhealthy state), `healthy` (tunnel is active and able to serve traffic), or `down` (tunnel can not serve traffic as it has no connections to the Cloudflare Edge).

This is an alias to an internal type.

type CloudflareTunnelTunType

type CloudflareTunnelTunType = shared.CloudflareTunnelTunType

The type of tunnel.

This is an alias to an internal type.

type Error

type Error = apierror.Error

type ErrorData

type ErrorData = shared.ErrorData

This is an alias to an internal type.

type ManagedTransformEditParams

type ManagedTransformEditParams struct {
	// Identifier
	ZoneID                 param.Field[string]              `path:"zone_id,required"`
	ManagedRequestHeaders  param.Field[[]RequestModelParam] `json:"managed_request_headers,required"`
	ManagedResponseHeaders param.Field[[]RequestModelParam] `json:"managed_response_headers,required"`
}

func (ManagedTransformEditParams) MarshalJSON

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

type ManagedTransformEditResponse

type ManagedTransformEditResponse struct {
	ManagedRequestHeaders  []ManagedTransformEditResponseManagedRequestHeader  `json:"managed_request_headers"`
	ManagedResponseHeaders []ManagedTransformEditResponseManagedResponseHeader `json:"managed_response_headers"`
	JSON                   managedTransformEditResponseJSON                    `json:"-"`
}

func (*ManagedTransformEditResponse) UnmarshalJSON

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

type ManagedTransformEditResponseManagedRequestHeader

type ManagedTransformEditResponseManagedRequestHeader struct {
	// Human-readable identifier of the Managed Transform.
	ID string `json:"id"`
	// When true, the Managed Transform is available in the current Cloudflare plan.
	Available bool `json:"available"`
	// When true, the Managed Transform is enabled.
	Enabled bool                                                 `json:"enabled"`
	JSON    managedTransformEditResponseManagedRequestHeaderJSON `json:"-"`
}

func (*ManagedTransformEditResponseManagedRequestHeader) UnmarshalJSON

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

type ManagedTransformEditResponseManagedResponseHeader

type ManagedTransformEditResponseManagedResponseHeader struct {
	// Human-readable identifier of the Managed Transform.
	ID string `json:"id"`
	// When true, the Managed Transform is available in the current Cloudflare plan.
	Available bool `json:"available"`
	// When true, the Managed Transform is enabled.
	Enabled bool                                                  `json:"enabled"`
	JSON    managedTransformEditResponseManagedResponseHeaderJSON `json:"-"`
}

func (*ManagedTransformEditResponseManagedResponseHeader) UnmarshalJSON

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

type ManagedTransformListParams

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

type ManagedTransformListResponse

type ManagedTransformListResponse struct {
	ManagedRequestHeaders  []RequestModel                   `json:"managed_request_headers"`
	ManagedResponseHeaders []RequestModel                   `json:"managed_response_headers"`
	JSON                   managedTransformListResponseJSON `json:"-"`
}

func (*ManagedTransformListResponse) UnmarshalJSON

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

type ManagedTransformService

type ManagedTransformService struct {
	Options []option.RequestOption
}

ManagedTransformService 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 NewManagedTransformService method instead.

func NewManagedTransformService

func NewManagedTransformService(opts ...option.RequestOption) (r *ManagedTransformService)

NewManagedTransformService 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 (*ManagedTransformService) Edit

func (r *ManagedTransformService) Edit(ctx context.Context, params ManagedTransformEditParams, opts ...option.RequestOption) (res *ManagedTransformEditResponse, err error)

Updates the status of one or more Managed Transforms.

func (*ManagedTransformService) List

func (r *ManagedTransformService) List(ctx context.Context, query ManagedTransformListParams, opts ...option.RequestOption) (res *ManagedTransformListResponse, err error)

Fetches a list of all Managed Transforms.

type MemberParam

type MemberParam = shared.MemberParam

This is an alias to an internal type.

type MemberRoleParam

type MemberRoleParam = shared.MemberRoleParam

This is an alias to an internal type.

type MemberRolesPermissionsParam

type MemberRolesPermissionsParam = shared.MemberRolesPermissionsParam

This is an alias to an internal type.

type MemberStatus

type MemberStatus = shared.MemberStatus

A member's status in the account.

This is an alias to an internal type.

type MemberUserParam

type MemberUserParam = shared.MemberUserParam

Details of the user associated to the membership.

This is an alias to an internal type.

type Permission

type Permission = shared.Permission

This is an alias to an internal type.

type PermissionGrant

type PermissionGrant = shared.PermissionGrant

This is an alias to an internal type.

type PermissionGrantParam

type PermissionGrantParam = shared.PermissionGrantParam

This is an alias to an internal type.

type RatePlan

type RatePlan = shared.RatePlan

The rate plan applied to the subscription.

This is an alias to an internal type.

type RatePlanParam

type RatePlanParam = shared.RatePlanParam

The rate plan applied to the subscription.

This is an alias to an internal type.

type RequestModel

type RequestModel struct {
	// Human-readable identifier of the Managed Transform.
	ID string `json:"id"`
	// When true, the Managed Transform is enabled.
	Enabled bool             `json:"enabled"`
	JSON    requestModelJSON `json:"-"`
}

func (*RequestModel) UnmarshalJSON

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

type RequestModelParam

type RequestModelParam struct {
	// Human-readable identifier of the Managed Transform.
	ID param.Field[string] `json:"id"`
	// When true, the Managed Transform is enabled.
	Enabled param.Field[bool] `json:"enabled"`
}

func (RequestModelParam) MarshalJSON

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

type ResponseInfo

type ResponseInfo = shared.ResponseInfo

This is an alias to an internal type.

type Role

type Role = shared.Role

This is an alias to an internal type.

type SortDirection

type SortDirection = shared.SortDirection

Direction to order DNS records in.

This is an alias to an internal type.

type Subscription

type Subscription = shared.Subscription

This is an alias to an internal type.

type SubscriptionFrequency

type SubscriptionFrequency = shared.SubscriptionFrequency

How often the subscription is renewed automatically.

This is an alias to an internal type.

type SubscriptionParam

type SubscriptionParam = shared.SubscriptionParam

This is an alias to an internal type.

type SubscriptionState

type SubscriptionState = shared.SubscriptionState

The state that the subscription is in.

This is an alias to an internal type.