hostnames

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: 12 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Error 

type Error = apierror.Error

type HostnameService 

type HostnameService struct {
	Options  []option.RequestOption
	Settings *SettingService
}

HostnameService 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 NewHostnameService method instead.

func NewHostnameService 

func NewHostnameService(opts ...option.RequestOption) (r *HostnameService)

NewHostnameService 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 SettingService 

type SettingService struct {
	Options []option.RequestOption
	TLS     *SettingTLSService
}

SettingService 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 NewSettingService method instead.

func NewSettingService 

func NewSettingService(opts ...option.RequestOption) (r *SettingService)

NewSettingService 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 SettingTLSDeleteParams 

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

type SettingTLSDeleteParamsSettingID 

type SettingTLSDeleteParamsSettingID string

The TLS Setting name. 

const (
	SettingTLSDeleteParamsSettingIDCiphers       SettingTLSDeleteParamsSettingID = "ciphers"
	SettingTLSDeleteParamsSettingIDMinTLSVersion SettingTLSDeleteParamsSettingID = "min_tls_version"
	SettingTLSDeleteParamsSettingIDHTTP2         SettingTLSDeleteParamsSettingID = "http2"
)

type SettingTLSDeleteResponseEnvelope 

type SettingTLSDeleteResponseEnvelope struct {
	Errors   []SettingTLSDeleteResponseEnvelopeErrors       `json:"errors,required"`
	Messages []SettingTLSDeleteResponseEnvelopeMessages     `json:"messages,required"`
	Result   TLSCertificatesAndHostnamesSettingObjectDelete `json:"result,required"`
	// Whether the API call was successful
	Success SettingTLSDeleteResponseEnvelopeSuccess `json:"success,required"`
	JSON    settingTLSDeleteResponseEnvelopeJSON    `json:"-"`
}

func (*SettingTLSDeleteResponseEnvelope) UnmarshalJSON 

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

type SettingTLSDeleteResponseEnvelopeErrors 

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

func (*SettingTLSDeleteResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingTLSDeleteResponseEnvelopeMessages 

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

func (*SettingTLSDeleteResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingTLSDeleteResponseEnvelopeSuccess 

type SettingTLSDeleteResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	SettingTLSDeleteResponseEnvelopeSuccessTrue SettingTLSDeleteResponseEnvelopeSuccess = true
)

type SettingTLSGetParams 

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

type SettingTLSGetParamsSettingID 

type SettingTLSGetParamsSettingID string

The TLS Setting name. 

const (
	SettingTLSGetParamsSettingIDCiphers       SettingTLSGetParamsSettingID = "ciphers"
	SettingTLSGetParamsSettingIDMinTLSVersion SettingTLSGetParamsSettingID = "min_tls_version"
	SettingTLSGetParamsSettingIDHTTP2         SettingTLSGetParamsSettingID = "http2"
)

type SettingTLSGetResponse 

type SettingTLSGetResponse struct {
	// This is the time the tls setting was originally created for this hostname.
	CreatedAt time.Time `json:"created_at" format:"date-time"`
	// The hostname for which the tls settings are set.
	Hostname string `json:"hostname"`
	// Deployment status for the given tls setting.
	Status string `json:"status"`
	// This is the time the tls setting was updated.
	UpdatedAt time.Time `json:"updated_at" format:"date-time"`
	// The tls setting value.
	Value SettingTLSGetResponseValue `json:"value"`
	JSON  settingTLSGetResponseJSON  `json:"-"`
}

func (*SettingTLSGetResponse) UnmarshalJSON 

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

type SettingTLSGetResponseEnvelope 

type SettingTLSGetResponseEnvelope struct {
	Errors   []SettingTLSGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingTLSGetResponseEnvelopeMessages `json:"messages,required"`
	Result   []SettingTLSGetResponse                 `json:"result,required,nullable"`
	// Whether the API call was successful
	Success    SettingTLSGetResponseEnvelopeSuccess    `json:"success,required"`
	ResultInfo SettingTLSGetResponseEnvelopeResultInfo `json:"result_info"`
	JSON       settingTLSGetResponseEnvelopeJSON       `json:"-"`
}

func (*SettingTLSGetResponseEnvelope) UnmarshalJSON 

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

type SettingTLSGetResponseEnvelopeErrors 

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

func (*SettingTLSGetResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingTLSGetResponseEnvelopeMessages 

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

func (*SettingTLSGetResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingTLSGetResponseEnvelopeResultInfo 

type SettingTLSGetResponseEnvelopeResultInfo struct {
	// Total number of results for the requested service
	Count float64 `json:"count"`
	// Current page within paginated list of results
	Page float64 `json:"page"`
	// Number of results per page of results
	PerPage float64 `json:"per_page"`
	// Total results available without any search parameters
	TotalCount float64 `json:"total_count"`
	// Total pages available of results
	TotalPages float64                                     `json:"total_pages"`
	JSON       settingTLSGetResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*SettingTLSGetResponseEnvelopeResultInfo) UnmarshalJSON 

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

type SettingTLSGetResponseEnvelopeSuccess 

type SettingTLSGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	SettingTLSGetResponseEnvelopeSuccessTrue SettingTLSGetResponseEnvelopeSuccess = true
)

type SettingTLSGetResponseValue 

type SettingTLSGetResponseValue interface {
	ImplementsHostnamesSettingTLSGetResponseValue()
}

The tls setting value.

Union satisfied by shared.UnionFloat, shared.UnionString or hostnames.SettingTLSGetResponseValueArray.

type SettingTLSGetResponseValueArray 

type SettingTLSGetResponseValueArray []string

func (SettingTLSGetResponseValueArray) ImplementsHostnamesSettingTLSGetResponseValue 

func (r SettingTLSGetResponseValueArray) ImplementsHostnamesSettingTLSGetResponseValue()

type SettingTLSService 

type SettingTLSService struct {
	Options []option.RequestOption
}

SettingTLSService 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 NewSettingTLSService method instead.

func NewSettingTLSService 

func NewSettingTLSService(opts ...option.RequestOption) (r *SettingTLSService)

NewSettingTLSService 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 (*SettingTLSService) Delete 

func (r *SettingTLSService) Delete(ctx context.Context, settingID SettingTLSDeleteParamsSettingID, hostname string, body SettingTLSDeleteParams, opts ...option.RequestOption) (res *TLSCertificatesAndHostnamesSettingObjectDelete, err error)

Delete the tls setting value for the hostname.

func (*SettingTLSService) Get 

func (r *SettingTLSService) Get(ctx context.Context, settingID SettingTLSGetParamsSettingID, query SettingTLSGetParams, opts ...option.RequestOption) (res *[]SettingTLSGetResponse, err error)

List the requested TLS setting for the hostnames under this zone.

func (*SettingTLSService) Update 

func (r *SettingTLSService) Update(ctx context.Context, settingID SettingTLSUpdateParamsSettingID, hostname string, params SettingTLSUpdateParams, opts ...option.RequestOption) (res *TLSCertificatesAndHostnamesSettingObject, err error)

Update the tls setting value for the hostname.

type SettingTLSUpdateParams 

type SettingTLSUpdateParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
	// The tls setting value.
	Value param.Field[SettingTLSUpdateParamsValue] `json:"value,required"`
}

func (SettingTLSUpdateParams) MarshalJSON 

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

type SettingTLSUpdateParamsSettingID 

type SettingTLSUpdateParamsSettingID string

The TLS Setting name. 

const (
	SettingTLSUpdateParamsSettingIDCiphers       SettingTLSUpdateParamsSettingID = "ciphers"
	SettingTLSUpdateParamsSettingIDMinTLSVersion SettingTLSUpdateParamsSettingID = "min_tls_version"
	SettingTLSUpdateParamsSettingIDHTTP2         SettingTLSUpdateParamsSettingID = "http2"
)

type SettingTLSUpdateParamsValue 

type SettingTLSUpdateParamsValue interface {
	ImplementsHostnamesSettingTLSUpdateParamsValue()
}

The tls setting value.

Satisfied by shared.UnionFloat, shared.UnionString, hostnames.SettingTLSUpdateParamsValueArray.

type SettingTLSUpdateParamsValueArray 

type SettingTLSUpdateParamsValueArray []string

func (SettingTLSUpdateParamsValueArray) ImplementsHostnamesSettingTLSUpdateParamsValue 

func (r SettingTLSUpdateParamsValueArray) ImplementsHostnamesSettingTLSUpdateParamsValue()

type SettingTLSUpdateResponseEnvelope 

type SettingTLSUpdateResponseEnvelope struct {
	Errors   []SettingTLSUpdateResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SettingTLSUpdateResponseEnvelopeMessages `json:"messages,required"`
	Result   TLSCertificatesAndHostnamesSettingObject   `json:"result,required"`
	// Whether the API call was successful
	Success SettingTLSUpdateResponseEnvelopeSuccess `json:"success,required"`
	JSON    settingTLSUpdateResponseEnvelopeJSON    `json:"-"`
}

func (*SettingTLSUpdateResponseEnvelope) UnmarshalJSON 

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

type SettingTLSUpdateResponseEnvelopeErrors 

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

func (*SettingTLSUpdateResponseEnvelopeErrors) UnmarshalJSON 

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

type SettingTLSUpdateResponseEnvelopeMessages 

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

func (*SettingTLSUpdateResponseEnvelopeMessages) UnmarshalJSON 

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

type SettingTLSUpdateResponseEnvelopeSuccess 

type SettingTLSUpdateResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	SettingTLSUpdateResponseEnvelopeSuccessTrue SettingTLSUpdateResponseEnvelopeSuccess = true
)

type TLSCertificatesAndHostnamesSettingObject 

type TLSCertificatesAndHostnamesSettingObject struct {
	// This is the time the tls setting was originally created for this hostname.
	CreatedAt time.Time `json:"created_at" format:"date-time"`
	// The hostname for which the tls settings are set.
	Hostname string `json:"hostname"`
	// Deployment status for the given tls setting.
	Status string `json:"status"`
	// This is the time the tls setting was updated.
	UpdatedAt time.Time `json:"updated_at" format:"date-time"`
	// The tls setting value.
	Value TLSCertificatesAndHostnamesSettingObjectValue `json:"value"`
	JSON  tlsCertificatesAndHostnamesSettingObjectJSON  `json:"-"`
}

func (*TLSCertificatesAndHostnamesSettingObject) UnmarshalJSON 

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

type TLSCertificatesAndHostnamesSettingObjectDelete 

type TLSCertificatesAndHostnamesSettingObjectDelete struct {
	// This is the time the tls setting was originally created for this hostname.
	CreatedAt time.Time `json:"created_at" format:"date-time"`
	// The hostname for which the tls settings are set.
	Hostname string      `json:"hostname"`
	Status   interface{} `json:"status"`
	// This is the time the tls setting was updated.
	UpdatedAt time.Time                                          `json:"updated_at" format:"date-time"`
	Value     interface{}                                        `json:"value"`
	JSON      tlsCertificatesAndHostnamesSettingObjectDeleteJSON `json:"-"`
}

func (*TLSCertificatesAndHostnamesSettingObjectDelete) UnmarshalJSON 

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

type TLSCertificatesAndHostnamesSettingObjectValue 

type TLSCertificatesAndHostnamesSettingObjectValue interface {
	ImplementsHostnamesTLSCertificatesAndHostnamesSettingObjectValue()
}

The tls setting value.

Union satisfied by shared.UnionFloat, shared.UnionString or hostnames.TLSCertificatesAndHostnamesSettingObjectValueArray.

type TLSCertificatesAndHostnamesSettingObjectValueArray 

type TLSCertificatesAndHostnamesSettingObjectValueArray []string

func (TLSCertificatesAndHostnamesSettingObjectValueArray) ImplementsHostnamesTLSCertificatesAndHostnamesSettingObjectValue 

func (r TLSCertificatesAndHostnamesSettingObjectValueArray) ImplementsHostnamesTLSCertificatesAndHostnamesSettingObjectValue()

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.