cloud_connector

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 CloudConnectorService ¶

type CloudConnectorService struct {
	Options []option.RequestOption
	Rules   *RuleService
}

CloudConnectorService 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 NewCloudConnectorService method instead.

func NewCloudConnectorService(opts ...option.RequestOption) (r *CloudConnectorService)

type CloudflareTunnel ¶

type CloudflareTunnel = shared.CloudflareTunnel

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

This is an alias to an internal type.

type CloudflareTunnelConnection ¶

type CloudflareTunnelConnection = shared.CloudflareTunnelConnection

This is an alias to an internal type.

type CloudflareTunnelStatus ¶

type CloudflareTunnelStatus = shared.CloudflareTunnelStatus

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

This is an alias to an internal type.

type CloudflareTunnelTunType ¶

type CloudflareTunnelTunType = shared.CloudflareTunnelTunType

The type of tunnel.

This is an alias to an internal type.

type Error ¶

type Error = apierror.Error

type ErrorData ¶

type ErrorData = shared.ErrorData

This is an alias to an internal type.

type MemberParam ¶

type MemberParam = shared.MemberParam

This is an alias to an internal type.

type MemberRoleParam ¶

type MemberRoleParam = shared.MemberRoleParam

This is an alias to an internal type.

type MemberRolesPermissionsParam ¶

type MemberRolesPermissionsParam = shared.MemberRolesPermissionsParam

This is an alias to an internal type.

type MemberStatus ¶

type MemberStatus = shared.MemberStatus

A member's status in the account.

This is an alias to an internal type.

type MemberUserParam ¶

type MemberUserParam = shared.MemberUserParam

Details of the user associated to the membership.

This is an alias to an internal type.

type Permission ¶

type Permission = shared.Permission

This is an alias to an internal type.

type PermissionGrant ¶

type PermissionGrant = shared.PermissionGrant

This is an alias to an internal type.

type PermissionGrantParam ¶

type PermissionGrantParam = shared.PermissionGrantParam

This is an alias to an internal type.

type 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 RuleListParams ¶

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

type RuleListResponse ¶

type RuleListResponse struct {
	ID          string `json:"id"`
	Description string `json:"description"`
	Enabled     bool   `json:"enabled"`
	Expression  string `json:"expression"`
	// Parameters of Cloud Connector Rule
	Parameters RuleListResponseParameters `json:"parameters"`
	// Cloud Provider type
	Provider RuleListResponseProvider `json:"provider"`
	JSON     ruleListResponseJSON     `json:"-"`
}

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

type RuleListResponseParameters ¶

type RuleListResponseParameters struct {
	// Host to perform Cloud Connection to
	Host string                         `json:"host"`
	JSON ruleListResponseParametersJSON `json:"-"`
}

Parameters of Cloud Connector Rule

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

type RuleListResponseProvider ¶

type RuleListResponseProvider string

Cloud Provider type

const (
	RuleListResponseProviderAwsS3        RuleListResponseProvider = "aws_s3"
	RuleListResponseProviderR2           RuleListResponseProvider = "r2"
	RuleListResponseProviderGcpStorage   RuleListResponseProvider = "gcp_storage"
	RuleListResponseProviderAzureStorage RuleListResponseProvider = "azure_storage"
)

func (r RuleListResponseProvider) IsKnown() bool

type RuleService ¶

type RuleService struct {
	Options []option.RequestOption
}

RuleService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewRuleService method instead.

func NewRuleService(opts ...option.RequestOption) (r *RuleService)

func (r *RuleService) List(ctx context.Context, query RuleListParams, opts ...option.RequestOption) (res *pagination.SinglePage[RuleListResponse], err error)

func (r *RuleService) ListAutoPaging(ctx context.Context, query RuleListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[RuleListResponse]

func (r *RuleService) Update(ctx context.Context, params RuleUpdateParams, opts ...option.RequestOption) (res *[]RuleUpdateResponse, err error)

type RuleUpdateParams ¶

type RuleUpdateParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	// List of Cloud Connector rules
	Body []RuleUpdateParamsBody `json:"body,required"`
}

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

type RuleUpdateParamsBody ¶

type RuleUpdateParamsBody struct {
	ID          param.Field[string] `json:"id"`
	Description param.Field[string] `json:"description"`
	Enabled     param.Field[bool]   `json:"enabled"`
	Expression  param.Field[string] `json:"expression"`
	// Parameters of Cloud Connector Rule
	Parameters param.Field[RuleUpdateParamsBodyParameters] `json:"parameters"`
	// Cloud Provider type
	Provider param.Field[RuleUpdateParamsBodyProvider] `json:"provider"`
}

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

type RuleUpdateParamsBodyParameters ¶

type RuleUpdateParamsBodyParameters struct {
	// Host to perform Cloud Connection to
	Host param.Field[string] `json:"host"`
}

Parameters of Cloud Connector Rule

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

type RuleUpdateParamsBodyProvider ¶

type RuleUpdateParamsBodyProvider string

Cloud Provider type

const (
	RuleUpdateParamsBodyProviderAwsS3        RuleUpdateParamsBodyProvider = "aws_s3"
	RuleUpdateParamsBodyProviderR2           RuleUpdateParamsBodyProvider = "r2"
	RuleUpdateParamsBodyProviderGcpStorage   RuleUpdateParamsBodyProvider = "gcp_storage"
	RuleUpdateParamsBodyProviderAzureStorage RuleUpdateParamsBodyProvider = "azure_storage"
)

func (r RuleUpdateParamsBodyProvider) IsKnown() bool

type RuleUpdateResponse ¶

type RuleUpdateResponse struct {
	ID          string `json:"id"`
	Description string `json:"description"`
	Enabled     bool   `json:"enabled"`
	Expression  string `json:"expression"`
	// Parameters of Cloud Connector Rule
	Parameters RuleUpdateResponseParameters `json:"parameters"`
	// Cloud Provider type
	Provider RuleUpdateResponseProvider `json:"provider"`
	JSON     ruleUpdateResponseJSON     `json:"-"`
}

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

type RuleUpdateResponseEnvelope ¶

type RuleUpdateResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Whether the API call was successful
	Success RuleUpdateResponseEnvelopeSuccess `json:"success,required"`
	// List of Cloud Connector rules
	Result []RuleUpdateResponse           `json:"result"`
	JSON   ruleUpdateResponseEnvelopeJSON `json:"-"`
}

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

type RuleUpdateResponseEnvelopeSuccess ¶

type RuleUpdateResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	RuleUpdateResponseEnvelopeSuccessTrue RuleUpdateResponseEnvelopeSuccess = true
)

func (r RuleUpdateResponseEnvelopeSuccess) IsKnown() bool

type RuleUpdateResponseParameters ¶

type RuleUpdateResponseParameters struct {
	// Host to perform Cloud Connection to
	Host string                           `json:"host"`
	JSON ruleUpdateResponseParametersJSON `json:"-"`
}

Parameters of Cloud Connector Rule

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

type RuleUpdateResponseProvider ¶

type RuleUpdateResponseProvider string

Cloud Provider type

const (
	RuleUpdateResponseProviderAwsS3        RuleUpdateResponseProvider = "aws_s3"
	RuleUpdateResponseProviderR2           RuleUpdateResponseProvider = "r2"
	RuleUpdateResponseProviderGcpStorage   RuleUpdateResponseProvider = "gcp_storage"
	RuleUpdateResponseProviderAzureStorage RuleUpdateResponseProvider = "azure_storage"
)

func (r RuleUpdateResponseProvider) IsKnown() bool

type SortDirection ¶

type SortDirection = shared.SortDirection

Direction to order DNS records in.

This is an alias to an internal type.