origin_post_quantum_encryption

Documentation

Index

• type Error
• type OriginPostQuantumEncryptionGetParams
• type OriginPostQuantumEncryptionGetResponse
• type OriginPostQuantumEncryptionGetResponseEnvelope
  • func (r *OriginPostQuantumEncryptionGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
• type OriginPostQuantumEncryptionGetResponseEnvelopeErrors
  • func (r *OriginPostQuantumEncryptionGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
• type OriginPostQuantumEncryptionGetResponseEnvelopeMessages
  • func (r *OriginPostQuantumEncryptionGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
• type OriginPostQuantumEncryptionGetResponseEnvelopeSuccess
• type OriginPostQuantumEncryptionService
  • func NewOriginPostQuantumEncryptionService(opts ...option.RequestOption) (r *OriginPostQuantumEncryptionService)
  • func (r *OriginPostQuantumEncryptionService) Get(ctx context.Context, query OriginPostQuantumEncryptionGetParams, ...) (res *OriginPostQuantumEncryptionGetResponse, err error)
  • func (r *OriginPostQuantumEncryptionService) Update(ctx context.Context, params OriginPostQuantumEncryptionUpdateParams, ...) (res *OriginPostQuantumEncryptionUpdateResponse, err error)
• type OriginPostQuantumEncryptionUpdateParams
  • func (r OriginPostQuantumEncryptionUpdateParams) MarshalJSON() (data []byte, err error)
• type OriginPostQuantumEncryptionUpdateParamsValue
• type OriginPostQuantumEncryptionUpdateResponse
• type OriginPostQuantumEncryptionUpdateResponseEnvelope
  • func (r *OriginPostQuantumEncryptionUpdateResponseEnvelope) UnmarshalJSON(data []byte) (err error)
• type OriginPostQuantumEncryptionUpdateResponseEnvelopeErrors
  • func (r *OriginPostQuantumEncryptionUpdateResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
• type OriginPostQuantumEncryptionUpdateResponseEnvelopeMessages
  • func (r *OriginPostQuantumEncryptionUpdateResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
• type OriginPostQuantumEncryptionUpdateResponseEnvelopeSuccess

Types

type Error

type Error = apierror.Error

type OriginPostQuantumEncryptionGetParams

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

type OriginPostQuantumEncryptionGetResponse

type OriginPostQuantumEncryptionGetResponse interface {
	ImplementsOriginPostQuantumEncryptionOriginPostQuantumEncryptionGetResponse()
}

Union satisfied by origin_post_quantum_encryption.OriginPostQuantumEncryptionGetResponseUnknown or shared.UnionString.

type OriginPostQuantumEncryptionGetResponseEnvelope

type OriginPostQuantumEncryptionGetResponseEnvelope struct {
	Errors   []OriginPostQuantumEncryptionGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []OriginPostQuantumEncryptionGetResponseEnvelopeMessages `json:"messages,required"`
	Result   OriginPostQuantumEncryptionGetResponse                   `json:"result,required"`
	// Whether the API call was successful
	Success OriginPostQuantumEncryptionGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    originPostQuantumEncryptionGetResponseEnvelopeJSON    `json:"-"`
}

func (*OriginPostQuantumEncryptionGetResponseEnvelope) UnmarshalJSON

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

type OriginPostQuantumEncryptionGetResponseEnvelopeErrors

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

func (*OriginPostQuantumEncryptionGetResponseEnvelopeErrors) UnmarshalJSON

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

type OriginPostQuantumEncryptionGetResponseEnvelopeMessages

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

func (*OriginPostQuantumEncryptionGetResponseEnvelopeMessages) UnmarshalJSON

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

type OriginPostQuantumEncryptionGetResponseEnvelopeSuccess

type OriginPostQuantumEncryptionGetResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	OriginPostQuantumEncryptionGetResponseEnvelopeSuccessTrue OriginPostQuantumEncryptionGetResponseEnvelopeSuccess = true
)

type OriginPostQuantumEncryptionService

type OriginPostQuantumEncryptionService struct {
	Options []option.RequestOption
}

OriginPostQuantumEncryptionService 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 NewOriginPostQuantumEncryptionService method instead.

func NewOriginPostQuantumEncryptionService

func NewOriginPostQuantumEncryptionService(opts ...option.RequestOption) (r *OriginPostQuantumEncryptionService)

NewOriginPostQuantumEncryptionService 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 (*OriginPostQuantumEncryptionService) Get

func (r *OriginPostQuantumEncryptionService) Get(ctx context.Context, query OriginPostQuantumEncryptionGetParams, opts ...option.RequestOption) (res *OriginPostQuantumEncryptionGetResponse, err error)

Instructs Cloudflare to use Post-Quantum (PQ) key agreement algorithms when connecting to your origin. Preferred instructs Cloudflare to opportunistically send a Post-Quantum keyshare in the first message to the origin (for fastest connections when the origin supports and prefers PQ), supported means that PQ algorithms are advertised but only used when requested by the origin, and off means that PQ algorithms are not advertised

func (*OriginPostQuantumEncryptionService) Update

func (r *OriginPostQuantumEncryptionService) Update(ctx context.Context, params OriginPostQuantumEncryptionUpdateParams, opts ...option.RequestOption) (res *OriginPostQuantumEncryptionUpdateResponse, err error)

Instructs Cloudflare to use Post-Quantum (PQ) key agreement algorithms when connecting to your origin. Preferred instructs Cloudflare to opportunistically send a Post-Quantum keyshare in the first message to the origin (for fastest connections when the origin supports and prefers PQ), supported means that PQ algorithms are advertised but only used when requested by the origin, and off means that PQ algorithms are not advertised

type OriginPostQuantumEncryptionUpdateParams

type OriginPostQuantumEncryptionUpdateParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	// Value of the Origin Post Quantum Encryption Setting.
	Value param.Field[OriginPostQuantumEncryptionUpdateParamsValue] `json:"value,required"`
}

func (OriginPostQuantumEncryptionUpdateParams) MarshalJSON

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

type OriginPostQuantumEncryptionUpdateParamsValue

type OriginPostQuantumEncryptionUpdateParamsValue string

Value of the Origin Post Quantum Encryption Setting.

const (
	OriginPostQuantumEncryptionUpdateParamsValuePreferred OriginPostQuantumEncryptionUpdateParamsValue = "preferred"
	OriginPostQuantumEncryptionUpdateParamsValueSupported OriginPostQuantumEncryptionUpdateParamsValue = "supported"
	OriginPostQuantumEncryptionUpdateParamsValueOff       OriginPostQuantumEncryptionUpdateParamsValue = "off"
)

type OriginPostQuantumEncryptionUpdateResponse

type OriginPostQuantumEncryptionUpdateResponse interface {
	ImplementsOriginPostQuantumEncryptionOriginPostQuantumEncryptionUpdateResponse()
}

Union satisfied by origin_post_quantum_encryption.OriginPostQuantumEncryptionUpdateResponseUnknown or shared.UnionString.

type OriginPostQuantumEncryptionUpdateResponseEnvelope

type OriginPostQuantumEncryptionUpdateResponseEnvelope struct {
	Errors   []OriginPostQuantumEncryptionUpdateResponseEnvelopeErrors   `json:"errors,required"`
	Messages []OriginPostQuantumEncryptionUpdateResponseEnvelopeMessages `json:"messages,required"`
	Result   OriginPostQuantumEncryptionUpdateResponse                   `json:"result,required"`
	// Whether the API call was successful
	Success OriginPostQuantumEncryptionUpdateResponseEnvelopeSuccess `json:"success,required"`
	JSON    originPostQuantumEncryptionUpdateResponseEnvelopeJSON    `json:"-"`
}

func (*OriginPostQuantumEncryptionUpdateResponseEnvelope) UnmarshalJSON

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

type OriginPostQuantumEncryptionUpdateResponseEnvelopeErrors

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

func (*OriginPostQuantumEncryptionUpdateResponseEnvelopeErrors) UnmarshalJSON

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

type OriginPostQuantumEncryptionUpdateResponseEnvelopeMessages

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

func (*OriginPostQuantumEncryptionUpdateResponseEnvelopeMessages) UnmarshalJSON

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

type OriginPostQuantumEncryptionUpdateResponseEnvelopeSuccess

type OriginPostQuantumEncryptionUpdateResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	OriginPostQuantumEncryptionUpdateResponseEnvelopeSuccessTrue OriginPostQuantumEncryptionUpdateResponseEnvelopeSuccess = true
)