argo

package
v2.0.0-beta.9 Latest Latest
Warning

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

 Go to latest Published: Mar 18, 2024 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

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 Error 

type Error = apierror.Error

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"
)

type SmartRoutingEditResponse 

type SmartRoutingEditResponse interface {
	ImplementsArgoSmartRoutingEditResponse()
}

Union satisfied by argo.SmartRoutingEditResponseUnknown or shared.UnionString.

type SmartRoutingEditResponseEnvelope 

type SmartRoutingEditResponseEnvelope struct {
	Errors   []SmartRoutingEditResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SmartRoutingEditResponseEnvelopeMessages `json:"messages,required"`
	Result   SmartRoutingEditResponse                   `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 SmartRoutingEditResponseEnvelopeErrors 

type SmartRoutingEditResponseEnvelopeErrors struct {
	Code    int64                                      `json:"code,required"`
	Message string                                     `json:"message,required"`
	JSON    smartRoutingEditResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SmartRoutingEditResponseEnvelopeErrors) UnmarshalJSON 

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

type SmartRoutingEditResponseEnvelopeMessages 

type SmartRoutingEditResponseEnvelopeMessages struct {
	Code    int64                                        `json:"code,required"`
	Message string                                       `json:"message,required"`
	JSON    smartRoutingEditResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SmartRoutingEditResponseEnvelopeMessages) UnmarshalJSON 

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

type SmartRoutingEditResponseEnvelopeSuccess 

type SmartRoutingEditResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	SmartRoutingEditResponseEnvelopeSuccessTrue SmartRoutingEditResponseEnvelopeSuccess = true
)

type SmartRoutingGetParams 

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

type SmartRoutingGetResponse 

type SmartRoutingGetResponse interface {
	ImplementsArgoSmartRoutingGetResponse()
}

Union satisfied by argo.SmartRoutingGetResponseUnknown or shared.UnionString.

type SmartRoutingGetResponseEnvelope 

type SmartRoutingGetResponseEnvelope struct {
	Errors   []SmartRoutingGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SmartRoutingGetResponseEnvelopeMessages `json:"messages,required"`
	Result   SmartRoutingGetResponse                   `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 SmartRoutingGetResponseEnvelopeErrors 

type SmartRoutingGetResponseEnvelopeErrors struct {
	Code    int64                                     `json:"code,required"`
	Message string                                    `json:"message,required"`
	JSON    smartRoutingGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*SmartRoutingGetResponseEnvelopeErrors) UnmarshalJSON 

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

type SmartRoutingGetResponseEnvelopeMessages 

type SmartRoutingGetResponseEnvelopeMessages struct {
	Code    int64                                       `json:"code,required"`
	Message string                                      `json:"message,required"`
	JSON    smartRoutingGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*SmartRoutingGetResponseEnvelopeMessages) UnmarshalJSON 

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

type SmartRoutingGetResponseEnvelopeSuccess 

type SmartRoutingGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	SmartRoutingGetResponseEnvelopeSuccessTrue SmartRoutingGetResponseEnvelopeSuccess = true
)

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 *SmartRoutingEditResponse, err error)

Updates enablement of Argo Smart Routing.

func (*SmartRoutingService) Get 

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

Get Argo Smart Routing setting

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"
)

type TieredCachingEditResponse added in v2.3.0 

type TieredCachingEditResponse interface {
	ImplementsArgoTieredCachingEditResponse()
}

Union satisfied by argo.TieredCachingEditResponseUnknown or shared.UnionString.

type TieredCachingEditResponseEnvelope 

type TieredCachingEditResponseEnvelope struct {
	Errors   []TieredCachingEditResponseEnvelopeErrors   `json:"errors,required"`
	Messages []TieredCachingEditResponseEnvelopeMessages `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 TieredCachingEditResponseEnvelopeErrors 

type TieredCachingEditResponseEnvelopeErrors struct {
	Code    int64                                       `json:"code,required"`
	Message string                                      `json:"message,required"`
	JSON    tieredCachingEditResponseEnvelopeErrorsJSON `json:"-"`
}

func (*TieredCachingEditResponseEnvelopeErrors) UnmarshalJSON 

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

type TieredCachingEditResponseEnvelopeMessages 

type TieredCachingEditResponseEnvelopeMessages struct {
	Code    int64                                         `json:"code,required"`
	Message string                                        `json:"message,required"`
	JSON    tieredCachingEditResponseEnvelopeMessagesJSON `json:"-"`
}

func (*TieredCachingEditResponseEnvelopeMessages) UnmarshalJSON 

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

type TieredCachingEditResponseEnvelopeSuccess 

type TieredCachingEditResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	TieredCachingEditResponseEnvelopeSuccessTrue TieredCachingEditResponseEnvelopeSuccess = true
)

type TieredCachingGetParams 

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

type TieredCachingGetResponse added in v2.3.0 

type TieredCachingGetResponse interface {
	ImplementsArgoTieredCachingGetResponse()
}

Union satisfied by argo.TieredCachingGetResponseUnknown or shared.UnionString.

type TieredCachingGetResponseEnvelope 

type TieredCachingGetResponseEnvelope struct {
	Errors   []TieredCachingGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []TieredCachingGetResponseEnvelopeMessages `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 TieredCachingGetResponseEnvelopeErrors 

type TieredCachingGetResponseEnvelopeErrors struct {
	Code    int64                                      `json:"code,required"`
	Message string                                     `json:"message,required"`
	JSON    tieredCachingGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*TieredCachingGetResponseEnvelopeErrors) UnmarshalJSON 

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

type TieredCachingGetResponseEnvelopeMessages 

type TieredCachingGetResponseEnvelopeMessages struct {
	Code    int64                                        `json:"code,required"`
	Message string                                       `json:"message,required"`
	JSON    tieredCachingGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*TieredCachingGetResponseEnvelopeMessages) UnmarshalJSON 

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

type TieredCachingGetResponseEnvelopeSuccess 

type TieredCachingGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	TieredCachingGetResponseEnvelopeSuccessTrue TieredCachingGetResponseEnvelopeSuccess = true
)

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.