edge_services

package
v1.0.0-beta.30 Latest Latest
Warning

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

 Go to latest Published: Aug 29, 2024 License: Apache-2.0 Imports: 14 Imported by: 0

Documentation

Overview

Package edge_services provides methods and message types of the edge_services v1alpha1 API.

Index

Constants

View Source 
const (
	// The DNS stage type is unknown by default.
	DNSStageTypeUnknownType = DNSStageType("unknown_type")
	// The DNS stage is configured with the default FQDN.
	DNSStageTypeAuto = DNSStageType("auto")
	// Custom FQDN has been provided, managed by Scaleway Domains and DNS.
	DNSStageTypeManaged = DNSStageType("managed")
	// Custom FQDN has been provided, not managed by Scaleway Domains and DNS.
	DNSStageTypeCustom = DNSStageType("custom")
)
View Source 
const (
	LBOriginErrorUnknown           = LBOriginError("unknown")
	LBOriginErrorTimeout           = LBOriginError("timeout")
	LBOriginErrorConnectionRefused = LBOriginError("connection_refused")
	LBOriginErrorTLSError          = LBOriginError("tls_error")
)
View Source 
const (
	// Order by creation date (ascending chronological order).
	ListBackendStagesRequestOrderByCreatedAtAsc = ListBackendStagesRequestOrderBy("created_at_asc")
	// Order by creation date (descending chronological order).
	ListBackendStagesRequestOrderByCreatedAtDesc = ListBackendStagesRequestOrderBy("created_at_desc")
)
View Source 
const (
	// Order by creation date (ascending chronological order).
	ListCacheStagesRequestOrderByCreatedAtAsc = ListCacheStagesRequestOrderBy("created_at_asc")
	// Order by creation date (descending chronological order).
	ListCacheStagesRequestOrderByCreatedAtDesc = ListCacheStagesRequestOrderBy("created_at_desc")
)
View Source 
const (
	// Order by creation date (ascending chronological order).
	ListDNSStagesRequestOrderByCreatedAtAsc = ListDNSStagesRequestOrderBy("created_at_asc")
	// Order by creation date (descending chronological order).
	ListDNSStagesRequestOrderByCreatedAtDesc = ListDNSStagesRequestOrderBy("created_at_desc")
)
View Source 
const (
	ListPipelinesRequestOrderByCreatedAtAsc  = ListPipelinesRequestOrderBy("created_at_asc")
	ListPipelinesRequestOrderByCreatedAtDesc = ListPipelinesRequestOrderBy("created_at_desc")
	ListPipelinesRequestOrderByNameAsc       = ListPipelinesRequestOrderBy("name_asc")
	ListPipelinesRequestOrderByNameDesc      = ListPipelinesRequestOrderBy("name_desc")
)
View Source 
const (
	// Order by creation date (ascending chronological order).
	ListPurgeRequestsRequestOrderByCreatedAtAsc = ListPurgeRequestsRequestOrderBy("created_at_asc")
	// Order by creation date (descending chronological order).
	ListPurgeRequestsRequestOrderByCreatedAtDesc = ListPurgeRequestsRequestOrderBy("created_at_desc")
)
View Source 
const (
	// Order by creation date (ascending chronological order).
	ListTLSStagesRequestOrderByCreatedAtAsc = ListTLSStagesRequestOrderBy("created_at_asc")
	// Order by creation date (descending chronological order).
	ListTLSStagesRequestOrderByCreatedAtDesc = ListTLSStagesRequestOrderBy("created_at_desc")
)
View Source 
const (
	PipelineErrorCodeUnknownCode               = PipelineErrorCode("unknown_code")
	PipelineErrorCodeDNSInvalidFormat          = PipelineErrorCode("dns_invalid_format")
	PipelineErrorCodeDNSInvalidTld             = PipelineErrorCode("dns_invalid_tld")
	PipelineErrorCodeDNSForbiddenRootDomain    = PipelineErrorCode("dns_forbidden_root_domain")
	PipelineErrorCodeDNSForbiddenScwCloud      = PipelineErrorCode("dns_forbidden_scw_cloud")
	PipelineErrorCodeDNSDomainDontExist        = PipelineErrorCode("dns_domain_dont_exist")
	PipelineErrorCodeDNSCnameDontExist         = PipelineErrorCode("dns_cname_dont_exist")
	PipelineErrorCodeDNSCnameResolve           = PipelineErrorCode("dns_cname_resolve")
	PipelineErrorCodeDNSFqdnAlreadyExists      = PipelineErrorCode("dns_fqdn_already_exists")
	PipelineErrorCodeDNSFqdnAlreadyInUse       = PipelineErrorCode("dns_fqdn_already_in_use")
	PipelineErrorCodeTLSCertDeleted            = PipelineErrorCode("tls_cert_deleted")
	PipelineErrorCodeTLSCertDisabled           = PipelineErrorCode("tls_cert_disabled")
	PipelineErrorCodeTLSCertExpired            = PipelineErrorCode("tls_cert_expired")
	PipelineErrorCodeTLSCertInvalidFormat      = PipelineErrorCode("tls_cert_invalid_format")
	PipelineErrorCodeTLSCertMissing            = PipelineErrorCode("tls_cert_missing")
	PipelineErrorCodeTLSChainOrder             = PipelineErrorCode("tls_chain_order")
	PipelineErrorCodeTLSKeyInvalidFormat       = PipelineErrorCode("tls_key_invalid_format")
	PipelineErrorCodeTLSKeyMissing             = PipelineErrorCode("tls_key_missing")
	PipelineErrorCodeTLSKeyTooMany             = PipelineErrorCode("tls_key_too_many")
	PipelineErrorCodeTLSManagedDomainRateLimit = PipelineErrorCode("tls_managed_domain_rate_limit")
	PipelineErrorCodeTLSManagedInternal        = PipelineErrorCode("tls_managed_internal")
	PipelineErrorCodeTLSPairMismatch           = PipelineErrorCode("tls_pair_mismatch")
	PipelineErrorCodeTLSRootInconsistent       = PipelineErrorCode("tls_root_inconsistent")
	PipelineErrorCodeTLSRootIncorrect          = PipelineErrorCode("tls_root_incorrect")
	PipelineErrorCodeTLSRootMissing            = PipelineErrorCode("tls_root_missing")
	PipelineErrorCodeTLSSanMismatch            = PipelineErrorCode("tls_san_mismatch")
	PipelineErrorCodeTLSSelfSigned             = PipelineErrorCode("tls_self_signed")
)
View Source 
const (
	PipelineErrorSeverityUnknownSeverity = PipelineErrorSeverity("unknown_severity")
	PipelineErrorSeverityWarning         = PipelineErrorSeverity("warning")
	PipelineErrorSeverityCritical        = PipelineErrorSeverity("critical")
)
View Source 
const (
	PipelineErrorStageUnknownStage = PipelineErrorStage("unknown_stage")
	PipelineErrorStageDNS          = PipelineErrorStage("dns")
	PipelineErrorStageTLS          = PipelineErrorStage("tls")
	PipelineErrorStageCache        = PipelineErrorStage("cache")
	PipelineErrorStageBackend      = PipelineErrorStage("backend")
)
View Source 
const (
	PipelineErrorTypeUnknownType = PipelineErrorType("unknown_type")
	PipelineErrorTypeRuntime     = PipelineErrorType("runtime")
	PipelineErrorTypeConfig      = PipelineErrorType("config")
)
View Source 
const (
	PipelineStatusUnknownStatus = PipelineStatus("unknown_status")
	PipelineStatusReady         = PipelineStatus("ready")
	PipelineStatusError         = PipelineStatus("error")
	PipelineStatusPending       = PipelineStatus("pending")
	PipelineStatusWarning       = PipelineStatus("warning")
)
View Source 
const (
	// The purge request status is unknown by default.
	PurgeRequestStatusUnknownStatus = PurgeRequestStatus("unknown_status")
	// The purge request has been processed sucessfully.
	PurgeRequestStatusDone = PurgeRequestStatus("done")
	// An error occurred during the purge request.
	PurgeRequestStatusError = PurgeRequestStatus("error")
	// The purge request status is pending.
	PurgeRequestStatusPending = PurgeRequestStatus("pending")
)

Variables

This section is empty.

Functions

This section is empty.

Types

type API 

type API struct {
	// contains filtered or unexported fields
}

func NewAPI 

func NewAPI(client *scw.Client) *API

NewAPI returns a API object from a Scaleway client.

func (*API) CheckDomain 

func (s *API) CheckDomain(req *CheckDomainRequest, opts ...scw.RequestOption) (*CheckDomainResponse, error)

CheckDomain:

func (*API) CheckLBOrigin 

func (s *API) CheckLBOrigin(req *CheckLBOriginRequest, opts ...scw.RequestOption) (*CheckLBOriginResponse, error)

CheckLBOrigin:

func (*API) CheckPEMChain 

func (s *API) CheckPEMChain(req *CheckPEMChainRequest, opts ...scw.RequestOption) (*CheckPEMChainResponse, error)

CheckPEMChain:

func (*API) CreateBackendStage 

func (s *API) CreateBackendStage(req *CreateBackendStageRequest, opts ...scw.RequestOption) (*BackendStage, error)

CreateBackendStage: Create a new backend stage. You must specify either a `scaleway_s3` (for a Scaleway Object Storage bucket) or `scaleway_lb` (for a Scaleway Load Balancer) field to configure the origin.

func (*API) CreateCacheStage 

func (s *API) CreateCacheStage(req *CreateCacheStageRequest, opts ...scw.RequestOption) (*CacheStage, error)

CreateCacheStage: Create a new cache stage. You must specify the `fallback_ttl` field to customize the TTL of the cache.

func (*API) CreateDNSStage 

func (s *API) CreateDNSStage(req *CreateDNSStageRequest, opts ...scw.RequestOption) (*DNSStage, error)

CreateDNSStage: Create a new DNS stage. You must specify the `fqdns` field to customize the domain endpoint, using a domain you already own.

func (*API) CreatePipeline 

func (s *API) CreatePipeline(req *CreatePipelineRequest, opts ...scw.RequestOption) (*Pipeline, error)

CreatePipeline: Create a new pipeline. You must specify a `dns_stage_id` to form a stage-chain that goes all the way to the backend stage (origin), so the HTTP request will be processed according to the stages you created.

func (*API) CreatePurgeRequest 

func (s *API) CreatePurgeRequest(req *CreatePurgeRequestRequest, opts ...scw.RequestOption) (*PurgeRequest, error)

CreatePurgeRequest: Create a new purge request. You must specify either the `all` field (to purge all content) or a list of `assets` (to define the precise assets to purge).

func (*API) CreateTLSStage 

func (s *API) CreateTLSStage(req *CreateTLSStageRequest, opts ...scw.RequestOption) (*TLSStage, error)

CreateTLSStage: Create a new TLS stage. You must specify either the `secrets` or `managed_certificate` fields to customize the SSL/TLS certificate of your endpoint. Choose `secrets` if you are using a pre-existing certificate held in Scaleway Secret Manager, or `managed_certificate` to let Scaleway generate and manage a Let's Encrypt certificate for your customized endpoint.

func (*API) DeleteBackendStage 

func (s *API) DeleteBackendStage(req *DeleteBackendStageRequest, opts ...scw.RequestOption) error

DeleteBackendStage: Delete an existing backend stage, specified by its `backend_stage_id`. Deleting a backend stage is permanent, and cannot be undone.

func (*API) DeleteCacheStage 

func (s *API) DeleteCacheStage(req *DeleteCacheStageRequest, opts ...scw.RequestOption) error

DeleteCacheStage: Delete an existing cache stage, specified by its `cache_stage_id`. Deleting a cache stage is permanent, and cannot be undone.

func (*API) DeleteDNSStage 

func (s *API) DeleteDNSStage(req *DeleteDNSStageRequest, opts ...scw.RequestOption) error

DeleteDNSStage: Delete an existing DNS stage, specified by its `dns_stage_id`. Deleting a DNS stage is permanent, and cannot be undone.

func (*API) DeletePipeline 

func (s *API) DeletePipeline(req *DeletePipelineRequest, opts ...scw.RequestOption) error

DeletePipeline: Delete an existing pipeline, specified by its `pipeline_id`. Deleting a pipeline is permanent, and cannot be undone. Note that all stages linked to the pipeline are also deleted.

func (*API) DeleteTLSStage 

func (s *API) DeleteTLSStage(req *DeleteTLSStageRequest, opts ...scw.RequestOption) error

DeleteTLSStage: Delete an existing TLS stage, specified by its `tls_stage_id`. Deleting a TLS stage is permanent, and cannot be undone.

func (*API) GetBackendStage 

func (s *API) GetBackendStage(req *GetBackendStageRequest, opts ...scw.RequestOption) (*BackendStage, error)

GetBackendStage: Retrieve information about an existing backend stage, specified by its `backend_stage_id`. Its full details, including `scaleway_s3` or `scaleway_lb`, are returned in the response object.

func (*API) GetCacheStage 

func (s *API) GetCacheStage(req *GetCacheStageRequest, opts ...scw.RequestOption) (*CacheStage, error)

GetCacheStage: Retrieve information about an existing cache stage, specified by its `cache_stage_id`. Its full details, including Time To Live (TTL), are returned in the response object.

func (*API) GetDNSStage 

func (s *API) GetDNSStage(req *GetDNSStageRequest, opts ...scw.RequestOption) (*DNSStage, error)

GetDNSStage: Retrieve information about an existing DNS stage, specified by its `dns_stage_id`. Its full details, including FQDNs, are returned in the response object.

func (*API) GetPipeline 

func (s *API) GetPipeline(req *GetPipelineRequest, opts ...scw.RequestOption) (*Pipeline, error)

GetPipeline: Retrieve information about an existing pipeline, specified by its `pipeline_id`. Its full details, including errors, are returned in the response object.

func (*API) GetPurgeRequest 

func (s *API) GetPurgeRequest(req *GetPurgeRequestRequest, opts ...scw.RequestOption) (*PurgeRequest, error)

GetPurgeRequest: Retrieve information about a purge request, specified by its `purge_request_id`. Its full details, including `status` and `target`, are returned in the response object.

func (*API) GetTLSStage 

func (s *API) GetTLSStage(req *GetTLSStageRequest, opts ...scw.RequestOption) (*TLSStage, error)

GetTLSStage: Retrieve information about an existing TLS stage, specified by its `tls_stage_id`. Its full details, including secrets and certificate expiration date are returned in the response object.

func (*API) ListBackendStages 

func (s *API) ListBackendStages(req *ListBackendStagesRequest, opts ...scw.RequestOption) (*ListBackendStagesResponse, error)

ListBackendStages: List all backend stages, for a Scaleway Organization or Scaleway Project. By default, the backend stages returned in the list are ordered by creation date in ascending order, though this can be modified via the `order_by` field.

func (*API) ListCacheStages 

func (s *API) ListCacheStages(req *ListCacheStagesRequest, opts ...scw.RequestOption) (*ListCacheStagesResponse, error)

ListCacheStages: List all cache stages, for a Scaleway Organization or Scaleway Project. By default, the cache stages returned in the list are ordered by creation date in ascending order, though this can be modified via the `order_by` field.

func (*API) ListDNSStages 

func (s *API) ListDNSStages(req *ListDNSStagesRequest, opts ...scw.RequestOption) (*ListDNSStagesResponse, error)

ListDNSStages: List all DNS stages, for a Scaleway Organization or Scaleway Project. By default, the DNS stages returned in the list are ordered by creation date in ascending order, though this can be modified via the `order_by` field.

func (*API) ListPipelines 

func (s *API) ListPipelines(req *ListPipelinesRequest, opts ...scw.RequestOption) (*ListPipelinesResponse, error)

ListPipelines: List all pipelines, for a Scaleway Organization or Scaleway Project. By default, the pipelines returned in the list are ordered by creation date in ascending order, though this can be modified via the `order_by` field.

func (*API) ListPurgeRequests 

func (s *API) ListPurgeRequests(req *ListPurgeRequestsRequest, opts ...scw.RequestOption) (*ListPurgeRequestsResponse, error)

ListPurgeRequests: List all purge requests, for a Scaleway Organization or Scaleway Project. This enables you to retrieve a history of all previously-made purge requests. By default, the purge requests returned in the list are ordered by creation date in ascending order, though this can be modified via the `order_by` field.

func (*API) ListTLSStages 

func (s *API) ListTLSStages(req *ListTLSStagesRequest, opts ...scw.RequestOption) (*ListTLSStagesResponse, error)

ListTLSStages: List all TLS stages, for a Scaleway Organization or Scaleway Project. By default, the TLS stages returned in the list are ordered by creation date in ascending order, though this can be modified via the `order_by` field.

func (*API) UpdateBackendStage 

func (s *API) UpdateBackendStage(req *UpdateBackendStageRequest, opts ...scw.RequestOption) (*BackendStage, error)

UpdateBackendStage: Update the parameters of an existing backend stage, specified by its `backend_stage_id`.

func (*API) UpdateCacheStage 

func (s *API) UpdateCacheStage(req *UpdateCacheStageRequest, opts ...scw.RequestOption) (*CacheStage, error)

UpdateCacheStage: Update the parameters of an existing cache stage, specified by its `cache_stage_id`. Parameters which can be updated include the `fallback_ttl` and `backend_stage_id`.

func (*API) UpdateDNSStage 

func (s *API) UpdateDNSStage(req *UpdateDNSStageRequest, opts ...scw.RequestOption) (*DNSStage, error)

UpdateDNSStage: Update the parameters of an existing DNS stage, specified by its `dns_stage_id`.

func (*API) UpdatePipeline 

func (s *API) UpdatePipeline(req *UpdatePipelineRequest, opts ...scw.RequestOption) (*Pipeline, error)

UpdatePipeline: Update the parameters of an existing pipeline, specified by its `pipeline_id`. Parameters which can be updated include the `name`, `description` and `dns_stage_id`.

func (*API) UpdateTLSStage 

func (s *API) UpdateTLSStage(req *UpdateTLSStageRequest, opts ...scw.RequestOption) (*TLSStage, error)

UpdateTLSStage: Update the parameters of an existing TLS stage, specified by its `tls_stage_id`. Both `tls_secrets_config` and `managed_certificate` parameters can be updated.

func (*API) WaitForPipeline 

func (s *API) WaitForPipeline(req *WaitForPipelineRequest, opts ...scw.RequestOption) (*Pipeline, error)

WaitForPipeline wait for a pipeline to be in a "terminal state" before returning.

func (*API) WaitForPurgeRequest 

func (s *API) WaitForPurgeRequest(req *WaitForPurgeRequestRequest, opts ...scw.RequestOption) (*PurgeRequest, error)

WaitForPurgeRequest wait for a purge request to be in a "terminal state" before returning.

type BackendStage 

type BackendStage struct {
	// ID: ID of the backend stage.
	ID string `json:"id"`

	// PipelineID: pipeline ID the backend stage belongs to.
	PipelineID *string `json:"pipeline_id"`

	// ProjectID: project ID of the backend stage.
	ProjectID string `json:"project_id"`

	// CreatedAt: date the backend stage was created.
	CreatedAt *time.Time `json:"created_at"`

	// UpdatedAt: date the backend stage was last updated.
	UpdatedAt *time.Time `json:"updated_at"`

	// ScalewayS3: scaleway Object Storage origin bucket (S3) linked to the backend stage.
	// Precisely one of ScalewayS3, ScalewayLB must be set.
	ScalewayS3 *ScalewayS3BackendConfig `json:"scaleway_s3,omitempty"`

	// ScalewayLB: scaleway Load Balancer origin linked to the backend stage.
	// Precisely one of ScalewayS3, ScalewayLB must be set.
	ScalewayLB *ScalewayLBBackendConfig `json:"scaleway_lb,omitempty"`
}

BackendStage: backend stage.

type CacheStage 

type CacheStage struct {
	// ID: ID of the cache stage.
	ID string `json:"id"`

	// PipelineID: pipeline ID the cache stage belongs to.
	PipelineID *string `json:"pipeline_id"`

	// ProjectID: project ID of the cache stage.
	ProjectID string `json:"project_id"`

	// FallbackTTL: time To Live (TTL) in seconds. Defines how long content is cached.
	FallbackTTL *scw.Duration `json:"fallback_ttl"`

	// CreatedAt: date the cache stage was created.
	CreatedAt *time.Time `json:"created_at"`

	// UpdatedAt: date the cache stage was last updated.
	UpdatedAt *time.Time `json:"updated_at"`

	// BackendStageID: backend stage ID the cache stage is linked to.
	// Precisely one of BackendStageID must be set.
	BackendStageID *string `json:"backend_stage_id,omitempty"`
}

CacheStage: cache stage.

type CheckDomainRequest 

type CheckDomainRequest struct {
	ProjectID string `json:"project_id"`

	Fqdn string `json:"fqdn"`

	Cname string `json:"cname"`
}

CheckDomainRequest: check domain request.

type CheckDomainResponse 

type CheckDomainResponse struct {
	IsValid bool `json:"is_valid"`
}

CheckDomainResponse: check domain response.

type CheckLBOriginRequest 

type CheckLBOriginRequest struct {
	LB *ScalewayLB `json:"lb,omitempty"`
}

CheckLBOriginRequest: check lb origin request.

type CheckLBOriginResponse 

type CheckLBOriginResponse struct {
	IsValid bool `json:"is_valid"`

	// ErrorType: default value: unknown
	ErrorType LBOriginError `json:"error_type"`
}

CheckLBOriginResponse: check lb origin response.

type CheckPEMChainRequest 

type CheckPEMChainRequest struct {
	ProjectID string `json:"project_id"`

	Fqdn string `json:"fqdn"`

	// Precisely one of Secret, Raw must be set.
	Secret *CheckPEMChainRequestSecretChain `json:"secret,omitempty"`

	// Precisely one of Secret, Raw must be set.
	Raw *string `json:"raw,omitempty"`
}

CheckPEMChainRequest: check pem chain request.

type CheckPEMChainRequestSecretChain 

type CheckPEMChainRequestSecretChain struct {
	SecretID string `json:"secret_id"`

	SecretRegion string `json:"secret_region"`
}

CheckPEMChainRequestSecretChain: check pem chain request secret chain.

type CheckPEMChainResponse 

type CheckPEMChainResponse struct {
	IsValid bool `json:"is_valid"`
}

CheckPEMChainResponse: check pem chain response.

type CreateBackendStageRequest 

type CreateBackendStageRequest struct {
	// ProjectID: project ID in which the backend stage will be created.
	ProjectID string `json:"project_id"`

	// ScalewayS3: scaleway Object Storage origin bucket (S3) linked to the backend stage.
	// Precisely one of ScalewayS3, ScalewayLB must be set.
	ScalewayS3 *ScalewayS3BackendConfig `json:"scaleway_s3,omitempty"`

	// ScalewayLB: scaleway Load Balancer origin linked to the backend stage.
	// Precisely one of ScalewayS3, ScalewayLB must be set.
	ScalewayLB *ScalewayLBBackendConfig `json:"scaleway_lb,omitempty"`
}

CreateBackendStageRequest: create backend stage request.

type CreateCacheStageRequest 

type CreateCacheStageRequest struct {
	// ProjectID: project ID in which the cache stage will be created.
	ProjectID string `json:"project_id"`

	// FallbackTTL: time To Live (TTL) in seconds. Defines how long content is cached.
	FallbackTTL *scw.Duration `json:"fallback_ttl,omitempty"`

	// BackendStageID: backend stage ID the cache stage will be linked to.
	// Precisely one of BackendStageID must be set.
	BackendStageID *string `json:"backend_stage_id,omitempty"`
}

CreateCacheStageRequest: create cache stage request.

type CreateDNSStageRequest 

type CreateDNSStageRequest struct {
	// ProjectID: project ID in which the DNS stage will be created.
	ProjectID string `json:"project_id"`

	// Fqdns: fully Qualified Domain Name (in the format subdomain.example.com) to attach to the stage.
	Fqdns *[]string `json:"fqdns,omitempty"`

	// TLSStageID: TLS stage ID the DNS stage will be linked to.
	// Precisely one of TLSStageID, CacheStageID, BackendStageID must be set.
	TLSStageID *string `json:"tls_stage_id,omitempty"`

	// CacheStageID: cache stage ID the DNS stage will be linked to.
	// Precisely one of TLSStageID, CacheStageID, BackendStageID must be set.
	CacheStageID *string `json:"cache_stage_id,omitempty"`

	// BackendStageID: backend stage ID the DNS stage will be linked to.
	// Precisely one of TLSStageID, CacheStageID, BackendStageID must be set.
	BackendStageID *string `json:"backend_stage_id,omitempty"`
}

CreateDNSStageRequest: create dns stage request.

type CreatePipelineRequest 

type CreatePipelineRequest struct {
	// ProjectID: project ID in which the pipeline will be created.
	ProjectID string `json:"project_id"`

	// Name: name of the pipeline.
	Name string `json:"name"`

	// Description: description of the pipeline.
	Description string `json:"description"`

	// DNSStageID: DNS stage ID the pipeline will be attached to.
	// Precisely one of DNSStageID must be set.
	DNSStageID *string `json:"dns_stage_id,omitempty"`
}

CreatePipelineRequest: create pipeline request.

type CreatePurgeRequestRequest 

type CreatePurgeRequestRequest struct {
	// PipelineID: pipeline ID in which the purge request will be created.
	PipelineID string `json:"pipeline_id"`

	// Assets: list of asserts to purge.
	// Precisely one of Assets, All must be set.
	Assets *[]string `json:"assets,omitempty"`

	// All: defines whether to purge all content.
	// Precisely one of Assets, All must be set.
	All *bool `json:"all,omitempty"`
}

CreatePurgeRequestRequest: create purge request request.

type CreateTLSStageRequest 

type CreateTLSStageRequest struct {
	// ProjectID: project ID in which the TLS stage will be created.
	ProjectID string `json:"project_id"`

	// Secrets: secret (from Scaleway Secret Manager) containing your custom certificate.
	Secrets []*TLSSecret `json:"secrets"`

	// ManagedCertificate: true when Scaleway generates and manages a Let's Encrypt certificate for the TLS stage/custom endpoint.
	ManagedCertificate *bool `json:"managed_certificate,omitempty"`

	// CacheStageID: cache stage ID the TLS stage will be linked to.
	// Precisely one of CacheStageID, BackendStageID must be set.
	CacheStageID *string `json:"cache_stage_id,omitempty"`

	// BackendStageID: backend stage ID the TLS stage will be linked to.
	// Precisely one of CacheStageID, BackendStageID must be set.
	BackendStageID *string `json:"backend_stage_id,omitempty"`
}

CreateTLSStageRequest: create tls stage request.

type DNSStage 

type DNSStage struct {
	// ID: ID of the DNS stage.
	ID string `json:"id"`

	// Fqdns: list of Fully Qualified Domain Names attached to the stage.
	Fqdns []string `json:"fqdns"`

	// Type: type of the stage.
	// Default value: unknown_type
	Type DNSStageType `json:"type"`

	// PipelineID: pipeline ID the DNS stage belongs to.
	PipelineID *string `json:"pipeline_id"`

	// ProjectID: project ID of the DNS stage.
	ProjectID string `json:"project_id"`

	// CreatedAt: date the DNS stage was created.
	CreatedAt *time.Time `json:"created_at"`

	// UpdatedAt: date the DNS stage was last updated.
	UpdatedAt *time.Time `json:"updated_at"`

	// TLSStageID: TLS stage ID the DNS stage is linked to.
	// Precisely one of TLSStageID, CacheStageID, BackendStageID must be set.
	TLSStageID *string `json:"tls_stage_id,omitempty"`

	// CacheStageID: cache stage ID the DNS stage is linked to.
	// Precisely one of TLSStageID, CacheStageID, BackendStageID must be set.
	CacheStageID *string `json:"cache_stage_id,omitempty"`

	// BackendStageID: backend stage ID the DNS stage is linked to.
	// Precisely one of TLSStageID, CacheStageID, BackendStageID must be set.
	BackendStageID *string `json:"backend_stage_id,omitempty"`
}

DNSStage: dns stage.

type DNSStageType 

type DNSStageType string

func (DNSStageType) MarshalJSON 

func (enum DNSStageType) MarshalJSON() ([]byte, error)

func (DNSStageType) String 

func (enum DNSStageType) String() string

func (*DNSStageType) UnmarshalJSON 

func (enum *DNSStageType) UnmarshalJSON(data []byte) error

func (DNSStageType) Values 

func (enum DNSStageType) Values() []DNSStageType

type DeleteBackendStageRequest 

type DeleteBackendStageRequest struct {
	// BackendStageID: ID of the backend stage to delete.
	BackendStageID string `json:"-"`
}

DeleteBackendStageRequest: delete backend stage request.

type DeleteCacheStageRequest 

type DeleteCacheStageRequest struct {
	// CacheStageID: ID of the cache stage to delete.
	CacheStageID string `json:"-"`
}

DeleteCacheStageRequest: delete cache stage request.

type DeleteDNSStageRequest 

type DeleteDNSStageRequest struct {
	// DNSStageID: ID of the DNS stage to delete.
	DNSStageID string `json:"-"`
}

DeleteDNSStageRequest: delete dns stage request.

type DeletePipelineRequest 

type DeletePipelineRequest struct {
	// PipelineID: ID of the pipeline to delete.
	PipelineID string `json:"-"`
}

DeletePipelineRequest: delete pipeline request.

type DeleteTLSStageRequest 

type DeleteTLSStageRequest struct {
	// TLSStageID: ID of the TLS stage to delete.
	TLSStageID string `json:"-"`
}

DeleteTLSStageRequest: delete tls stage request.

type GetBackendStageRequest 

type GetBackendStageRequest struct {
	// BackendStageID: ID of the requested backend stage.
	BackendStageID string `json:"-"`
}

GetBackendStageRequest: get backend stage request.

type GetCacheStageRequest 

type GetCacheStageRequest struct {
	// CacheStageID: ID of the requested cache stage.
	CacheStageID string `json:"-"`
}

GetCacheStageRequest: get cache stage request.

type GetDNSStageRequest 

type GetDNSStageRequest struct {
	// DNSStageID: ID of the requested DNS stage.
	DNSStageID string `json:"-"`
}

GetDNSStageRequest: get dns stage request.

type GetPipelineRequest 

type GetPipelineRequest struct {
	// PipelineID: ID of the requested pipeline.
	PipelineID string `json:"-"`
}

GetPipelineRequest: get pipeline request.

type GetPurgeRequestRequest 

type GetPurgeRequestRequest struct {
	// PurgeRequestID: ID of the requested purge request.
	PurgeRequestID string `json:"-"`
}

GetPurgeRequestRequest: get purge request request.

type GetTLSStageRequest 

type GetTLSStageRequest struct {
	// TLSStageID: ID of the requested TLS stage.
	TLSStageID string `json:"-"`
}

GetTLSStageRequest: get tls stage request.

type LBOriginError 

type LBOriginError string

func (LBOriginError) MarshalJSON 

func (enum LBOriginError) MarshalJSON() ([]byte, error)

func (LBOriginError) String 

func (enum LBOriginError) String() string

func (*LBOriginError) UnmarshalJSON 

func (enum *LBOriginError) UnmarshalJSON(data []byte) error

func (LBOriginError) Values 

func (enum LBOriginError) Values() []LBOriginError

type ListBackendStagesRequest 

type ListBackendStagesRequest struct {
	// OrderBy: sort order of backend stages in the response.
	// Default value: created_at_asc
	OrderBy ListBackendStagesRequestOrderBy `json:"-"`

	// Page: page number to return, from the paginated results.
	Page *int32 `json:"-"`

	// PageSize: number of backend stages to return per page.
	PageSize *uint32 `json:"-"`

	// PipelineID: pipeline ID to filter for, only backend stages from this pipeline will be returned.
	PipelineID *string `json:"-"`

	// ProjectID: project ID to filter for, only backend stages from this Project will be returned.
	ProjectID *string `json:"-"`

	// BucketName: bucket name to filter for, only backend stages from this Bucket will be returned.
	BucketName *string `json:"-"`

	// BucketRegion: bucket region to filter for, only backend stages with buckets in this region will be returned.
	BucketRegion *string `json:"-"`

	// LBID: load Balancer ID to filter for, only backend stages with this Load Balancer will be returned.
	LBID *string `json:"-"`
}

ListBackendStagesRequest: list backend stages request.

type ListBackendStagesRequestOrderBy 

type ListBackendStagesRequestOrderBy string

func (ListBackendStagesRequestOrderBy) MarshalJSON 

func (enum ListBackendStagesRequestOrderBy) MarshalJSON() ([]byte, error)

func (ListBackendStagesRequestOrderBy) String 

func (enum ListBackendStagesRequestOrderBy) String() string

func (*ListBackendStagesRequestOrderBy) UnmarshalJSON 

func (enum *ListBackendStagesRequestOrderBy) UnmarshalJSON(data []byte) error

func (ListBackendStagesRequestOrderBy) Values 

func (enum ListBackendStagesRequestOrderBy) Values() []ListBackendStagesRequestOrderBy

type ListBackendStagesResponse 

type ListBackendStagesResponse struct {
	// Stages: paginated list of backend stages.
	Stages []*BackendStage `json:"stages"`

	// TotalCount: count of all backend stages matching the requested criteria.
	TotalCount uint64 `json:"total_count"`
}

ListBackendStagesResponse: list backend stages response.

func (*ListBackendStagesResponse) UnsafeAppend 

func (r *ListBackendStagesResponse) UnsafeAppend(res interface{}) (uint64, error)

UnsafeAppend should not be used Internal usage only

func (*ListBackendStagesResponse) UnsafeGetTotalCount 

func (r *ListBackendStagesResponse) UnsafeGetTotalCount() uint64

UnsafeGetTotalCount should not be used Internal usage only

type ListCacheStagesRequest 

type ListCacheStagesRequest struct {
	// OrderBy: sort order of cache stages in the response.
	// Default value: created_at_asc
	OrderBy ListCacheStagesRequestOrderBy `json:"-"`

	// Page: page number to return, from the paginated results.
	Page *int32 `json:"-"`

	// PageSize: number of cache stages to return per page.
	PageSize *uint32 `json:"-"`

	// PipelineID: pipeline ID to filter for, only cache stages from this pipeline will be returned.
	PipelineID *string `json:"-"`

	// ProjectID: project ID to filter for, only cache stages from this Project will be returned.
	ProjectID *string `json:"-"`
}

ListCacheStagesRequest: list cache stages request.

type ListCacheStagesRequestOrderBy 

type ListCacheStagesRequestOrderBy string

func (ListCacheStagesRequestOrderBy) MarshalJSON 

func (enum ListCacheStagesRequestOrderBy) MarshalJSON() ([]byte, error)

func (ListCacheStagesRequestOrderBy) String 

func (enum ListCacheStagesRequestOrderBy) String() string

func (*ListCacheStagesRequestOrderBy) UnmarshalJSON 

func (enum *ListCacheStagesRequestOrderBy) UnmarshalJSON(data []byte) error

func (ListCacheStagesRequestOrderBy) Values 

func (enum ListCacheStagesRequestOrderBy) Values() []ListCacheStagesRequestOrderBy

type ListCacheStagesResponse 

type ListCacheStagesResponse struct {
	// Stages: paginated list of cache stages.
	Stages []*CacheStage `json:"stages"`

	// TotalCount: count of all cache stages matching the requested criteria.
	TotalCount uint64 `json:"total_count"`
}

ListCacheStagesResponse: list cache stages response.

func (*ListCacheStagesResponse) UnsafeAppend 

func (r *ListCacheStagesResponse) UnsafeAppend(res interface{}) (uint64, error)

UnsafeAppend should not be used Internal usage only

func (*ListCacheStagesResponse) UnsafeGetTotalCount 

func (r *ListCacheStagesResponse) UnsafeGetTotalCount() uint64

UnsafeGetTotalCount should not be used Internal usage only

type ListDNSStagesRequest 

type ListDNSStagesRequest struct {
	// OrderBy: sort order of DNS stages in the response.
	// Default value: created_at_asc
	OrderBy ListDNSStagesRequestOrderBy `json:"-"`

	// Page: page number to return, from the paginated results.
	Page *int32 `json:"-"`

	// PageSize: number of DNS stages to return per page.
	PageSize *uint32 `json:"-"`

	// PipelineID: pipeline ID to filter for, only DNS stages from this pipeline will be returned.
	PipelineID *string `json:"-"`

	// ProjectID: project ID to filter for, only DNS stages from this Project will be returned.
	ProjectID *string `json:"-"`

	// Fqdn: fully Qualified Domain Name to filter for (in the format subdomain.example.com), only DNS stages with this FQDN will be returned.
	Fqdn *string `json:"-"`
}

ListDNSStagesRequest: list dns stages request.

type ListDNSStagesRequestOrderBy 

type ListDNSStagesRequestOrderBy string

func (ListDNSStagesRequestOrderBy) MarshalJSON 

func (enum ListDNSStagesRequestOrderBy) MarshalJSON() ([]byte, error)

func (ListDNSStagesRequestOrderBy) String 

func (enum ListDNSStagesRequestOrderBy) String() string

func (*ListDNSStagesRequestOrderBy) UnmarshalJSON 

func (enum *ListDNSStagesRequestOrderBy) UnmarshalJSON(data []byte) error

func (ListDNSStagesRequestOrderBy) Values 

func (enum ListDNSStagesRequestOrderBy) Values() []ListDNSStagesRequestOrderBy

type ListDNSStagesResponse 

type ListDNSStagesResponse struct {
	// Stages: paginated list of DNS stages.
	Stages []*DNSStage `json:"stages"`

	// TotalCount: count of all DNS stages matching the requested criteria.
	TotalCount uint64 `json:"total_count"`
}

ListDNSStagesResponse: list dns stages response.

func (*ListDNSStagesResponse) UnsafeAppend 

func (r *ListDNSStagesResponse) UnsafeAppend(res interface{}) (uint64, error)

UnsafeAppend should not be used Internal usage only

func (*ListDNSStagesResponse) UnsafeGetTotalCount 

func (r *ListDNSStagesResponse) UnsafeGetTotalCount() uint64

UnsafeGetTotalCount should not be used Internal usage only

type ListPipelinesRequest 

type ListPipelinesRequest struct {
	// OrderBy: sort order of pipelines in the response.
	// Default value: created_at_asc
	OrderBy ListPipelinesRequestOrderBy `json:"-"`

	// Page: page number to return, from the paginated results.
	Page *int32 `json:"-"`

	// PageSize: number of pipelines to return per page.
	PageSize *uint32 `json:"-"`

	// Name: pipeline name to filter for, only pipelines with this string within their name will be returned.
	Name *string `json:"-"`

	// OrganizationID: organization ID to filter for, only pipelines from this Organization will be returned.
	OrganizationID *string `json:"-"`

	// ProjectID: project ID to filter for, only pipelines from this Project will be returned.
	ProjectID *string `json:"-"`

	// HasBackendStageLB: filter on backend stage, only pipelines with a Load Balancer origin will be returned.
	HasBackendStageLB *bool `json:"-"`
}

ListPipelinesRequest: list pipelines request.

type ListPipelinesRequestOrderBy 

type ListPipelinesRequestOrderBy string

func (ListPipelinesRequestOrderBy) MarshalJSON 

func (enum ListPipelinesRequestOrderBy) MarshalJSON() ([]byte, error)

func (ListPipelinesRequestOrderBy) String 

func (enum ListPipelinesRequestOrderBy) String() string

func (*ListPipelinesRequestOrderBy) UnmarshalJSON 

func (enum *ListPipelinesRequestOrderBy) UnmarshalJSON(data []byte) error

func (ListPipelinesRequestOrderBy) Values 

func (enum ListPipelinesRequestOrderBy) Values() []ListPipelinesRequestOrderBy

type ListPipelinesResponse 

type ListPipelinesResponse struct {
	// Pipelines: paginated list of pipelines.
	Pipelines []*Pipeline `json:"pipelines"`

	// TotalCount: count of all pipelines matching the requested criteria.
	TotalCount uint64 `json:"total_count"`
}

ListPipelinesResponse: list pipelines response.

func (*ListPipelinesResponse) UnsafeAppend 

func (r *ListPipelinesResponse) UnsafeAppend(res interface{}) (uint64, error)

UnsafeAppend should not be used Internal usage only

func (*ListPipelinesResponse) UnsafeGetTotalCount 

func (r *ListPipelinesResponse) UnsafeGetTotalCount() uint64

UnsafeGetTotalCount should not be used Internal usage only

type ListPurgeRequestsRequest 

type ListPurgeRequestsRequest struct {
	// OrderBy: sort order of purge requests in the response.
	// Default value: created_at_asc
	OrderBy ListPurgeRequestsRequestOrderBy `json:"-"`

	// Page: page number to return, from the paginated results.
	Page *int32 `json:"-"`

	// PageSize: number of purge requests to return per page.
	PageSize *uint32 `json:"-"`

	// OrganizationID: organization ID to filter for, only purge requests from this Project will be returned.
	OrganizationID *string `json:"-"`

	// ProjectID: project ID to filter for, only purge requests from this Project will be returned.
	ProjectID *string `json:"-"`

	// PipelineID: pipeline ID to filter for, only purge requests from this pipeline will be returned.
	PipelineID *string `json:"-"`
}

ListPurgeRequestsRequest: list purge requests request.

type ListPurgeRequestsRequestOrderBy 

type ListPurgeRequestsRequestOrderBy string

func (ListPurgeRequestsRequestOrderBy) MarshalJSON 

func (enum ListPurgeRequestsRequestOrderBy) MarshalJSON() ([]byte, error)

func (ListPurgeRequestsRequestOrderBy) String 

func (enum ListPurgeRequestsRequestOrderBy) String() string

func (*ListPurgeRequestsRequestOrderBy) UnmarshalJSON 

func (enum *ListPurgeRequestsRequestOrderBy) UnmarshalJSON(data []byte) error

func (ListPurgeRequestsRequestOrderBy) Values 

func (enum ListPurgeRequestsRequestOrderBy) Values() []ListPurgeRequestsRequestOrderBy

type ListPurgeRequestsResponse 

type ListPurgeRequestsResponse struct {
	// PurgeRequests: paginated list of purge requests.
	PurgeRequests []*PurgeRequest `json:"purge_requests"`

	// TotalCount: count of all purge requests matching the requested criteria.
	TotalCount uint64 `json:"total_count"`
}

ListPurgeRequestsResponse: list purge requests response.

func (*ListPurgeRequestsResponse) UnsafeAppend 

func (r *ListPurgeRequestsResponse) UnsafeAppend(res interface{}) (uint64, error)

UnsafeAppend should not be used Internal usage only

func (*ListPurgeRequestsResponse) UnsafeGetTotalCount 

func (r *ListPurgeRequestsResponse) UnsafeGetTotalCount() uint64

UnsafeGetTotalCount should not be used Internal usage only

type ListTLSStagesRequest 

type ListTLSStagesRequest struct {
	// OrderBy: sort order of TLS stages in the response.
	// Default value: created_at_asc
	OrderBy ListTLSStagesRequestOrderBy `json:"-"`

	// Page: page number to return, from the paginated results.
	Page *int32 `json:"-"`

	// PageSize: number of TLS stages to return per page.
	PageSize *uint32 `json:"-"`

	// PipelineID: pipeline ID to filter for, only TLS stages from this pipeline will be returned.
	PipelineID *string `json:"-"`

	// ProjectID: project ID to filter for, only TLS stages from this Project will be returned.
	ProjectID *string `json:"-"`

	// SecretID: secret ID to filter for, only TLS stages with this Secret ID will be returned.
	SecretID *string `json:"-"`

	// SecretRegion: secret region to filter for, only TLS stages with a Secret in this region will be returned.
	SecretRegion *string `json:"-"`
}

ListTLSStagesRequest: list tls stages request.

type ListTLSStagesRequestOrderBy 

type ListTLSStagesRequestOrderBy string

func (ListTLSStagesRequestOrderBy) MarshalJSON 

func (enum ListTLSStagesRequestOrderBy) MarshalJSON() ([]byte, error)

func (ListTLSStagesRequestOrderBy) String 

func (enum ListTLSStagesRequestOrderBy) String() string

func (*ListTLSStagesRequestOrderBy) UnmarshalJSON 

func (enum *ListTLSStagesRequestOrderBy) UnmarshalJSON(data []byte) error

func (ListTLSStagesRequestOrderBy) Values 

func (enum ListTLSStagesRequestOrderBy) Values() []ListTLSStagesRequestOrderBy

type ListTLSStagesResponse 

type ListTLSStagesResponse struct {
	// Stages: paginated list of TLS stages.
	Stages []*TLSStage `json:"stages"`

	// TotalCount: count of all TLS stages matching the requested criteria.
	TotalCount uint64 `json:"total_count"`
}

ListTLSStagesResponse: list tls stages response.

func (*ListTLSStagesResponse) UnsafeAppend 

func (r *ListTLSStagesResponse) UnsafeAppend(res interface{}) (uint64, error)

UnsafeAppend should not be used Internal usage only

func (*ListTLSStagesResponse) UnsafeGetTotalCount 

func (r *ListTLSStagesResponse) UnsafeGetTotalCount() uint64

UnsafeGetTotalCount should not be used Internal usage only

type Pipeline 

type Pipeline struct {
	// ID: ID of the pipeline.
	ID string `json:"id"`

	// Name: name of the pipeline.
	Name string `json:"name"`

	// Description: description of the pipeline.
	Description string `json:"description"`

	// Status: status of the pipeline.
	// Default value: unknown_status
	Status PipelineStatus `json:"status"`

	// Errors: errors of the pipeline.
	Errors []*PipelineError `json:"errors"`

	// ProjectID: project ID of the pipeline.
	ProjectID string `json:"project_id"`

	// CreatedAt: date the pipeline was created.
	CreatedAt *time.Time `json:"created_at"`

	// UpdatedAt: date the pipeline was last updated.
	UpdatedAt *time.Time `json:"updated_at"`

	// DNSStageID: DNS stage ID the pipeline is attached to.
	// Precisely one of DNSStageID must be set.
	DNSStageID *string `json:"dns_stage_id,omitempty"`
}

Pipeline: pipeline.

type PipelineError 

type PipelineError struct {
	// Stage: default value: unknown_stage
	Stage PipelineErrorStage `json:"stage"`

	// Code: default value: unknown_code
	Code PipelineErrorCode `json:"code"`

	// Severity: default value: unknown_severity
	Severity PipelineErrorSeverity `json:"severity"`

	Message string `json:"message"`

	// Type: default value: unknown_type
	Type PipelineErrorType `json:"type"`
}

PipelineError: pipeline error.

type PipelineErrorCode 

type PipelineErrorCode string

func (PipelineErrorCode) MarshalJSON 

func (enum PipelineErrorCode) MarshalJSON() ([]byte, error)

func (PipelineErrorCode) String 

func (enum PipelineErrorCode) String() string

func (*PipelineErrorCode) UnmarshalJSON 

func (enum *PipelineErrorCode) UnmarshalJSON(data []byte) error

func (PipelineErrorCode) Values 

func (enum PipelineErrorCode) Values() []PipelineErrorCode

type PipelineErrorSeverity 

type PipelineErrorSeverity string

func (PipelineErrorSeverity) MarshalJSON 

func (enum PipelineErrorSeverity) MarshalJSON() ([]byte, error)

func (PipelineErrorSeverity) String 

func (enum PipelineErrorSeverity) String() string

func (*PipelineErrorSeverity) UnmarshalJSON 

func (enum *PipelineErrorSeverity) UnmarshalJSON(data []byte) error

func (PipelineErrorSeverity) Values 

func (enum PipelineErrorSeverity) Values() []PipelineErrorSeverity

type PipelineErrorStage 

type PipelineErrorStage string

func (PipelineErrorStage) MarshalJSON 

func (enum PipelineErrorStage) MarshalJSON() ([]byte, error)

func (PipelineErrorStage) String 

func (enum PipelineErrorStage) String() string

func (*PipelineErrorStage) UnmarshalJSON 

func (enum *PipelineErrorStage) UnmarshalJSON(data []byte) error

func (PipelineErrorStage) Values 

func (enum PipelineErrorStage) Values() []PipelineErrorStage

type PipelineErrorType 

type PipelineErrorType string

func (PipelineErrorType) MarshalJSON 

func (enum PipelineErrorType) MarshalJSON() ([]byte, error)

func (PipelineErrorType) String 

func (enum PipelineErrorType) String() string

func (*PipelineErrorType) UnmarshalJSON 

func (enum *PipelineErrorType) UnmarshalJSON(data []byte) error

func (PipelineErrorType) Values 

func (enum PipelineErrorType) Values() []PipelineErrorType

type PipelineStatus 

type PipelineStatus string

func (PipelineStatus) MarshalJSON 

func (enum PipelineStatus) MarshalJSON() ([]byte, error)

func (PipelineStatus) String 

func (enum PipelineStatus) String() string

func (*PipelineStatus) UnmarshalJSON 

func (enum *PipelineStatus) UnmarshalJSON(data []byte) error

func (PipelineStatus) Values 

func (enum PipelineStatus) Values() []PipelineStatus

type PurgeRequest 

type PurgeRequest struct {
	// ID: ID of the purge request.
	ID string `json:"id"`

	// PipelineID: pipeline ID the purge request belongs to.
	PipelineID string `json:"pipeline_id"`

	// Status: status of the purge request.
	// Default value: unknown_status
	Status PurgeRequestStatus `json:"status"`

	// Assets: list of asserts to purge.
	// Precisely one of Assets, All must be set.
	Assets *[]string `json:"assets,omitempty"`

	// All: defines whether to purge all content.
	// Precisely one of Assets, All must be set.
	All *bool `json:"all,omitempty"`

	// CreatedAt: date the purge request was created.
	CreatedAt *time.Time `json:"created_at"`

	// UpdatedAt: date the purge request was last updated.
	UpdatedAt *time.Time `json:"updated_at"`
}

PurgeRequest: purge request.

type PurgeRequestStatus 

type PurgeRequestStatus string

func (PurgeRequestStatus) MarshalJSON 

func (enum PurgeRequestStatus) MarshalJSON() ([]byte, error)

func (PurgeRequestStatus) String 

func (enum PurgeRequestStatus) String() string

func (*PurgeRequestStatus) UnmarshalJSON 

func (enum *PurgeRequestStatus) UnmarshalJSON(data []byte) error

func (PurgeRequestStatus) Values 

func (enum PurgeRequestStatus) Values() []PurgeRequestStatus

type ScalewayLB 

type ScalewayLB struct {
	// ID: ID of the Load Balancer.
	ID string `json:"id"`

	// Zone: zone of the Load Balancer.
	Zone scw.Zone `json:"zone"`

	// FrontendID: ID of the frontend linked to the Load Balancer.
	FrontendID string `json:"frontend_id"`

	// IsSsl: defines whether the Load Balancer's frontend handles SSL connections.
	IsSsl *bool `json:"is_ssl"`

	// DomainName: fully Qualified Domain Name (in the format subdomain.example.com) to use in HTTP requests sent towards your Load Balancer.
	DomainName *string `json:"domain_name"`
}

ScalewayLB: scaleway lb.

type ScalewayLBBackendConfig 

type ScalewayLBBackendConfig struct {
	// LBs: load Balancer information.
	LBs []*ScalewayLB `json:"lbs"`
}

ScalewayLBBackendConfig: scaleway lb backend config.

type ScalewayS3BackendConfig 

type ScalewayS3BackendConfig struct {
	// BucketName: name of the Bucket.
	BucketName *string `json:"bucket_name"`

	// BucketRegion: region of the Bucket.
	BucketRegion *string `json:"bucket_region"`

	// IsWebsite: defines whether the bucket website feature is enabled.
	IsWebsite *bool `json:"is_website"`
}

ScalewayS3BackendConfig: scaleway s3 backend config.

type TLSSecret 

type TLSSecret struct {
	// SecretID: ID of the Secret.
	SecretID string `json:"secret_id"`

	// Region: region of the Secret.
	Region scw.Region `json:"region"`
}

TLSSecret: tls secret.

type TLSSecretsConfig 

type TLSSecretsConfig struct {
	// TLSSecrets: secret information (from Secret Manager).
	TLSSecrets []*TLSSecret `json:"tls_secrets"`
}

TLSSecretsConfig: tls secrets config.

type TLSStage 

type TLSStage struct {
	// ID: ID of the TLS stage.
	ID string `json:"id"`

	// Secrets: secret (from Scaleway Secret Manager) containing your custom certificate.
	Secrets []*TLSSecret `json:"secrets"`

	// ManagedCertificate: true when Scaleway generates and manages a Let's Encrypt certificate for the TLS stage/custom endpoint.
	ManagedCertificate bool `json:"managed_certificate"`

	// PipelineID: pipeline ID the TLS stage belongs to.
	PipelineID *string `json:"pipeline_id"`

	// ProjectID: project ID of the TLS stage.
	ProjectID string `json:"project_id"`

	// CertificateExpiresAt: expiration date of the certificate.
	CertificateExpiresAt *time.Time `json:"certificate_expires_at"`

	// CreatedAt: date the TLS stage was created.
	CreatedAt *time.Time `json:"created_at"`

	// UpdatedAt: date the TLS stage was last updated.
	UpdatedAt *time.Time `json:"updated_at"`

	// CacheStageID: cache stage ID the TLS stage is linked to.
	// Precisely one of CacheStageID, BackendStageID must be set.
	CacheStageID *string `json:"cache_stage_id,omitempty"`

	// BackendStageID: backend stage ID the TLS stage is linked to.
	// Precisely one of CacheStageID, BackendStageID must be set.
	BackendStageID *string `json:"backend_stage_id,omitempty"`
}

TLSStage: tls stage.

type UpdateBackendStageRequest 

type UpdateBackendStageRequest struct {
	// BackendStageID: ID of the backend stage to update.
	BackendStageID string `json:"-"`

	// ScalewayS3: scaleway Object Storage origin bucket (S3) linked to the backend stage.
	// Precisely one of ScalewayS3, ScalewayLB must be set.
	ScalewayS3 *ScalewayS3BackendConfig `json:"scaleway_s3,omitempty"`

	// ScalewayLB: scaleway Load Balancer origin linked to the backend stage.
	// Precisely one of ScalewayS3, ScalewayLB must be set.
	ScalewayLB *ScalewayLBBackendConfig `json:"scaleway_lb,omitempty"`
}

UpdateBackendStageRequest: update backend stage request.

type UpdateCacheStageRequest 

type UpdateCacheStageRequest struct {
	// CacheStageID: ID of the cache stage to update.
	CacheStageID string `json:"-"`

	// FallbackTTL: time To Live (TTL) in seconds. Defines how long content is cached.
	FallbackTTL *scw.Duration `json:"fallback_ttl,omitempty"`

	// BackendStageID: backend stage ID the cache stage will be linked to.
	// Precisely one of BackendStageID must be set.
	BackendStageID *string `json:"backend_stage_id,omitempty"`
}

UpdateCacheStageRequest: update cache stage request.

type UpdateDNSStageRequest 

type UpdateDNSStageRequest struct {
	// DNSStageID: ID of the DNS stage to update.
	DNSStageID string `json:"-"`

	// Fqdns: fully Qualified Domain Name (in the format subdomain.example.com) attached to the stage.
	Fqdns *[]string `json:"fqdns,omitempty"`

	// TLSStageID: TLS stage ID the DNS stage will be linked to.
	// Precisely one of TLSStageID, CacheStageID, BackendStageID must be set.
	TLSStageID *string `json:"tls_stage_id,omitempty"`

	// CacheStageID: cache stage ID the DNS stage will be linked to.
	// Precisely one of TLSStageID, CacheStageID, BackendStageID must be set.
	CacheStageID *string `json:"cache_stage_id,omitempty"`

	// BackendStageID: backend stage ID the DNS stage will be linked to.
	// Precisely one of TLSStageID, CacheStageID, BackendStageID must be set.
	BackendStageID *string `json:"backend_stage_id,omitempty"`
}

UpdateDNSStageRequest: update dns stage request.

type UpdatePipelineRequest 

type UpdatePipelineRequest struct {
	// PipelineID: ID of the pipeline to update.
	PipelineID string `json:"-"`

	// Name: name of the pipeline.
	Name *string `json:"name,omitempty"`

	// Description: description of the pipeline.
	Description *string `json:"description,omitempty"`

	// DNSStageID: DNS stage ID the pipeline will be attached to.
	// Precisely one of DNSStageID must be set.
	DNSStageID *string `json:"dns_stage_id,omitempty"`
}

UpdatePipelineRequest: update pipeline request.

type UpdateTLSStageRequest 

type UpdateTLSStageRequest struct {
	// TLSStageID: ID of the TLS stage to update.
	TLSStageID string `json:"-"`

	// TLSSecretsConfig: secret (from Scaleway Secret-Manager) containing your custom certificate.
	TLSSecretsConfig *TLSSecretsConfig `json:"tls_secrets_config,omitempty"`

	// ManagedCertificate: true when Scaleway generates and manages a Let's Encrypt certificate for the TLS stage/custom endpoint.
	ManagedCertificate *bool `json:"managed_certificate,omitempty"`

	// CacheStageID: cache stage ID the TLS stage will be linked to.
	// Precisely one of CacheStageID, BackendStageID must be set.
	CacheStageID *string `json:"cache_stage_id,omitempty"`

	// BackendStageID: backend stage ID the TLS stage will be linked to.
	// Precisely one of CacheStageID, BackendStageID must be set.
	BackendStageID *string `json:"backend_stage_id,omitempty"`
}

UpdateTLSStageRequest: update tls stage request.

type WaitForPipelineRequest 

type WaitForPipelineRequest struct {
	PipelineID    string
	Timeout       *time.Duration
	RetryInterval *time.Duration
}

WaitForPipelineRequest is used by WaitForPipeline method.

type WaitForPurgeRequestRequest 

type WaitForPurgeRequestRequest struct {
	PurgeRequestID string
	Timeout        *time.Duration
	RetryInterval  *time.Duration
}

WaitForPurgeRequestRequest is used by WaitForPurgeRequest method.

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.