authenticatedoriginpullapiv1

package
v0.43.0 Latest Latest
Warning

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

 Go to latest Published: Oct 12, 2023 License: Apache-2.0 Imports: 9 Imported by: 2

Documentation

Overview

Package authenticatedoriginpullapiv1 : Operations and models for the AuthenticatedOriginPullApiV1 service

Index

Constants

View Source 
const DefaultServiceName = "authenticated_origin_pull_api"

DefaultServiceName is the default key used to find external configuration information.

View Source 
const DefaultServiceURL = "https://api.cis.cloud.ibm.com"

DefaultServiceURL is the default URL to make service requests to.

Variables

This section is empty.

Functions

func GetServiceURLForRegion 

func GetServiceURLForRegion(region string) (string, error)

GetServiceURLForRegion returns the service URL to be used for the specified region

func UnmarshalCertificatePack 

func UnmarshalCertificatePack(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalCertificatePack unmarshals an instance of CertificatePack from the specified map of raw messages.

func UnmarshalGetHostnameOriginPullSettingsResp 

func UnmarshalGetHostnameOriginPullSettingsResp(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGetHostnameOriginPullSettingsResp unmarshals an instance of GetHostnameOriginPullSettingsResp from the specified map of raw messages.

func UnmarshalGetZoneOriginPullSettingsResp 

func UnmarshalGetZoneOriginPullSettingsResp(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGetZoneOriginPullSettingsResp unmarshals an instance of GetZoneOriginPullSettingsResp from the specified map of raw messages.

func UnmarshalGetZoneOriginPullSettingsRespResult 

func UnmarshalGetZoneOriginPullSettingsRespResult(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGetZoneOriginPullSettingsRespResult unmarshals an instance of GetZoneOriginPullSettingsRespResult from the specified map of raw messages.

func UnmarshalHostnameCertificatePack 

func UnmarshalHostnameCertificatePack(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalHostnameCertificatePack unmarshals an instance of HostnameCertificatePack from the specified map of raw messages.

func UnmarshalHostnameOriginPullCertificateResp 

func UnmarshalHostnameOriginPullCertificateResp(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalHostnameOriginPullCertificateResp unmarshals an instance of HostnameOriginPullCertificateResp from the specified map of raw messages.

func UnmarshalHostnameOriginPullSettings 

func UnmarshalHostnameOriginPullSettings(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalHostnameOriginPullSettings unmarshals an instance of HostnameOriginPullSettings from the specified map of raw messages.

func UnmarshalHostnameSettingsResp 

func UnmarshalHostnameSettingsResp(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalHostnameSettingsResp unmarshals an instance of HostnameSettingsResp from the specified map of raw messages.

func UnmarshalListHostnameOriginPullSettingsResp 

func UnmarshalListHostnameOriginPullSettingsResp(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalListHostnameOriginPullSettingsResp unmarshals an instance of ListHostnameOriginPullSettingsResp from the specified map of raw messages.

func UnmarshalListZoneOriginPullCertificatesResp 

func UnmarshalListZoneOriginPullCertificatesResp(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalListZoneOriginPullCertificatesResp unmarshals an instance of ListZoneOriginPullCertificatesResp from the specified map of raw messages.

func UnmarshalZoneOriginPullCertificateResp 

func UnmarshalZoneOriginPullCertificateResp(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalZoneOriginPullCertificateResp unmarshals an instance of ZoneOriginPullCertificateResp from the specified map of raw messages.

Types

type AuthenticatedOriginPullApiV1 

type AuthenticatedOriginPullApiV1 struct {
	Service *core.BaseService

	// cloud resource name.
	Crn *string

	// zone identifier.
	ZoneIdentifier *string
}

AuthenticatedOriginPullApiV1 : Authenticated Origin Pull

API Version: 1.0.0

func NewAuthenticatedOriginPullApiV1 

func NewAuthenticatedOriginPullApiV1(options *AuthenticatedOriginPullApiV1Options) (service *AuthenticatedOriginPullApiV1, err error)

NewAuthenticatedOriginPullApiV1 : constructs an instance of AuthenticatedOriginPullApiV1 with passed in options.

func NewAuthenticatedOriginPullApiV1UsingExternalConfig 

func NewAuthenticatedOriginPullApiV1UsingExternalConfig(options *AuthenticatedOriginPullApiV1Options) (authenticatedOriginPullApi *AuthenticatedOriginPullApiV1, err error)

NewAuthenticatedOriginPullApiV1UsingExternalConfig : constructs an instance of AuthenticatedOriginPullApiV1 with passed in options and external configuration.

func (*AuthenticatedOriginPullApiV1) Clone 

func (authenticatedOriginPullApi *AuthenticatedOriginPullApiV1) Clone() *AuthenticatedOriginPullApiV1

Clone makes a copy of "authenticatedOriginPullApi" suitable for processing requests.

func (*AuthenticatedOriginPullApiV1) DeleteHostnameOriginPullCertificate 

func (authenticatedOriginPullApi *AuthenticatedOriginPullApiV1) DeleteHostnameOriginPullCertificate(deleteHostnameOriginPullCertificateOptions *DeleteHostnameOriginPullCertificateOptions) (result *HostnameOriginPullCertificateResp, response *core.DetailedResponse, err error)

DeleteHostnameOriginPullCertificate : Delete a Hostname level Authenticated Origin Pull Certificate Delete the certificate by ID to be used for client authentication on a hostname.

func (*AuthenticatedOriginPullApiV1) DeleteHostnameOriginPullCertificateWithContext 

func (authenticatedOriginPullApi *AuthenticatedOriginPullApiV1) DeleteHostnameOriginPullCertificateWithContext(ctx context.Context, deleteHostnameOriginPullCertificateOptions *DeleteHostnameOriginPullCertificateOptions) (result *HostnameOriginPullCertificateResp, response *core.DetailedResponse, err error)

DeleteHostnameOriginPullCertificateWithContext is an alternate form of the DeleteHostnameOriginPullCertificate method which supports a Context parameter

func (*AuthenticatedOriginPullApiV1) DeleteZoneOriginPullCertificate 

func (authenticatedOriginPullApi *AuthenticatedOriginPullApiV1) DeleteZoneOriginPullCertificate(deleteZoneOriginPullCertificateOptions *DeleteZoneOriginPullCertificateOptions) (result *ZoneOriginPullCertificateResp, response *core.DetailedResponse, err error)

DeleteZoneOriginPullCertificate : Delete a Zone level Authenticated Origin Pull Certificate Delete a zone-level authenticated origin pulls certificate.

func (*AuthenticatedOriginPullApiV1) DeleteZoneOriginPullCertificateWithContext 

func (authenticatedOriginPullApi *AuthenticatedOriginPullApiV1) DeleteZoneOriginPullCertificateWithContext(ctx context.Context, deleteZoneOriginPullCertificateOptions *DeleteZoneOriginPullCertificateOptions) (result *ZoneOriginPullCertificateResp, response *core.DetailedResponse, err error)

DeleteZoneOriginPullCertificateWithContext is an alternate form of the DeleteZoneOriginPullCertificate method which supports a Context parameter

func (*AuthenticatedOriginPullApiV1) DisableRetries 

func (authenticatedOriginPullApi *AuthenticatedOriginPullApiV1) DisableRetries()

DisableRetries disables automatic retries for requests invoked for this service instance.

func (*AuthenticatedOriginPullApiV1) EnableRetries 

func (authenticatedOriginPullApi *AuthenticatedOriginPullApiV1) EnableRetries(maxRetries int, maxRetryInterval time.Duration)

EnableRetries enables automatic retries for requests invoked for this service instance. If either parameter is specified as 0, then a default value is used instead.

func (*AuthenticatedOriginPullApiV1) GetEnableGzipCompression 

func (authenticatedOriginPullApi *AuthenticatedOriginPullApiV1) GetEnableGzipCompression() bool

GetEnableGzipCompression returns the service's EnableGzipCompression field

func (*AuthenticatedOriginPullApiV1) GetHostnameOriginPullCertificate 

func (authenticatedOriginPullApi *AuthenticatedOriginPullApiV1) GetHostnameOriginPullCertificate(getHostnameOriginPullCertificateOptions *GetHostnameOriginPullCertificateOptions) (result *HostnameOriginPullCertificateResp, response *core.DetailedResponse, err error)

GetHostnameOriginPullCertificate : Get a Hostname level Authenticated Origin Pull Certificate Get the certificate by ID to be used for client authentication on a hostname.

func (*AuthenticatedOriginPullApiV1) GetHostnameOriginPullCertificateWithContext 

func (authenticatedOriginPullApi *AuthenticatedOriginPullApiV1) GetHostnameOriginPullCertificateWithContext(ctx context.Context, getHostnameOriginPullCertificateOptions *GetHostnameOriginPullCertificateOptions) (result *HostnameOriginPullCertificateResp, response *core.DetailedResponse, err error)

GetHostnameOriginPullCertificateWithContext is an alternate form of the GetHostnameOriginPullCertificate method which supports a Context parameter

func (*AuthenticatedOriginPullApiV1) GetHostnameOriginPullSettings 

func (authenticatedOriginPullApi *AuthenticatedOriginPullApiV1) GetHostnameOriginPullSettings(getHostnameOriginPullSettingsOptions *GetHostnameOriginPullSettingsOptions) (result *GetHostnameOriginPullSettingsResp, response *core.DetailedResponse, err error)

GetHostnameOriginPullSettings : Get Hostname level Authenticated Origin Pull Settings Get hostname-level authenticated origin pulls settings.

func (*AuthenticatedOriginPullApiV1) GetHostnameOriginPullSettingsWithContext 

func (authenticatedOriginPullApi *AuthenticatedOriginPullApiV1) GetHostnameOriginPullSettingsWithContext(ctx context.Context, getHostnameOriginPullSettingsOptions *GetHostnameOriginPullSettingsOptions) (result *GetHostnameOriginPullSettingsResp, response *core.DetailedResponse, err error)

GetHostnameOriginPullSettingsWithContext is an alternate form of the GetHostnameOriginPullSettings method which supports a Context parameter

func (*AuthenticatedOriginPullApiV1) GetServiceURL 

func (authenticatedOriginPullApi *AuthenticatedOriginPullApiV1) GetServiceURL() string

GetServiceURL returns the service URL

func (*AuthenticatedOriginPullApiV1) GetZoneOriginPullCertificate 

func (authenticatedOriginPullApi *AuthenticatedOriginPullApiV1) GetZoneOriginPullCertificate(getZoneOriginPullCertificateOptions *GetZoneOriginPullCertificateOptions) (result *ZoneOriginPullCertificateResp, response *core.DetailedResponse, err error)

GetZoneOriginPullCertificate : Get a Zone level Authenticated Origin Pull Certificate Get a zone-level authenticated origin pulls certificate.

func (*AuthenticatedOriginPullApiV1) GetZoneOriginPullCertificateWithContext 

func (authenticatedOriginPullApi *AuthenticatedOriginPullApiV1) GetZoneOriginPullCertificateWithContext(ctx context.Context, getZoneOriginPullCertificateOptions *GetZoneOriginPullCertificateOptions) (result *ZoneOriginPullCertificateResp, response *core.DetailedResponse, err error)

GetZoneOriginPullCertificateWithContext is an alternate form of the GetZoneOriginPullCertificate method which supports a Context parameter

func (*AuthenticatedOriginPullApiV1) GetZoneOriginPullSettings 

func (authenticatedOriginPullApi *AuthenticatedOriginPullApiV1) GetZoneOriginPullSettings(getZoneOriginPullSettingsOptions *GetZoneOriginPullSettingsOptions) (result *GetZoneOriginPullSettingsResp, response *core.DetailedResponse, err error)

GetZoneOriginPullSettings : Get Zone level Authenticated Origin Pull Settings Get whether zone-level authenticated origin pulls is enabled or not. It is false by default.

func (*AuthenticatedOriginPullApiV1) GetZoneOriginPullSettingsWithContext 

func (authenticatedOriginPullApi *AuthenticatedOriginPullApiV1) GetZoneOriginPullSettingsWithContext(ctx context.Context, getZoneOriginPullSettingsOptions *GetZoneOriginPullSettingsOptions) (result *GetZoneOriginPullSettingsResp, response *core.DetailedResponse, err error)

GetZoneOriginPullSettingsWithContext is an alternate form of the GetZoneOriginPullSettings method which supports a Context parameter

func (*AuthenticatedOriginPullApiV1) ListZoneOriginPullCertificates 

func (authenticatedOriginPullApi *AuthenticatedOriginPullApiV1) ListZoneOriginPullCertificates(listZoneOriginPullCertificatesOptions *ListZoneOriginPullCertificatesOptions) (result *ListZoneOriginPullCertificatesResp, response *core.DetailedResponse, err error)

ListZoneOriginPullCertificates : List Zone level Authenticated Origin Pull Certificates List zone-level authenticated origin pulls certificates.

func (*AuthenticatedOriginPullApiV1) ListZoneOriginPullCertificatesWithContext 

func (authenticatedOriginPullApi *AuthenticatedOriginPullApiV1) ListZoneOriginPullCertificatesWithContext(ctx context.Context, listZoneOriginPullCertificatesOptions *ListZoneOriginPullCertificatesOptions) (result *ListZoneOriginPullCertificatesResp, response *core.DetailedResponse, err error)

ListZoneOriginPullCertificatesWithContext is an alternate form of the ListZoneOriginPullCertificates method which supports a Context parameter

func (*AuthenticatedOriginPullApiV1) NewDeleteHostnameOriginPullCertificateOptions 

func (*AuthenticatedOriginPullApiV1) NewDeleteHostnameOriginPullCertificateOptions(certIdentifier string) *DeleteHostnameOriginPullCertificateOptions

NewDeleteHostnameOriginPullCertificateOptions : Instantiate DeleteHostnameOriginPullCertificateOptions

func (*AuthenticatedOriginPullApiV1) NewDeleteZoneOriginPullCertificateOptions 

func (*AuthenticatedOriginPullApiV1) NewDeleteZoneOriginPullCertificateOptions(certIdentifier string) *DeleteZoneOriginPullCertificateOptions

NewDeleteZoneOriginPullCertificateOptions : Instantiate DeleteZoneOriginPullCertificateOptions

func (*AuthenticatedOriginPullApiV1) NewGetHostnameOriginPullCertificateOptions 

func (*AuthenticatedOriginPullApiV1) NewGetHostnameOriginPullCertificateOptions(certIdentifier string) *GetHostnameOriginPullCertificateOptions

NewGetHostnameOriginPullCertificateOptions : Instantiate GetHostnameOriginPullCertificateOptions

func (*AuthenticatedOriginPullApiV1) NewGetHostnameOriginPullSettingsOptions 

func (*AuthenticatedOriginPullApiV1) NewGetHostnameOriginPullSettingsOptions(hostname string) *GetHostnameOriginPullSettingsOptions

NewGetHostnameOriginPullSettingsOptions : Instantiate GetHostnameOriginPullSettingsOptions

func (*AuthenticatedOriginPullApiV1) NewGetZoneOriginPullCertificateOptions 

func (*AuthenticatedOriginPullApiV1) NewGetZoneOriginPullCertificateOptions(certIdentifier string) *GetZoneOriginPullCertificateOptions

NewGetZoneOriginPullCertificateOptions : Instantiate GetZoneOriginPullCertificateOptions

func (*AuthenticatedOriginPullApiV1) NewGetZoneOriginPullSettingsOptions 

func (*AuthenticatedOriginPullApiV1) NewGetZoneOriginPullSettingsOptions() *GetZoneOriginPullSettingsOptions

NewGetZoneOriginPullSettingsOptions : Instantiate GetZoneOriginPullSettingsOptions

func (*AuthenticatedOriginPullApiV1) NewHostnameOriginPullSettings 

func (*AuthenticatedOriginPullApiV1) NewHostnameOriginPullSettings(hostname string, certID string, enabled bool) (_model *HostnameOriginPullSettings, err error)

NewHostnameOriginPullSettings : Instantiate HostnameOriginPullSettings (Generic Model Constructor)

func (*AuthenticatedOriginPullApiV1) NewListZoneOriginPullCertificatesOptions 

func (*AuthenticatedOriginPullApiV1) NewListZoneOriginPullCertificatesOptions() *ListZoneOriginPullCertificatesOptions

NewListZoneOriginPullCertificatesOptions : Instantiate ListZoneOriginPullCertificatesOptions

func (*AuthenticatedOriginPullApiV1) NewSetHostnameOriginPullSettingsOptions 

func (*AuthenticatedOriginPullApiV1) NewSetHostnameOriginPullSettingsOptions() *SetHostnameOriginPullSettingsOptions

NewSetHostnameOriginPullSettingsOptions : Instantiate SetHostnameOriginPullSettingsOptions

func (*AuthenticatedOriginPullApiV1) NewSetZoneOriginPullSettingsOptions 

func (*AuthenticatedOriginPullApiV1) NewSetZoneOriginPullSettingsOptions() *SetZoneOriginPullSettingsOptions

NewSetZoneOriginPullSettingsOptions : Instantiate SetZoneOriginPullSettingsOptions

func (*AuthenticatedOriginPullApiV1) NewUploadHostnameOriginPullCertificateOptions 

func (*AuthenticatedOriginPullApiV1) NewUploadHostnameOriginPullCertificateOptions() *UploadHostnameOriginPullCertificateOptions

NewUploadHostnameOriginPullCertificateOptions : Instantiate UploadHostnameOriginPullCertificateOptions

func (*AuthenticatedOriginPullApiV1) NewUploadZoneOriginPullCertificateOptions 

func (*AuthenticatedOriginPullApiV1) NewUploadZoneOriginPullCertificateOptions() *UploadZoneOriginPullCertificateOptions

NewUploadZoneOriginPullCertificateOptions : Instantiate UploadZoneOriginPullCertificateOptions

func (*AuthenticatedOriginPullApiV1) SetDefaultHeaders 

func (authenticatedOriginPullApi *AuthenticatedOriginPullApiV1) SetDefaultHeaders(headers http.Header)

SetDefaultHeaders sets HTTP headers to be sent in every request

func (*AuthenticatedOriginPullApiV1) SetEnableGzipCompression 

func (authenticatedOriginPullApi *AuthenticatedOriginPullApiV1) SetEnableGzipCompression(enableGzip bool)

SetEnableGzipCompression sets the service's EnableGzipCompression field

func (*AuthenticatedOriginPullApiV1) SetHostnameOriginPullSettings 

func (authenticatedOriginPullApi *AuthenticatedOriginPullApiV1) SetHostnameOriginPullSettings(setHostnameOriginPullSettingsOptions *SetHostnameOriginPullSettingsOptions) (result *ListHostnameOriginPullSettingsResp, response *core.DetailedResponse, err error)

SetHostnameOriginPullSettings : Set Hostname level Authenticated Origin Pull Settings Associate a hostname to a certificate and enable, disable or invalidate the association. If disabled, client certificate will not be sent to the hostname even if activated at the zone level. 100 maximum associations on a single certificate are allowed.

func (*AuthenticatedOriginPullApiV1) SetHostnameOriginPullSettingsWithContext 

func (authenticatedOriginPullApi *AuthenticatedOriginPullApiV1) SetHostnameOriginPullSettingsWithContext(ctx context.Context, setHostnameOriginPullSettingsOptions *SetHostnameOriginPullSettingsOptions) (result *ListHostnameOriginPullSettingsResp, response *core.DetailedResponse, err error)

SetHostnameOriginPullSettingsWithContext is an alternate form of the SetHostnameOriginPullSettings method which supports a Context parameter

func (*AuthenticatedOriginPullApiV1) SetServiceURL 

func (authenticatedOriginPullApi *AuthenticatedOriginPullApiV1) SetServiceURL(url string) error

SetServiceURL sets the service URL

func (*AuthenticatedOriginPullApiV1) SetZoneOriginPullSettings 

func (authenticatedOriginPullApi *AuthenticatedOriginPullApiV1) SetZoneOriginPullSettings(setZoneOriginPullSettingsOptions *SetZoneOriginPullSettingsOptions) (result *GetZoneOriginPullSettingsResp, response *core.DetailedResponse, err error)

SetZoneOriginPullSettings : Set Zone level Authenticated Origin Pull Settings Enable or disable zone-level authenticated origin pulls. 'enabled' should be set true either before/after the certificate is uploaded to see the certificate in use.

func (*AuthenticatedOriginPullApiV1) SetZoneOriginPullSettingsWithContext 

func (authenticatedOriginPullApi *AuthenticatedOriginPullApiV1) SetZoneOriginPullSettingsWithContext(ctx context.Context, setZoneOriginPullSettingsOptions *SetZoneOriginPullSettingsOptions) (result *GetZoneOriginPullSettingsResp, response *core.DetailedResponse, err error)

SetZoneOriginPullSettingsWithContext is an alternate form of the SetZoneOriginPullSettings method which supports a Context parameter

func (*AuthenticatedOriginPullApiV1) UploadHostnameOriginPullCertificate 

func (authenticatedOriginPullApi *AuthenticatedOriginPullApiV1) UploadHostnameOriginPullCertificate(uploadHostnameOriginPullCertificateOptions *UploadHostnameOriginPullCertificateOptions) (result *HostnameOriginPullCertificateResp, response *core.DetailedResponse, err error)

UploadHostnameOriginPullCertificate : Upload Hostname level Authenticated Origin Pull Certificate Upload a certificate to be used for client authentication on a hostname. 10 hostname certificates per zone are allowed.

func (*AuthenticatedOriginPullApiV1) UploadHostnameOriginPullCertificateWithContext 

func (authenticatedOriginPullApi *AuthenticatedOriginPullApiV1) UploadHostnameOriginPullCertificateWithContext(ctx context.Context, uploadHostnameOriginPullCertificateOptions *UploadHostnameOriginPullCertificateOptions) (result *HostnameOriginPullCertificateResp, response *core.DetailedResponse, err error)

UploadHostnameOriginPullCertificateWithContext is an alternate form of the UploadHostnameOriginPullCertificate method which supports a Context parameter

func (*AuthenticatedOriginPullApiV1) UploadZoneOriginPullCertificate 

func (authenticatedOriginPullApi *AuthenticatedOriginPullApiV1) UploadZoneOriginPullCertificate(uploadZoneOriginPullCertificateOptions *UploadZoneOriginPullCertificateOptions) (result *ZoneOriginPullCertificateResp, response *core.DetailedResponse, err error)

UploadZoneOriginPullCertificate : Upload Zone level Authenticated Origin Pull Certificate Upload your own certificate you want Cloudflare to use for edge-to-origin communication to override the shared certificate Please note that it is important to keep only one certificate active. Also, make sure to enable zone-level authenticated origin pulls by making a PUT call to settings endpoint to see the uploaded certificate in use.

func (*AuthenticatedOriginPullApiV1) UploadZoneOriginPullCertificateWithContext 

func (authenticatedOriginPullApi *AuthenticatedOriginPullApiV1) UploadZoneOriginPullCertificateWithContext(ctx context.Context, uploadZoneOriginPullCertificateOptions *UploadZoneOriginPullCertificateOptions) (result *ZoneOriginPullCertificateResp, response *core.DetailedResponse, err error)

UploadZoneOriginPullCertificateWithContext is an alternate form of the UploadZoneOriginPullCertificate method which supports a Context parameter

type AuthenticatedOriginPullApiV1Options 

type AuthenticatedOriginPullApiV1Options struct {
	ServiceName   string
	URL           string
	Authenticator core.Authenticator

	// cloud resource name.
	Crn *string `validate:"required"`

	// zone identifier.
	ZoneIdentifier *string `validate:"required"`
}

AuthenticatedOriginPullApiV1Options : Service options

type CertificatePack 

type CertificatePack struct {
	// certificate identifier tag.
	ID *string `json:"id,omitempty"`

	// the zone's leaf certificate.
	Certificate *string `json:"certificate,omitempty"`

	// the certificate authority that issued the certificate.
	Issuer *string `json:"issuer,omitempty"`

	// the type of hash used for the certificate.
	Signature *string `json:"signature,omitempty"`

	// status of the certificate activation.
	Status *string `json:"status,omitempty"`

	// when the certificate from the authority expires.
	ExpiresOn *string `json:"expires_on,omitempty"`

	// the time the certificate was uploaded.
	UploadedOn *string `json:"uploaded_on,omitempty"`
}

CertificatePack : certificate pack.

type DeleteHostnameOriginPullCertificateOptions 

type DeleteHostnameOriginPullCertificateOptions struct {
	// cedrtificate identifier.
	CertIdentifier *string `json:"cert_identifier" validate:"required,ne="`

	// Uniquely identifying a request.
	XCorrelationID *string `json:"X-Correlation-ID,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

DeleteHostnameOriginPullCertificateOptions : The DeleteHostnameOriginPullCertificate options.

func (*DeleteHostnameOriginPullCertificateOptions) SetCertIdentifier 

func (_options *DeleteHostnameOriginPullCertificateOptions) SetCertIdentifier(certIdentifier string) *DeleteHostnameOriginPullCertificateOptions

SetCertIdentifier : Allow user to set CertIdentifier

func (*DeleteHostnameOriginPullCertificateOptions) SetHeaders 

func (options *DeleteHostnameOriginPullCertificateOptions) SetHeaders(param map[string]string) *DeleteHostnameOriginPullCertificateOptions

SetHeaders : Allow user to set Headers

func (*DeleteHostnameOriginPullCertificateOptions) SetXCorrelationID 

func (_options *DeleteHostnameOriginPullCertificateOptions) SetXCorrelationID(xCorrelationID string) *DeleteHostnameOriginPullCertificateOptions

SetXCorrelationID : Allow user to set XCorrelationID

type DeleteZoneOriginPullCertificateOptions 

type DeleteZoneOriginPullCertificateOptions struct {
	// cedrtificate identifier.
	CertIdentifier *string `json:"cert_identifier" validate:"required,ne="`

	// Uniquely identifying a request.
	XCorrelationID *string `json:"X-Correlation-ID,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

DeleteZoneOriginPullCertificateOptions : The DeleteZoneOriginPullCertificate options.

func (*DeleteZoneOriginPullCertificateOptions) SetCertIdentifier 

func (_options *DeleteZoneOriginPullCertificateOptions) SetCertIdentifier(certIdentifier string) *DeleteZoneOriginPullCertificateOptions

SetCertIdentifier : Allow user to set CertIdentifier

func (*DeleteZoneOriginPullCertificateOptions) SetHeaders 

func (options *DeleteZoneOriginPullCertificateOptions) SetHeaders(param map[string]string) *DeleteZoneOriginPullCertificateOptions

SetHeaders : Allow user to set Headers

func (*DeleteZoneOriginPullCertificateOptions) SetXCorrelationID 

func (_options *DeleteZoneOriginPullCertificateOptions) SetXCorrelationID(xCorrelationID string) *DeleteZoneOriginPullCertificateOptions

SetXCorrelationID : Allow user to set XCorrelationID

type GetHostnameOriginPullCertificateOptions 

type GetHostnameOriginPullCertificateOptions struct {
	// cedrtificate identifier.
	CertIdentifier *string `json:"cert_identifier" validate:"required,ne="`

	// Uniquely identifying a request.
	XCorrelationID *string `json:"X-Correlation-ID,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetHostnameOriginPullCertificateOptions : The GetHostnameOriginPullCertificate options.

func (*GetHostnameOriginPullCertificateOptions) SetCertIdentifier 

func (_options *GetHostnameOriginPullCertificateOptions) SetCertIdentifier(certIdentifier string) *GetHostnameOriginPullCertificateOptions

SetCertIdentifier : Allow user to set CertIdentifier

func (*GetHostnameOriginPullCertificateOptions) SetHeaders 

func (options *GetHostnameOriginPullCertificateOptions) SetHeaders(param map[string]string) *GetHostnameOriginPullCertificateOptions

SetHeaders : Allow user to set Headers

func (*GetHostnameOriginPullCertificateOptions) SetXCorrelationID 

func (_options *GetHostnameOriginPullCertificateOptions) SetXCorrelationID(xCorrelationID string) *GetHostnameOriginPullCertificateOptions

SetXCorrelationID : Allow user to set XCorrelationID

type GetHostnameOriginPullSettingsOptions 

type GetHostnameOriginPullSettingsOptions struct {
	// the hostname on the origin for which the client certificate associate.
	Hostname *string `json:"hostname" validate:"required,ne="`

	// Uniquely identifying a request.
	XCorrelationID *string `json:"X-Correlation-ID,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetHostnameOriginPullSettingsOptions : The GetHostnameOriginPullSettings options.

func (*GetHostnameOriginPullSettingsOptions) SetHeaders 

func (options *GetHostnameOriginPullSettingsOptions) SetHeaders(param map[string]string) *GetHostnameOriginPullSettingsOptions

SetHeaders : Allow user to set Headers

func (*GetHostnameOriginPullSettingsOptions) SetHostname 

func (_options *GetHostnameOriginPullSettingsOptions) SetHostname(hostname string) *GetHostnameOriginPullSettingsOptions

SetHostname : Allow user to set Hostname

func (*GetHostnameOriginPullSettingsOptions) SetXCorrelationID 

func (_options *GetHostnameOriginPullSettingsOptions) SetXCorrelationID(xCorrelationID string) *GetHostnameOriginPullSettingsOptions

SetXCorrelationID : Allow user to set XCorrelationID

type GetHostnameOriginPullSettingsResp 

type GetHostnameOriginPullSettingsResp struct {
	// hostname level authenticated origin pull settings response.
	Result *HostnameSettingsResp `json:"result,omitempty"`

	// success.
	Success *bool `json:"success,omitempty"`

	Errors []string `json:"errors,omitempty"`

	Messages []string `json:"messages,omitempty"`
}

GetHostnameOriginPullSettingsResp : detail of the hostname level authenticated origin pull settings response.

type GetZoneOriginPullCertificateOptions 

type GetZoneOriginPullCertificateOptions struct {
	// cedrtificate identifier.
	CertIdentifier *string `json:"cert_identifier" validate:"required,ne="`

	// Uniquely identifying a request.
	XCorrelationID *string `json:"X-Correlation-ID,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetZoneOriginPullCertificateOptions : The GetZoneOriginPullCertificate options.

func (*GetZoneOriginPullCertificateOptions) SetCertIdentifier 

func (_options *GetZoneOriginPullCertificateOptions) SetCertIdentifier(certIdentifier string) *GetZoneOriginPullCertificateOptions

SetCertIdentifier : Allow user to set CertIdentifier

func (*GetZoneOriginPullCertificateOptions) SetHeaders 

func (options *GetZoneOriginPullCertificateOptions) SetHeaders(param map[string]string) *GetZoneOriginPullCertificateOptions

SetHeaders : Allow user to set Headers

func (*GetZoneOriginPullCertificateOptions) SetXCorrelationID 

func (_options *GetZoneOriginPullCertificateOptions) SetXCorrelationID(xCorrelationID string) *GetZoneOriginPullCertificateOptions

SetXCorrelationID : Allow user to set XCorrelationID

type GetZoneOriginPullSettingsOptions 

type GetZoneOriginPullSettingsOptions struct {
	// Uniquely identifying a request.
	XCorrelationID *string `json:"X-Correlation-ID,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetZoneOriginPullSettingsOptions : The GetZoneOriginPullSettings options.

func (*GetZoneOriginPullSettingsOptions) SetHeaders 

func (options *GetZoneOriginPullSettingsOptions) SetHeaders(param map[string]string) *GetZoneOriginPullSettingsOptions

SetHeaders : Allow user to set Headers

func (*GetZoneOriginPullSettingsOptions) SetXCorrelationID 

func (_options *GetZoneOriginPullSettingsOptions) SetXCorrelationID(xCorrelationID string) *GetZoneOriginPullSettingsOptions

SetXCorrelationID : Allow user to set XCorrelationID

type GetZoneOriginPullSettingsResp 

type GetZoneOriginPullSettingsResp struct {
	// result.
	Result *GetZoneOriginPullSettingsRespResult `json:"result,omitempty"`

	// success.
	Success *bool `json:"success,omitempty"`

	Errors []string `json:"errors,omitempty"`

	Messages []string `json:"messages,omitempty"`
}

GetZoneOriginPullSettingsResp : zone level authenticated origin pull settings response.

type GetZoneOriginPullSettingsRespResult 

type GetZoneOriginPullSettingsRespResult struct {
	// enabled.
	Enabled *bool `json:"enabled" validate:"required"`
}

GetZoneOriginPullSettingsRespResult : result.

type HostnameCertificatePack 

type HostnameCertificatePack struct {
	// certificate identifier tag.
	ID *string `json:"id,omitempty"`

	// the zone's leaf certificate.
	Certificate *string `json:"certificate,omitempty"`

	// the certificate authority that issued the certificate.
	Issuer *string `json:"issuer,omitempty"`

	// the type of hash used for the certificate.
	Signature *string `json:"signature,omitempty"`

	// the serial number on the uploaded certificate.
	SerialNumber *string `json:"serial_number,omitempty"`

	// status of the certificate activation.
	Status *string `json:"status,omitempty"`

	// when the certificate from the authority expires.
	ExpiresOn *string `json:"expires_on,omitempty"`

	// the time the certificate was uploaded.
	UploadedOn *string `json:"uploaded_on,omitempty"`
}

HostnameCertificatePack : certificate pack.

type HostnameOriginPullCertificateResp 

type HostnameOriginPullCertificateResp struct {
	// certificate pack.
	Result *HostnameCertificatePack `json:"result,omitempty"`

	// success.
	Success *bool `json:"success,omitempty"`

	Errors []string `json:"errors,omitempty"`

	Messages []string `json:"messages,omitempty"`
}

HostnameOriginPullCertificateResp : certificate response.

type HostnameOriginPullSettings 

type HostnameOriginPullSettings struct {
	// the hostname on the origin for which the client certificate uploaded will be used.
	Hostname *string `json:"hostname" validate:"required"`

	// certificate identifier tag.
	CertID *string `json:"cert_id" validate:"required"`

	// enabled.
	Enabled *bool `json:"enabled" validate:"required"`
}

HostnameOriginPullSettings : hostname-level authenticated origin pull settings request.

type HostnameSettingsResp 

type HostnameSettingsResp struct {
	// the hostname on the origin for which the client certificate uploaded will be used.
	Hostname *string `json:"hostname,omitempty"`

	// certificate identifier tag.
	CertID *string `json:"cert_id,omitempty"`

	// enabled.
	Enabled *bool `json:"enabled,omitempty"`

	// status of the certificate activation.
	Status *string `json:"status,omitempty"`

	// the time when the certificate was created.
	CreatedAt *strfmt.DateTime `json:"created_at,omitempty"`

	// the time when the certificate was updated.
	UpdatedAt *strfmt.DateTime `json:"updated_at,omitempty"`

	// status of the certificate or the association.
	CertStatus *string `json:"cert_status,omitempty"`

	// the certificate authority that issued the certificate.
	Issuer *string `json:"issuer,omitempty"`

	// the type of hash used for the certificate.
	Signature *string `json:"signature,omitempty"`

	// the serial number on the uploaded certificate.
	SerialNumber *string `json:"serial_number,omitempty"`

	// the zone's leaf certificate.
	Certificate *string `json:"certificate,omitempty"`

	// the time the certificate was uploaded.
	CertUploadedOn *strfmt.DateTime `json:"cert_uploaded_on,omitempty"`

	// the time when the certificate was updated.
	CertUpdatedAt *strfmt.DateTime `json:"cert_updated_at,omitempty"`

	// the date when the certificate expires.
	ExpiresOn *strfmt.DateTime `json:"expires_on,omitempty"`
}

HostnameSettingsResp : hostname level authenticated origin pull settings response.

type ListHostnameOriginPullSettingsResp 

type ListHostnameOriginPullSettingsResp struct {
	// array of hostname settings response.
	Result []HostnameSettingsResp `json:"result,omitempty"`

	// success.
	Success *bool `json:"success,omitempty"`

	Errors []string `json:"errors,omitempty"`

	Messages []string `json:"messages,omitempty"`
}

ListHostnameOriginPullSettingsResp : array of hostname level authenticated origin pull settings response.

type ListZoneOriginPullCertificatesOptions 

type ListZoneOriginPullCertificatesOptions struct {
	// Uniquely identifying a request.
	XCorrelationID *string `json:"X-Correlation-ID,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

ListZoneOriginPullCertificatesOptions : The ListZoneOriginPullCertificates options.

func (*ListZoneOriginPullCertificatesOptions) SetHeaders 

func (options *ListZoneOriginPullCertificatesOptions) SetHeaders(param map[string]string) *ListZoneOriginPullCertificatesOptions

SetHeaders : Allow user to set Headers

func (*ListZoneOriginPullCertificatesOptions) SetXCorrelationID 

func (_options *ListZoneOriginPullCertificatesOptions) SetXCorrelationID(xCorrelationID string) *ListZoneOriginPullCertificatesOptions

SetXCorrelationID : Allow user to set XCorrelationID

type ListZoneOriginPullCertificatesResp 

type ListZoneOriginPullCertificatesResp struct {
	// list certificate packs.
	Result []CertificatePack `json:"result,omitempty"`

	// success.
	Success *bool `json:"success,omitempty"`

	Errors []string `json:"errors,omitempty"`

	Messages []string `json:"messages,omitempty"`
}

ListZoneOriginPullCertificatesResp : certificate response.

type SetHostnameOriginPullSettingsOptions 

type SetHostnameOriginPullSettingsOptions struct {
	// An array with items in the settings request.
	Config []HostnameOriginPullSettings `json:"config,omitempty"`

	// Uniquely identifying a request.
	XCorrelationID *string `json:"X-Correlation-ID,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

SetHostnameOriginPullSettingsOptions : The SetHostnameOriginPullSettings options.

func (*SetHostnameOriginPullSettingsOptions) SetConfig 

func (_options *SetHostnameOriginPullSettingsOptions) SetConfig(config []HostnameOriginPullSettings) *SetHostnameOriginPullSettingsOptions

SetConfig : Allow user to set Config

func (*SetHostnameOriginPullSettingsOptions) SetHeaders 

func (options *SetHostnameOriginPullSettingsOptions) SetHeaders(param map[string]string) *SetHostnameOriginPullSettingsOptions

SetHeaders : Allow user to set Headers

func (*SetHostnameOriginPullSettingsOptions) SetXCorrelationID 

func (_options *SetHostnameOriginPullSettingsOptions) SetXCorrelationID(xCorrelationID string) *SetHostnameOriginPullSettingsOptions

SetXCorrelationID : Allow user to set XCorrelationID

type SetZoneOriginPullSettingsOptions 

type SetZoneOriginPullSettingsOptions struct {
	// enabled.
	Enabled *bool `json:"enabled,omitempty"`

	// Uniquely identifying a request.
	XCorrelationID *string `json:"X-Correlation-ID,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

SetZoneOriginPullSettingsOptions : The SetZoneOriginPullSettings options.

func (*SetZoneOriginPullSettingsOptions) SetEnabled 

func (_options *SetZoneOriginPullSettingsOptions) SetEnabled(enabled bool) *SetZoneOriginPullSettingsOptions

SetEnabled : Allow user to set Enabled

func (*SetZoneOriginPullSettingsOptions) SetHeaders 

func (options *SetZoneOriginPullSettingsOptions) SetHeaders(param map[string]string) *SetZoneOriginPullSettingsOptions

SetHeaders : Allow user to set Headers

func (*SetZoneOriginPullSettingsOptions) SetXCorrelationID 

func (_options *SetZoneOriginPullSettingsOptions) SetXCorrelationID(xCorrelationID string) *SetZoneOriginPullSettingsOptions

SetXCorrelationID : Allow user to set XCorrelationID

type UploadHostnameOriginPullCertificateOptions 

type UploadHostnameOriginPullCertificateOptions struct {
	// the zone's leaf certificate.
	Certificate *string `json:"certificate,omitempty"`

	// the zone's private key.
	PrivateKey *string `json:"private_key,omitempty"`

	// Uniquely identifying a request.
	XCorrelationID *string `json:"X-Correlation-ID,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

UploadHostnameOriginPullCertificateOptions : The UploadHostnameOriginPullCertificate options.

func (*UploadHostnameOriginPullCertificateOptions) SetCertificate 

func (_options *UploadHostnameOriginPullCertificateOptions) SetCertificate(certificate string) *UploadHostnameOriginPullCertificateOptions

SetCertificate : Allow user to set Certificate

func (*UploadHostnameOriginPullCertificateOptions) SetHeaders 

func (options *UploadHostnameOriginPullCertificateOptions) SetHeaders(param map[string]string) *UploadHostnameOriginPullCertificateOptions

SetHeaders : Allow user to set Headers

func (*UploadHostnameOriginPullCertificateOptions) SetPrivateKey 

func (_options *UploadHostnameOriginPullCertificateOptions) SetPrivateKey(privateKey string) *UploadHostnameOriginPullCertificateOptions

SetPrivateKey : Allow user to set PrivateKey

func (*UploadHostnameOriginPullCertificateOptions) SetXCorrelationID 

func (_options *UploadHostnameOriginPullCertificateOptions) SetXCorrelationID(xCorrelationID string) *UploadHostnameOriginPullCertificateOptions

SetXCorrelationID : Allow user to set XCorrelationID

type UploadZoneOriginPullCertificateOptions 

type UploadZoneOriginPullCertificateOptions struct {
	// the zone's leaf certificate.
	Certificate *string `json:"certificate,omitempty"`

	// the zone's private key.
	PrivateKey *string `json:"private_key,omitempty"`

	// Uniquely identifying a request.
	XCorrelationID *string `json:"X-Correlation-ID,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

UploadZoneOriginPullCertificateOptions : The UploadZoneOriginPullCertificate options.

func (*UploadZoneOriginPullCertificateOptions) SetCertificate 

func (_options *UploadZoneOriginPullCertificateOptions) SetCertificate(certificate string) *UploadZoneOriginPullCertificateOptions

SetCertificate : Allow user to set Certificate

func (*UploadZoneOriginPullCertificateOptions) SetHeaders 

func (options *UploadZoneOriginPullCertificateOptions) SetHeaders(param map[string]string) *UploadZoneOriginPullCertificateOptions

SetHeaders : Allow user to set Headers

func (*UploadZoneOriginPullCertificateOptions) SetPrivateKey 

func (_options *UploadZoneOriginPullCertificateOptions) SetPrivateKey(privateKey string) *UploadZoneOriginPullCertificateOptions

SetPrivateKey : Allow user to set PrivateKey

func (*UploadZoneOriginPullCertificateOptions) SetXCorrelationID 

func (_options *UploadZoneOriginPullCertificateOptions) SetXCorrelationID(xCorrelationID string) *UploadZoneOriginPullCertificateOptions

SetXCorrelationID : Allow user to set XCorrelationID

type ZoneOriginPullCertificateResp 

type ZoneOriginPullCertificateResp struct {
	// certificate pack.
	Result *CertificatePack `json:"result,omitempty"`

	// success.
	Success *bool `json:"success,omitempty"`

	Errors []string `json:"errors,omitempty"`

	Messages []string `json:"messages,omitempty"`
}

ZoneOriginPullCertificateResp : zone level authenticated origin pull certificate response.

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.