container

package
v1.0.0-beta.16 Latest Latest
Warning

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

 Go to latest Published: Apr 19, 2023 License: Apache-2.0 Imports: 14 Imported by: 3

Documentation

Overview

Package container provides methods and message types of the container v1beta1 API.

Index

Constants

View Source 
const (
	ContainerHTTPOptionUnknownHTTPOption = ContainerHTTPOption("unknown_http_option")
	ContainerHTTPOptionEnabled           = ContainerHTTPOption("enabled")
	ContainerHTTPOptionRedirected        = ContainerHTTPOption("redirected")
)
View Source 
const (
	ContainerPrivacyUnknownPrivacy = ContainerPrivacy("unknown_privacy")
	ContainerPrivacyPublic         = ContainerPrivacy("public")
	ContainerPrivacyPrivate        = ContainerPrivacy("private")
)
View Source 
const (
	ContainerProtocolUnknownProtocol = ContainerProtocol("unknown_protocol")
	ContainerProtocolHTTP1           = ContainerProtocol("http1")
	ContainerProtocolH2c             = ContainerProtocol("h2c")
)
View Source 
const (
	ContainerStatusUnknown  = ContainerStatus("unknown")
	ContainerStatusReady    = ContainerStatus("ready")
	ContainerStatusDeleting = ContainerStatus("deleting")
	ContainerStatusError    = ContainerStatus("error")
	ContainerStatusLocked   = ContainerStatus("locked")
	ContainerStatusCreating = ContainerStatus("creating")
	ContainerStatusPending  = ContainerStatus("pending")
	ContainerStatusCreated  = ContainerStatus("created")
)
View Source 
const (
	CronStatusUnknown  = CronStatus("unknown")
	CronStatusReady    = CronStatus("ready")
	CronStatusDeleting = CronStatus("deleting")
	CronStatusError    = CronStatus("error")
	CronStatusLocked   = CronStatus("locked")
	CronStatusCreating = CronStatus("creating")
	CronStatusPending  = CronStatus("pending")
)
View Source 
const (
	DomainStatusUnknown  = DomainStatus("unknown")
	DomainStatusReady    = DomainStatus("ready")
	DomainStatusDeleting = DomainStatus("deleting")
	DomainStatusError    = DomainStatus("error")
	DomainStatusCreating = DomainStatus("creating")
	DomainStatusPending  = DomainStatus("pending")
)
View Source 
const (
	ListContainersRequestOrderByCreatedAtAsc  = ListContainersRequestOrderBy("created_at_asc")
	ListContainersRequestOrderByCreatedAtDesc = ListContainersRequestOrderBy("created_at_desc")
	ListContainersRequestOrderByNameAsc       = ListContainersRequestOrderBy("name_asc")
	ListContainersRequestOrderByNameDesc      = ListContainersRequestOrderBy("name_desc")
)
View Source 
const (
	ListCronsRequestOrderByCreatedAtAsc  = ListCronsRequestOrderBy("created_at_asc")
	ListCronsRequestOrderByCreatedAtDesc = ListCronsRequestOrderBy("created_at_desc")
)
View Source 
const (
	ListDomainsRequestOrderByCreatedAtAsc  = ListDomainsRequestOrderBy("created_at_asc")
	ListDomainsRequestOrderByCreatedAtDesc = ListDomainsRequestOrderBy("created_at_desc")
	ListDomainsRequestOrderByHostnameAsc   = ListDomainsRequestOrderBy("hostname_asc")
	ListDomainsRequestOrderByHostnameDesc  = ListDomainsRequestOrderBy("hostname_desc")
)
View Source 
const (
	ListLogsRequestOrderByTimestampDesc = ListLogsRequestOrderBy("timestamp_desc")
	ListLogsRequestOrderByTimestampAsc  = ListLogsRequestOrderBy("timestamp_asc")
)
View Source 
const (
	ListNamespacesRequestOrderByCreatedAtAsc  = ListNamespacesRequestOrderBy("created_at_asc")
	ListNamespacesRequestOrderByCreatedAtDesc = ListNamespacesRequestOrderBy("created_at_desc")
	ListNamespacesRequestOrderByNameAsc       = ListNamespacesRequestOrderBy("name_asc")
	ListNamespacesRequestOrderByNameDesc      = ListNamespacesRequestOrderBy("name_desc")
)
View Source 
const (
	ListTokensRequestOrderByCreatedAtAsc  = ListTokensRequestOrderBy("created_at_asc")
	ListTokensRequestOrderByCreatedAtDesc = ListTokensRequestOrderBy("created_at_desc")
)
View Source 
const (
	LogStreamUnknown = LogStream("unknown")
	LogStreamStdout  = LogStream("stdout")
	LogStreamStderr  = LogStream("stderr")
)
View Source 
const (
	NamespaceStatusUnknown  = NamespaceStatus("unknown")
	NamespaceStatusReady    = NamespaceStatus("ready")
	NamespaceStatusDeleting = NamespaceStatus("deleting")
	NamespaceStatusError    = NamespaceStatus("error")
	NamespaceStatusLocked   = NamespaceStatus("locked")
	NamespaceStatusCreating = NamespaceStatus("creating")
	NamespaceStatusPending  = NamespaceStatus("pending")
)
View Source 
const (
	TokenStatusUnknown  = TokenStatus("unknown")
	TokenStatusReady    = TokenStatus("ready")
	TokenStatusDeleting = TokenStatus("deleting")
	TokenStatusError    = TokenStatus("error")
	TokenStatusCreating = TokenStatus("creating")
)
View Source 
const (
	NullValueNULLVALUE = NullValue("NULL_VALUE")
)

Variables

This section is empty.

Functions

This section is empty.

Types

type API 

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

API: serverless Containers API. Containers API.

func NewAPI 

func NewAPI(client *scw.Client) *API

NewAPI returns a API object from a Scaleway client.

func (*API) CreateContainer 

func (s *API) CreateContainer(req *CreateContainerRequest, opts ...scw.RequestOption) (*Container, error)

CreateContainer: create a new container. Create a new container in the specified region.

func (*API) CreateCron 

func (s *API) CreateCron(req *CreateCronRequest, opts ...scw.RequestOption) (*Cron, error)

CreateCron: create a new cron.

func (*API) CreateDomain 

func (s *API) CreateDomain(req *CreateDomainRequest, opts ...scw.RequestOption) (*Domain, error)

CreateDomain: create a domain name binding. Create a domain name binding for the container with the specified ID.

func (*API) CreateNamespace 

func (s *API) CreateNamespace(req *CreateNamespaceRequest, opts ...scw.RequestOption) (*Namespace, error)

CreateNamespace: create a new namespace. Create a new namespace in a specified region.

func (*API) CreateToken 

func (s *API) CreateToken(req *CreateTokenRequest, opts ...scw.RequestOption) (*Token, error)

CreateToken: create a new revocable token.

func (*API) DeleteContainer 

func (s *API) DeleteContainer(req *DeleteContainerRequest, opts ...scw.RequestOption) (*Container, error)

DeleteContainer: delete a container. Delete the container associated with the specified ID.

func (*API) DeleteCron 

func (s *API) DeleteCron(req *DeleteCronRequest, opts ...scw.RequestOption) (*Cron, error)

DeleteCron: delete an existing cron. Delete the cron associated with the specified ID.

func (*API) DeleteDomain 

func (s *API) DeleteDomain(req *DeleteDomainRequest, opts ...scw.RequestOption) (*Domain, error)

DeleteDomain: delete a domain name binding. Delete the domain name binding with the specific ID.

func (*API) DeleteNamespace 

func (s *API) DeleteNamespace(req *DeleteNamespaceRequest, opts ...scw.RequestOption) (*Namespace, error)

DeleteNamespace: delete an existing namespace. Delete the namespace associated with the specified ID.

func (*API) DeleteToken 

func (s *API) DeleteToken(req *DeleteTokenRequest, opts ...scw.RequestOption) (*Token, error)

DeleteToken: delete a token. Delete a token with a specified ID.

func (*API) DeployContainer 

func (s *API) DeployContainer(req *DeployContainerRequest, opts ...scw.RequestOption) (*Container, error)

DeployContainer: deploy a container. Deploy a container associated with the specified ID.

func (*API) GetContainer 

func (s *API) GetContainer(req *GetContainerRequest, opts ...scw.RequestOption) (*Container, error)

GetContainer: get a container. Get the container associated with the specified ID.

func (*API) GetCron 

func (s *API) GetCron(req *GetCronRequest, opts ...scw.RequestOption) (*Cron, error)

GetCron: get a cron. Get the cron associated with the specified ID.

func (*API) GetDomain 

func (s *API) GetDomain(req *GetDomainRequest, opts ...scw.RequestOption) (*Domain, error)

GetDomain: get a domain name binding. Get a domain name binding for the container with the specified ID.

func (*API) GetNamespace 

func (s *API) GetNamespace(req *GetNamespaceRequest, opts ...scw.RequestOption) (*Namespace, error)

GetNamespace: get a namespace. Get the namespace associated with the specified ID.

func (*API) GetToken 

func (s *API) GetToken(req *GetTokenRequest, opts ...scw.RequestOption) (*Token, error)

GetToken: get a token. Get a token with a specified ID.

func (*API) IssueJWT 

func (s *API) IssueJWT(req *IssueJWTRequest, opts ...scw.RequestOption) (*Token, error)

Deprecated

func (*API) ListContainers 

func (s *API) ListContainers(req *ListContainersRequest, opts ...scw.RequestOption) (*ListContainersResponse, error)

ListContainers: list all your containers. List all containers for a specified region.

func (*API) ListCrons 

func (s *API) ListCrons(req *ListCronsRequest, opts ...scw.RequestOption) (*ListCronsResponse, error)

ListCrons: list all your crons.

func (*API) ListDomains 

func (s *API) ListDomains(req *ListDomainsRequest, opts ...scw.RequestOption) (*ListDomainsResponse, error)

ListDomains: list all domain name bindings. List all domain name bindings in a specified region.

func (*API) ListLogs 

func (s *API) ListLogs(req *ListLogsRequest, opts ...scw.RequestOption) (*ListLogsResponse, error)

ListLogs: list your container logs. List the logs of the container with the specified ID.

func (*API) ListNamespaces 

func (s *API) ListNamespaces(req *ListNamespacesRequest, opts ...scw.RequestOption) (*ListNamespacesResponse, error)

ListNamespaces: list all your namespaces. List all namespaces in a specified region.

func (*API) ListTokens 

func (s *API) ListTokens(req *ListTokensRequest, opts ...scw.RequestOption) (*ListTokensResponse, error)

ListTokens: list all tokens. List all tokens belonging to a specified Organization or Project.

func (*API) Regions 

func (s *API) Regions() []scw.Region

Regions list localities the api is available in

func (*API) UpdateContainer 

func (s *API) UpdateContainer(req *UpdateContainerRequest, opts ...scw.RequestOption) (*Container, error)

UpdateContainer: update an existing container. Update the container associated with the specified ID.

func (*API) UpdateCron 

func (s *API) UpdateCron(req *UpdateCronRequest, opts ...scw.RequestOption) (*Cron, error)

UpdateCron: update an existing cron. Update the cron associated with the specified ID.

func (*API) UpdateNamespace 

func (s *API) UpdateNamespace(req *UpdateNamespaceRequest, opts ...scw.RequestOption) (*Namespace, error)

UpdateNamespace: update an existing namespace. Update the space associated with the specified ID.

func (*API) WaitForContainer 

func (s *API) WaitForContainer(req *WaitForContainerRequest, opts ...scw.RequestOption) (*Container, error)

WaitForContainer waits for the Container to be in a ready state before returning.

func (*API) WaitForCron 

func (s *API) WaitForCron(req *WaitForCronRequest, opts ...scw.RequestOption) (*Cron, error)

WaitForCron waits for the Cron to be in a ready state before returning.

func (*API) WaitForDomain 

func (s *API) WaitForDomain(req *WaitForDomainRequest, opts ...scw.RequestOption) (*Domain, error)

WaitForDomain waits for the Domain to be in a ready state before returning.

func (*API) WaitForNamespace 

func (s *API) WaitForNamespace(req *WaitForNamespaceRequest, opts ...scw.RequestOption) (*Namespace, error)

WaitForNamespace waits for the Namespace to be in a ready state before returning.

type Container 

type Container struct {
	// ID: UUID of the container.
	ID string `json:"id"`
	// Name: name of the container.
	Name string `json:"name"`
	// NamespaceID: UUID of the namespace the container belongs to.
	NamespaceID string `json:"namespace_id"`
	// Status: status of the container.
	// Default value: unknown
	Status ContainerStatus `json:"status"`
	// EnvironmentVariables: environment variables of the container.
	EnvironmentVariables map[string]string `json:"environment_variables"`
	// MinScale: minimum number of instances to scale the container to.
	MinScale uint32 `json:"min_scale"`
	// MaxScale: maximum number of instances to scale the container to.
	MaxScale uint32 `json:"max_scale"`
	// MemoryLimit: memory limit of the container in MB.
	MemoryLimit uint32 `json:"memory_limit"`
	// CPULimit: CPU limit of the container in mvCPU.
	CPULimit uint32 `json:"cpu_limit"`
	// Timeout: processing time limit for the container.
	Timeout *scw.Duration `json:"timeout"`
	// ErrorMessage: last error message of the container.
	ErrorMessage *string `json:"error_message"`
	// Privacy: privacy setting of the container.
	// Default value: unknown_privacy
	Privacy ContainerPrivacy `json:"privacy"`
	// Description: description of the container.
	Description *string `json:"description"`
	// RegistryImage: name of the registry image (e.g. "rg.fr-par.scw.cloud/something/image:tag").
	RegistryImage string `json:"registry_image"`
	// MaxConcurrency: number of maximum concurrent executions of the container.
	MaxConcurrency uint32 `json:"max_concurrency"`
	// DomainName: domain name attributed to the contaioner.
	DomainName string `json:"domain_name"`
	// Protocol: protocol the container uses.
	// Default value: unknown_protocol
	Protocol ContainerProtocol `json:"protocol"`
	// Port: port the container listens on.
	Port uint32 `json:"port"`
	// SecretEnvironmentVariables: secret environment variables of the container.
	SecretEnvironmentVariables []*SecretHashedValue `json:"secret_environment_variables"`
	// HTTPOption: configuration for the handling of HTTP and HTTPS requests.
	// Possible values:
	//  - redirected: Responds to HTTP request with a 301 redirect to ask the clients to use HTTPS.
	//  - enabled: Serve both HTTP and HTTPS traffic.
	// Default value: enabled
	HTTPOption ContainerHTTPOption `json:"http_option"`
	// Region: region in which the container will be deployed.
	Region scw.Region `json:"region"`
}

Container: container.

type ContainerHTTPOption 

type ContainerHTTPOption string

func (ContainerHTTPOption) MarshalJSON 

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

func (ContainerHTTPOption) String 

func (enum ContainerHTTPOption) String() string

func (*ContainerHTTPOption) UnmarshalJSON 

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

type ContainerPrivacy 

type ContainerPrivacy string

func (ContainerPrivacy) MarshalJSON 

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

func (ContainerPrivacy) String 

func (enum ContainerPrivacy) String() string

func (*ContainerPrivacy) UnmarshalJSON 

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

type ContainerProtocol 

type ContainerProtocol string

func (ContainerProtocol) MarshalJSON 

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

func (ContainerProtocol) String 

func (enum ContainerProtocol) String() string

func (*ContainerProtocol) UnmarshalJSON 

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

type ContainerStatus 

type ContainerStatus string

func (ContainerStatus) MarshalJSON 

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

func (ContainerStatus) String 

func (enum ContainerStatus) String() string

func (*ContainerStatus) UnmarshalJSON 

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

type CreateContainerRequest 

type CreateContainerRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// NamespaceID: UUID of the namespace the container belongs to.
	NamespaceID string `json:"namespace_id"`
	// Name: name of the container.
	Name string `json:"name"`
	// EnvironmentVariables: environment variables of the container.
	EnvironmentVariables *map[string]string `json:"environment_variables"`
	// MinScale: minimum number of instances to scale the container to.
	MinScale *uint32 `json:"min_scale"`
	// MaxScale: maximum number of instances to scale the container to.
	MaxScale *uint32 `json:"max_scale"`
	// MemoryLimit: memory limit of the container in MB.
	MemoryLimit *uint32 `json:"memory_limit"`
	// CPULimit: CPU limit of the container in mvCPU.
	CPULimit *uint32 `json:"cpu_limit"`
	// Timeout: processing time limit for the container.
	Timeout *scw.Duration `json:"timeout"`
	// Privacy: privacy setting of the container.
	// Default value: unknown_privacy
	Privacy ContainerPrivacy `json:"privacy"`
	// Description: description of the container.
	Description *string `json:"description"`
	// RegistryImage: name of the registry image (e.g. "rg.fr-par.scw.cloud/something/image:tag").
	RegistryImage *string `json:"registry_image"`
	// MaxConcurrency: number of maximum concurrent executions of the container.
	MaxConcurrency *uint32 `json:"max_concurrency"`
	// Protocol: protocol the container uses.
	// Default value: unknown_protocol
	Protocol ContainerProtocol `json:"protocol"`
	// Port: port the container listens on.
	Port *uint32 `json:"port"`
	// SecretEnvironmentVariables: secret environment variables of the container.
	SecretEnvironmentVariables []*Secret `json:"secret_environment_variables"`
	// HTTPOption: configure how HTTP and HTTPS requests are handled.
	// Possible values:
	//  - redirected: Responds to HTTP request with a 301 redirect to ask the clients to use HTTPS.
	//  - enabled: Serve both HTTP and HTTPS traffic.
	// Default value: enabled
	HTTPOption ContainerHTTPOption `json:"http_option"`
}

type CreateCronRequest 

type CreateCronRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// ContainerID: UUID of the container to invoke by the cron.
	ContainerID string `json:"container_id"`
	// Schedule: uNIX cron shedule.
	Schedule string `json:"schedule"`
	// Args: arguments to pass with the cron.
	Args *scw.JSONObject `json:"args"`
	// Name: name of the cron to create.
	Name *string `json:"name"`
}

type CreateDomainRequest 

type CreateDomainRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// Hostname: domain to assign.
	Hostname string `json:"hostname"`
	// ContainerID: UUID of the container to assign the domain to.
	ContainerID string `json:"container_id"`
}

type CreateNamespaceRequest 

type CreateNamespaceRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// Name: name of the namespace to create.
	Name string `json:"name"`
	// EnvironmentVariables: environment variables of the namespace to create.
	EnvironmentVariables *map[string]string `json:"environment_variables"`
	// ProjectID: UUID of the Project in which the namespace will be created.
	ProjectID string `json:"project_id"`
	// Description: description of the namespace to create.
	Description *string `json:"description"`
	// SecretEnvironmentVariables: secret environment variables of the namespace to create.
	SecretEnvironmentVariables []*Secret `json:"secret_environment_variables"`
}

type CreateTokenRequest 

type CreateTokenRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// ContainerID: UUID of the container to create the token for.
	// Precisely one of ContainerID, NamespaceID must be set.
	ContainerID *string `json:"container_id,omitempty"`
	// NamespaceID: UUID of the namespace to create the token for.
	// Precisely one of ContainerID, NamespaceID must be set.
	NamespaceID *string `json:"namespace_id,omitempty"`
	// Description: description of the token.
	Description *string `json:"description"`
	// ExpiresAt: expiry date of the token.
	ExpiresAt *time.Time `json:"expires_at"`
}

type Cron 

type Cron struct {
	// ID: UUID of the cron.
	ID string `json:"id"`
	// ContainerID: UUID of the container invoked by this cron.
	ContainerID string `json:"container_id"`
	// Schedule: uNIX cron shedule.
	Schedule string `json:"schedule"`
	// Args: arguments to pass with the cron.
	Args *scw.JSONObject `json:"args"`
	// Status: status of the cron.
	// Default value: unknown
	Status CronStatus `json:"status"`
	// Name: name of the cron.
	Name string `json:"name"`
}

Cron: cron.

type CronStatus 

type CronStatus string

func (CronStatus) MarshalJSON 

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

func (CronStatus) String 

func (enum CronStatus) String() string

func (*CronStatus) UnmarshalJSON 

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

type DeleteContainerRequest 

type DeleteContainerRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// ContainerID: UUID of the container to delete.
	ContainerID string `json:"-"`
}

type DeleteCronRequest 

type DeleteCronRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// CronID: UUID of the cron to delete.
	CronID string `json:"-"`
}

type DeleteDomainRequest 

type DeleteDomainRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// DomainID: UUID of the domain to delete.
	DomainID string `json:"-"`
}

type DeleteNamespaceRequest 

type DeleteNamespaceRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// NamespaceID: UUID of the namespace to delete.
	NamespaceID string `json:"-"`
}

type DeleteTokenRequest 

type DeleteTokenRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// TokenID: UUID of the token to delete.
	TokenID string `json:"-"`
}

type DeployContainerRequest 

type DeployContainerRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// ContainerID: UUID of the container to deploy.
	ContainerID string `json:"-"`
}

type Domain 

type Domain struct {
	// ID: UUID of the domain.
	ID string `json:"id"`
	// Hostname: domain assigned to the container.
	Hostname string `json:"hostname"`
	// ContainerID: UUID of the container.
	ContainerID string `json:"container_id"`
	// URL: URL (TBD).
	URL string `json:"url"`
	// Status: status of the domain.
	// Default value: unknown
	Status DomainStatus `json:"status"`
	// ErrorMessage: last error message of the domain.
	ErrorMessage *string `json:"error_message"`
}

Domain: domain.

type DomainStatus 

type DomainStatus string

func (DomainStatus) MarshalJSON 

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

func (DomainStatus) String 

func (enum DomainStatus) String() string

func (*DomainStatus) UnmarshalJSON 

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

type GetContainerRequest 

type GetContainerRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// ContainerID: UUID of the container to get.
	ContainerID string `json:"-"`
}

type GetCronRequest 

type GetCronRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// CronID: UUID of the cron to get.
	CronID string `json:"-"`
}

type GetDomainRequest 

type GetDomainRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// DomainID: UUID of the domain to get.
	DomainID string `json:"-"`
}

type GetNamespaceRequest 

type GetNamespaceRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// NamespaceID: UUID of the namespace to get.
	NamespaceID string `json:"-"`
}

type GetTokenRequest 

type GetTokenRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// TokenID: UUID of the token to get.
	TokenID string `json:"-"`
}

type IssueJWTRequest 

type IssueJWTRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`

	ContainerID *string `json:"-"`

	NamespaceID *string `json:"-"`

	ExpiresAt *time.Time `json:"-"`
}

type ListContainersRequest 

type ListContainersRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// Page: page number.
	Page *int32 `json:"-"`
	// PageSize: number of containers per page.
	PageSize *uint32 `json:"-"`
	// OrderBy: order of the containers.
	// Default value: created_at_asc
	OrderBy ListContainersRequestOrderBy `json:"-"`
	// NamespaceID: UUID of the namespace the container belongs to.
	NamespaceID string `json:"-"`
	// Name: name of the container.
	Name *string `json:"-"`
	// OrganizationID: UUID of the Organization the container belongs to.
	OrganizationID *string `json:"-"`
	// ProjectID: UUID of the Project the container belongs to.
	ProjectID *string `json:"-"`
}

type ListContainersRequestOrderBy 

type ListContainersRequestOrderBy string

func (ListContainersRequestOrderBy) MarshalJSON 

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

func (ListContainersRequestOrderBy) String 

func (enum ListContainersRequestOrderBy) String() string

func (*ListContainersRequestOrderBy) UnmarshalJSON 

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

type ListContainersResponse 

type ListContainersResponse struct {
	// Containers: array of containers.
	Containers []*Container `json:"containers"`
	// TotalCount: total number of containers.
	TotalCount uint32 `json:"total_count"`
}

ListContainersResponse: list containers response.

func (*ListContainersResponse) UnsafeAppend 

func (r *ListContainersResponse) UnsafeAppend(res interface{}) (uint32, error)

UnsafeAppend should not be used Internal usage only

func (*ListContainersResponse) UnsafeGetTotalCount 

func (r *ListContainersResponse) UnsafeGetTotalCount() uint32

UnsafeGetTotalCount should not be used Internal usage only

type ListCronsRequest 

type ListCronsRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// Page: page number.
	Page *int32 `json:"-"`
	// PageSize: number of crons per page.
	PageSize *uint32 `json:"-"`
	// OrderBy: order of the crons.
	// Default value: created_at_asc
	OrderBy ListCronsRequestOrderBy `json:"-"`
	// ContainerID: UUID of the container invoked by the cron.
	ContainerID string `json:"-"`
}

type ListCronsRequestOrderBy 

type ListCronsRequestOrderBy string

func (ListCronsRequestOrderBy) MarshalJSON 

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

func (ListCronsRequestOrderBy) String 

func (enum ListCronsRequestOrderBy) String() string

func (*ListCronsRequestOrderBy) UnmarshalJSON 

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

type ListCronsResponse 

type ListCronsResponse struct {
	// Crons: array of crons.
	Crons []*Cron `json:"crons"`
	// TotalCount: total number of crons.
	TotalCount uint32 `json:"total_count"`
}

ListCronsResponse: list crons response.

func (*ListCronsResponse) UnsafeAppend 

func (r *ListCronsResponse) UnsafeAppend(res interface{}) (uint32, error)

UnsafeAppend should not be used Internal usage only

func (*ListCronsResponse) UnsafeGetTotalCount 

func (r *ListCronsResponse) UnsafeGetTotalCount() uint32

UnsafeGetTotalCount should not be used Internal usage only

type ListDomainsRequest 

type ListDomainsRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// Page: page number.
	Page *int32 `json:"-"`
	// PageSize: number of domains per page.
	PageSize *uint32 `json:"-"`
	// OrderBy: order of the domains.
	// Default value: created_at_asc
	OrderBy ListDomainsRequestOrderBy `json:"-"`
	// ContainerID: UUID of the container the domain belongs to.
	ContainerID string `json:"-"`
}

type ListDomainsRequestOrderBy 

type ListDomainsRequestOrderBy string

func (ListDomainsRequestOrderBy) MarshalJSON 

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

func (ListDomainsRequestOrderBy) String 

func (enum ListDomainsRequestOrderBy) String() string

func (*ListDomainsRequestOrderBy) UnmarshalJSON 

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

type ListDomainsResponse 

type ListDomainsResponse struct {
	// Domains: array of domains.
	Domains []*Domain `json:"domains"`
	// TotalCount: total number of domains.
	TotalCount uint32 `json:"total_count"`
}

ListDomainsResponse: list domains response.

func (*ListDomainsResponse) UnsafeAppend 

func (r *ListDomainsResponse) UnsafeAppend(res interface{}) (uint32, error)

UnsafeAppend should not be used Internal usage only

func (*ListDomainsResponse) UnsafeGetTotalCount 

func (r *ListDomainsResponse) UnsafeGetTotalCount() uint32

UnsafeGetTotalCount should not be used Internal usage only

type ListLogsRequest 

type ListLogsRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// ContainerID: UUID of the container.
	ContainerID string `json:"-"`
	// Page: page number.
	Page *int32 `json:"-"`
	// PageSize: number of logs per page.
	PageSize *uint32 `json:"-"`
	// OrderBy: order of the logs.
	// Default value: timestamp_desc
	OrderBy ListLogsRequestOrderBy `json:"-"`
}

type ListLogsRequestOrderBy 

type ListLogsRequestOrderBy string

func (ListLogsRequestOrderBy) MarshalJSON 

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

func (ListLogsRequestOrderBy) String 

func (enum ListLogsRequestOrderBy) String() string

func (*ListLogsRequestOrderBy) UnmarshalJSON 

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

type ListLogsResponse 

type ListLogsResponse struct {
	Logs []*Log `json:"logs"`

	TotalCount uint32 `json:"total_count"`
}

ListLogsResponse: list logs response.

func (*ListLogsResponse) UnsafeAppend 

func (r *ListLogsResponse) UnsafeAppend(res interface{}) (uint32, error)

UnsafeAppend should not be used Internal usage only

func (*ListLogsResponse) UnsafeGetTotalCount 

func (r *ListLogsResponse) UnsafeGetTotalCount() uint32

UnsafeGetTotalCount should not be used Internal usage only

type ListNamespacesRequest 

type ListNamespacesRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// Page: page number.
	Page *int32 `json:"-"`
	// PageSize: number of namespaces per page.
	PageSize *uint32 `json:"-"`
	// OrderBy: order of the namespaces.
	// Default value: created_at_asc
	OrderBy ListNamespacesRequestOrderBy `json:"-"`
	// Name: name of the namespaces.
	Name *string `json:"-"`
	// OrganizationID: UUID of the Organization the namespace belongs to.
	OrganizationID *string `json:"-"`
	// ProjectID: UUID of the Project the namespace belongs to.
	ProjectID *string `json:"-"`
}

type ListNamespacesRequestOrderBy 

type ListNamespacesRequestOrderBy string

func (ListNamespacesRequestOrderBy) MarshalJSON 

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

func (ListNamespacesRequestOrderBy) String 

func (enum ListNamespacesRequestOrderBy) String() string

func (*ListNamespacesRequestOrderBy) UnmarshalJSON 

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

type ListNamespacesResponse 

type ListNamespacesResponse struct {
	// Namespaces: array of the namespaces.
	Namespaces []*Namespace `json:"namespaces"`
	// TotalCount: total number of namespaces.
	TotalCount uint32 `json:"total_count"`
}

ListNamespacesResponse: list namespaces response.

func (*ListNamespacesResponse) UnsafeAppend 

func (r *ListNamespacesResponse) UnsafeAppend(res interface{}) (uint32, error)

UnsafeAppend should not be used Internal usage only

func (*ListNamespacesResponse) UnsafeGetTotalCount 

func (r *ListNamespacesResponse) UnsafeGetTotalCount() uint32

UnsafeGetTotalCount should not be used Internal usage only

type ListTokensRequest 

type ListTokensRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// Page: page number.
	Page *int32 `json:"-"`
	// PageSize: number of tokens per page.
	PageSize *uint32 `json:"-"`
	// OrderBy: order of the tokens.
	// Default value: created_at_asc
	OrderBy ListTokensRequestOrderBy `json:"-"`
	// ContainerID: UUID of the container the token belongs to.
	ContainerID *string `json:"-"`
	// NamespaceID: UUID of the namespace the token belongs to.
	NamespaceID *string `json:"-"`
}

type ListTokensRequestOrderBy 

type ListTokensRequestOrderBy string

func (ListTokensRequestOrderBy) MarshalJSON 

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

func (ListTokensRequestOrderBy) String 

func (enum ListTokensRequestOrderBy) String() string

func (*ListTokensRequestOrderBy) UnmarshalJSON 

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

type ListTokensResponse 

type ListTokensResponse struct {
	Tokens []*Token `json:"tokens"`

	TotalCount uint32 `json:"total_count"`
}

func (*ListTokensResponse) UnsafeAppend 

func (r *ListTokensResponse) UnsafeAppend(res interface{}) (uint32, error)

UnsafeAppend should not be used Internal usage only

func (*ListTokensResponse) UnsafeGetTotalCount 

func (r *ListTokensResponse) UnsafeGetTotalCount() uint32

UnsafeGetTotalCount should not be used Internal usage only

type Log 

type Log struct {
	Message string `json:"message"`

	Timestamp *time.Time `json:"timestamp"`

	ID string `json:"id"`
	// Level: contains the severity of the log (info, debug, error, ...).
	Level string `json:"level"`
	// Source: source of the log (core runtime or user code).
	Source string `json:"source"`
	// Stream: can be stdout or stderr.
	// Default value: unknown
	Stream LogStream `json:"stream"`
}

Log: log.

type LogStream 

type LogStream string

func (LogStream) MarshalJSON 

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

func (LogStream) String 

func (enum LogStream) String() string

func (*LogStream) UnmarshalJSON 

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

type Namespace 

type Namespace struct {
	// ID: UUID of the namespace.
	ID string `json:"id"`
	// Name: name of the namespace.
	Name string `json:"name"`
	// EnvironmentVariables: environment variables of the namespace.
	EnvironmentVariables map[string]string `json:"environment_variables"`
	// OrganizationID: UUID of the Organization the namespace belongs to.
	OrganizationID string `json:"organization_id"`
	// ProjectID: UUID of the Project the namespace belongs to.
	ProjectID string `json:"project_id"`
	// Status: status of the namespace.
	// Default value: unknown
	Status NamespaceStatus `json:"status"`
	// RegistryNamespaceID: UUID of the registry namespace.
	RegistryNamespaceID string `json:"registry_namespace_id"`
	// ErrorMessage: last error message of the namesace.
	ErrorMessage *string `json:"error_message"`
	// RegistryEndpoint: registry endpoint of the namespace.
	RegistryEndpoint string `json:"registry_endpoint"`
	// Description: description of the endpoint.
	Description *string `json:"description"`
	// SecretEnvironmentVariables: secret environment variables of the namespace.
	SecretEnvironmentVariables []*SecretHashedValue `json:"secret_environment_variables"`
	// Region: region in which the namespace will be created.
	Region scw.Region `json:"region"`
}

Namespace: namespace.

type NamespaceStatus 

type NamespaceStatus string

func (NamespaceStatus) MarshalJSON 

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

func (NamespaceStatus) String 

func (enum NamespaceStatus) String() string

func (*NamespaceStatus) UnmarshalJSON 

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

type NullValue 

type NullValue string

func (NullValue) MarshalJSON 

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

func (NullValue) String 

func (enum NullValue) String() string

func (*NullValue) UnmarshalJSON 

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

type Secret 

type Secret struct {
	Key string `json:"key"`

	Value *string `json:"value"`
}

type SecretHashedValue 

type SecretHashedValue struct {
	Key string `json:"key"`

	HashedValue string `json:"hashed_value"`
}

type Token 

type Token struct {
	// ID: UUID of the token.
	ID string `json:"id"`
	// Token: identifier of the token.
	Token string `json:"token"`
	// ContainerID: UUID of the container the token belongs to.
	// Precisely one of ContainerID, NamespaceID must be set.
	ContainerID *string `json:"container_id,omitempty"`
	// NamespaceID: UUID of the namespace the token belongs to.
	// Precisely one of ContainerID, NamespaceID must be set.
	NamespaceID *string `json:"namespace_id,omitempty"`
	// Deprecated: PublicKey: public key of the token.
	PublicKey *string `json:"public_key,omitempty"`
	// Status: status of the token.
	// Default value: unknown
	Status TokenStatus `json:"status"`
	// Description: description of the token.
	Description *string `json:"description"`
	// ExpiresAt: expiry date of the token.
	ExpiresAt *time.Time `json:"expires_at"`
}

Token: token.

type TokenStatus 

type TokenStatus string

func (TokenStatus) MarshalJSON 

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

func (TokenStatus) String 

func (enum TokenStatus) String() string

func (*TokenStatus) UnmarshalJSON 

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

type UpdateContainerRequest 

type UpdateContainerRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// ContainerID: UUID of the container to update.
	ContainerID string `json:"-"`
	// EnvironmentVariables: environment variables of the container.
	EnvironmentVariables *map[string]string `json:"environment_variables"`
	// MinScale: minimum number of instances to scale the container to.
	MinScale *uint32 `json:"min_scale"`
	// MaxScale: maximum number of instances to scale the container to.
	MaxScale *uint32 `json:"max_scale"`
	// MemoryLimit: memory limit of the container in MB.
	MemoryLimit *uint32 `json:"memory_limit"`
	// CPULimit: CPU limit of the container in mvCPU.
	CPULimit *uint32 `json:"cpu_limit"`
	// Timeout: processing time limit for the container.
	Timeout *scw.Duration `json:"timeout"`
	// Redeploy: defines whether to redeploy failed containers.
	Redeploy *bool `json:"redeploy"`
	// Privacy: privacy settings of the container.
	// Default value: unknown_privacy
	Privacy ContainerPrivacy `json:"privacy"`
	// Description: description of the container.
	Description *string `json:"description"`
	// RegistryImage: name of the registry image (e.g. "rg.fr-par.scw.cloud/something/image:tag").
	RegistryImage *string `json:"registry_image"`
	// MaxConcurrency: number of maximum concurrent executions of the container.
	MaxConcurrency *uint32 `json:"max_concurrency"`
	// Protocol: default value: unknown_protocol
	Protocol ContainerProtocol `json:"protocol"`

	Port *uint32 `json:"port"`

	SecretEnvironmentVariables []*Secret `json:"secret_environment_variables"`
	// HTTPOption: configure how HTTP and HTTPS requests are handled.
	// Possible values:
	//  - redirected: Responds to HTTP request with a 301 redirect to ask the clients to use HTTPS.
	//  - enabled: Serve both HTTP and HTTPS traffic.
	// Default value: enabled
	HTTPOption ContainerHTTPOption `json:"http_option"`
}

type UpdateCronRequest 

type UpdateCronRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// CronID: UUID of the cron to update.
	CronID string `json:"-"`
	// ContainerID: UUID of the container invoked by the cron.
	ContainerID *string `json:"container_id"`
	// Schedule: uNIX cron schedule.
	Schedule *string `json:"schedule"`
	// Args: arguments to pass with the cron.
	Args *scw.JSONObject `json:"args"`
	// Name: name of the cron.
	Name *string `json:"name"`
}

type UpdateNamespaceRequest 

type UpdateNamespaceRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// NamespaceID: UUID of the namespace to update.
	NamespaceID string `json:"-"`
	// EnvironmentVariables: environment variables of the namespace to update.
	EnvironmentVariables *map[string]string `json:"environment_variables"`
	// Description: description of the namespace to update.
	Description *string `json:"description"`
	// SecretEnvironmentVariables: secret environment variables of the namespace to update.
	SecretEnvironmentVariables []*Secret `json:"secret_environment_variables"`
}

type WaitForContainerRequest 

type WaitForContainerRequest struct {
	ContainerID   string
	Region        scw.Region
	Timeout       *time.Duration
	RetryInterval *time.Duration
}

WaitForContainerRequest is used by WaitForNamespace method.

type WaitForCronRequest 

type WaitForCronRequest struct {
	CronID        string
	Region        scw.Region
	Timeout       *time.Duration
	RetryInterval *time.Duration
}

WaitForCronRequest is used by WaitForNamespace method.

type WaitForDomainRequest 

type WaitForDomainRequest struct {
	DomainID      string
	Region        scw.Region
	Timeout       *time.Duration
	RetryInterval *time.Duration
}

WaitForDomainRequest waits for the Domain to be in a ready state before returning.

type WaitForNamespaceRequest 

type WaitForNamespaceRequest struct {
	NamespaceID   string
	Region        scw.Region
	Timeout       *time.Duration
	RetryInterval *time.Duration
}

WaitForNamespaceRequest is used by WaitForNamespace 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.