argo

package
v2.4.0 Latest Latest
Warning

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

 Go to latest Published: Jul 16, 2024 License: Apache-2.0 Imports: 13 Imported by: 0

Documentation

Index

Constants

View Source 
const AuditLogActorTypeAdmin = shared.AuditLogActorTypeAdmin

This is an alias to an internal value.

View Source 
const AuditLogActorTypeCloudflare = shared.AuditLogActorTypeCloudflare

This is an alias to an internal value.

View Source 
const AuditLogActorTypeUser = shared.AuditLogActorTypeUser

This is an alias to an internal value.

View Source 
const CertificateCADigicert = shared.CertificateCADigicert

This is an alias to an internal value.

View Source 
const CertificateCAGoogle = shared.CertificateCAGoogle

This is an alias to an internal value.

View Source 
const CertificateCALetsEncrypt = shared.CertificateCALetsEncrypt

This is an alias to an internal value.

View Source 
const CertificateRequestTypeKeylessCertificate = shared.CertificateRequestTypeKeylessCertificate

This is an alias to an internal value.

View Source 
const CertificateRequestTypeOriginECC = shared.CertificateRequestTypeOriginECC

This is an alias to an internal value.

View Source 
const CertificateRequestTypeOriginRSA = shared.CertificateRequestTypeOriginRSA

This is an alias to an internal value.

View Source 
const CloudflareTunnelStatusDegraded = shared.CloudflareTunnelStatusDegraded

This is an alias to an internal value.

View Source 
const CloudflareTunnelStatusDown = shared.CloudflareTunnelStatusDown

This is an alias to an internal value.

View Source 
const CloudflareTunnelStatusHealthy = shared.CloudflareTunnelStatusHealthy

This is an alias to an internal value.

View Source 
const CloudflareTunnelStatusInactive = shared.CloudflareTunnelStatusInactive

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeCNI = shared.CloudflareTunnelTunTypeCNI

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeCfdTunnel = shared.CloudflareTunnelTunTypeCfdTunnel

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeGRE = shared.CloudflareTunnelTunTypeGRE

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeIPSec = shared.CloudflareTunnelTunTypeIPSec

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeWARPConnector = shared.CloudflareTunnelTunTypeWARPConnector

This is an alias to an internal value.

View Source 
const MemberStatusAccepted = shared.MemberStatusAccepted

This is an alias to an internal value.

View Source 
const MemberStatusPending = shared.MemberStatusPending

This is an alias to an internal value.

View Source 
const SortDirectionAsc = shared.SortDirectionAsc

This is an alias to an internal value.

View Source 
const SortDirectionDesc = shared.SortDirectionDesc

This is an alias to an internal value.

Variables

This section is empty.

Functions

This section is empty.

Types

type ASN added in v2.1.0 

type ASN = shared.ASN

This is an alias to an internal type.

type ASNParam added in v2.1.0 

type ASNParam = shared.ASNParam

This is an alias to an internal type.

type ArgoService 

type ArgoService struct {
	Options       []option.RequestOption
	SmartRouting  *SmartRoutingService
	TieredCaching *TieredCachingService
}

ArgoService 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 NewArgoService method instead.

func NewArgoService 

func NewArgoService(opts ...option.RequestOption) (r *ArgoService)

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

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 added in v2.2.0 

type CertificateCA = shared.CertificateCA

The Certificate Authority that will issue the certificate

This is an alias to an internal type.

type CertificateRequestType added in v2.2.0 

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 added in v2.3.0 

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 added in v2.1.0 

type MemberParam = shared.MemberParam

This is an alias to an internal type.

type MemberRoleParam added in v2.1.0 

type MemberRoleParam = shared.MemberRoleParam

This is an alias to an internal type.

type MemberRolesPermissionsParam added in v2.1.0 

type MemberRolesPermissionsParam = shared.MemberRolesPermissionsParam

This is an alias to an internal type.

type MemberStatus added in v2.3.0 

type MemberStatus = shared.MemberStatus

A member's status in the account.

This is an alias to an internal type.

type MemberUserParam added in v2.1.0 

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 SmartRoutingEditParams 

type SmartRoutingEditParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	// Enables Argo Smart Routing.
	Value param.Field[SmartRoutingEditParamsValue] `json:"value,required"`
}

func (SmartRoutingEditParams) MarshalJSON 

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

type SmartRoutingEditParamsValue 

type SmartRoutingEditParamsValue string

Enables Argo Smart Routing. 

const (
	SmartRoutingEditParamsValueOn  SmartRoutingEditParamsValue = "on"
	SmartRoutingEditParamsValueOff SmartRoutingEditParamsValue = "off"
)

func (SmartRoutingEditParamsValue) IsKnown 

func (r SmartRoutingEditParamsValue) IsKnown() bool

type SmartRoutingEditResponseEnvelope 

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

func (*SmartRoutingEditResponseEnvelope) UnmarshalJSON 

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

type SmartRoutingEditResponseEnvelopeSuccess 

type SmartRoutingEditResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	SmartRoutingEditResponseEnvelopeSuccessTrue SmartRoutingEditResponseEnvelopeSuccess = true
)

func (SmartRoutingEditResponseEnvelopeSuccess) IsKnown 

func (r SmartRoutingEditResponseEnvelopeSuccess) IsKnown() bool

type SmartRoutingEditResponseUnion 

type SmartRoutingEditResponseUnion interface {
	ImplementsArgoSmartRoutingEditResponseUnion()
}

Union satisfied by argo.SmartRoutingEditResponseUnknown or shared.UnionString.

type SmartRoutingGetParams 

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

type SmartRoutingGetResponseEnvelope 

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

func (*SmartRoutingGetResponseEnvelope) UnmarshalJSON 

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

type SmartRoutingGetResponseEnvelopeSuccess 

type SmartRoutingGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	SmartRoutingGetResponseEnvelopeSuccessTrue SmartRoutingGetResponseEnvelopeSuccess = true
)

func (SmartRoutingGetResponseEnvelopeSuccess) IsKnown 

func (r SmartRoutingGetResponseEnvelopeSuccess) IsKnown() bool

type SmartRoutingGetResponseUnion 

type SmartRoutingGetResponseUnion interface {
	ImplementsArgoSmartRoutingGetResponseUnion()
}

Union satisfied by argo.SmartRoutingGetResponseUnknown or shared.UnionString.

type SmartRoutingService 

type SmartRoutingService struct {
	Options []option.RequestOption
}

SmartRoutingService 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 NewSmartRoutingService method instead.

func NewSmartRoutingService 

func NewSmartRoutingService(opts ...option.RequestOption) (r *SmartRoutingService)

NewSmartRoutingService 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 (*SmartRoutingService) Edit 

func (r *SmartRoutingService) Edit(ctx context.Context, params SmartRoutingEditParams, opts ...option.RequestOption) (res *SmartRoutingEditResponseUnion, err error)

Updates enablement of Argo Smart Routing.

func (*SmartRoutingService) Get 

func (r *SmartRoutingService) Get(ctx context.Context, query SmartRoutingGetParams, opts ...option.RequestOption) (res *SmartRoutingGetResponseUnion, err error)

Get Argo Smart Routing setting

type SortDirection added in v2.2.0 

type SortDirection = shared.SortDirection

Direction to order DNS records in.

This is an alias to an internal type.

type TieredCachingEditParams 

type TieredCachingEditParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	// Enables Tiered Caching.
	Value param.Field[TieredCachingEditParamsValue] `json:"value,required"`
}

func (TieredCachingEditParams) MarshalJSON 

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

type TieredCachingEditParamsValue 

type TieredCachingEditParamsValue string

Enables Tiered Caching. 

const (
	TieredCachingEditParamsValueOn  TieredCachingEditParamsValue = "on"
	TieredCachingEditParamsValueOff TieredCachingEditParamsValue = "off"
)

func (TieredCachingEditParamsValue) IsKnown 

func (r TieredCachingEditParamsValue) IsKnown() bool

type TieredCachingEditResponse added in v2.3.0 

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

func (*TieredCachingEditResponse) UnmarshalJSON added in v2.3.0 

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

type TieredCachingEditResponseEnvelope 

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

func (*TieredCachingEditResponseEnvelope) UnmarshalJSON 

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

type TieredCachingEditResponseEnvelopeSuccess 

type TieredCachingEditResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	TieredCachingEditResponseEnvelopeSuccessTrue TieredCachingEditResponseEnvelopeSuccess = true
)

func (TieredCachingEditResponseEnvelopeSuccess) IsKnown 

func (r TieredCachingEditResponseEnvelopeSuccess) IsKnown() bool

type TieredCachingEditResponseValue added in v2.3.0 

type TieredCachingEditResponseValue string

The status of the feature being on / off 

const (
	TieredCachingEditResponseValueOn  TieredCachingEditResponseValue = "on"
	TieredCachingEditResponseValueOff TieredCachingEditResponseValue = "off"
)

func (TieredCachingEditResponseValue) IsKnown added in v2.3.0 

func (r TieredCachingEditResponseValue) IsKnown() bool

type TieredCachingGetParams 

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

type TieredCachingGetResponse added in v2.3.0 

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

func (*TieredCachingGetResponse) UnmarshalJSON added in v2.3.0 

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

type TieredCachingGetResponseEnvelope 

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

func (*TieredCachingGetResponseEnvelope) UnmarshalJSON 

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

type TieredCachingGetResponseEnvelopeSuccess 

type TieredCachingGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	TieredCachingGetResponseEnvelopeSuccessTrue TieredCachingGetResponseEnvelopeSuccess = true
)

func (TieredCachingGetResponseEnvelopeSuccess) IsKnown 

func (r TieredCachingGetResponseEnvelopeSuccess) IsKnown() bool

type TieredCachingGetResponseValue added in v2.3.0 

type TieredCachingGetResponseValue string

The status of the feature being on / off 

const (
	TieredCachingGetResponseValueOn  TieredCachingGetResponseValue = "on"
	TieredCachingGetResponseValueOff TieredCachingGetResponseValue = "off"
)

func (TieredCachingGetResponseValue) IsKnown added in v2.3.0 

func (r TieredCachingGetResponseValue) IsKnown() bool

type TieredCachingService 

type TieredCachingService struct {
	Options []option.RequestOption
}

TieredCachingService 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 NewTieredCachingService method instead.

func NewTieredCachingService 

func NewTieredCachingService(opts ...option.RequestOption) (r *TieredCachingService)

NewTieredCachingService 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 (*TieredCachingService) Edit 

func (r *TieredCachingService) Edit(ctx context.Context, params TieredCachingEditParams, opts ...option.RequestOption) (res *TieredCachingEditResponse, err error)

Updates enablement of Tiered Caching

func (*TieredCachingService) Get 

func (r *TieredCachingService) Get(ctx context.Context, query TieredCachingGetParams, opts ...option.RequestOption) (res *TieredCachingGetResponse, err error)

Get Tiered Caching setting

Source Files

View all Source files

Jump to

Keyboard shortcuts

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