Documentation
¶
Overview ¶
Package function provides methods and message types of the function v1beta1 API.
Index ¶
- Constants
- type API
- func (s *API) CreateCron(req *CreateCronRequest, opts ...scw.RequestOption) (*Cron, error)
- func (s *API) CreateDomain(req *CreateDomainRequest, opts ...scw.RequestOption) (*Domain, error)
- func (s *API) CreateFunction(req *CreateFunctionRequest, opts ...scw.RequestOption) (*Function, error)
- func (s *API) CreateNamespace(req *CreateNamespaceRequest, opts ...scw.RequestOption) (*Namespace, error)
- func (s *API) CreateToken(req *CreateTokenRequest, opts ...scw.RequestOption) (*Token, error)
- func (s *API) CreateTrigger(req *CreateTriggerRequest, opts ...scw.RequestOption) (*Trigger, error)
- func (s *API) DeleteCron(req *DeleteCronRequest, opts ...scw.RequestOption) (*Cron, error)
- func (s *API) DeleteDomain(req *DeleteDomainRequest, opts ...scw.RequestOption) (*Domain, error)
- func (s *API) DeleteFunction(req *DeleteFunctionRequest, opts ...scw.RequestOption) (*Function, error)
- func (s *API) DeleteNamespace(req *DeleteNamespaceRequest, opts ...scw.RequestOption) (*Namespace, error)
- func (s *API) DeleteToken(req *DeleteTokenRequest, opts ...scw.RequestOption) (*Token, error)
- func (s *API) DeleteTrigger(req *DeleteTriggerRequest, opts ...scw.RequestOption) (*Trigger, error)
- func (s *API) DeployFunction(req *DeployFunctionRequest, opts ...scw.RequestOption) (*Function, error)
- func (s *API) GetCron(req *GetCronRequest, opts ...scw.RequestOption) (*Cron, error)
- func (s *API) GetDomain(req *GetDomainRequest, opts ...scw.RequestOption) (*Domain, error)
- func (s *API) GetFunction(req *GetFunctionRequest, opts ...scw.RequestOption) (*Function, error)
- func (s *API) GetFunctionDownloadURL(req *GetFunctionDownloadURLRequest, opts ...scw.RequestOption) (*DownloadURL, error)
- func (s *API) GetFunctionUploadURL(req *GetFunctionUploadURLRequest, opts ...scw.RequestOption) (*UploadURL, error)
- func (s *API) GetNamespace(req *GetNamespaceRequest, opts ...scw.RequestOption) (*Namespace, error)
- func (s *API) GetToken(req *GetTokenRequest, opts ...scw.RequestOption) (*Token, error)
- func (s *API) GetTrigger(req *GetTriggerRequest, opts ...scw.RequestOption) (*Trigger, error)
- func (s *API) IssueJWT(req *IssueJWTRequest, opts ...scw.RequestOption) (*Token, error)
- func (s *API) ListCrons(req *ListCronsRequest, opts ...scw.RequestOption) (*ListCronsResponse, error)
- func (s *API) ListDomains(req *ListDomainsRequest, opts ...scw.RequestOption) (*ListDomainsResponse, error)
- func (s *API) ListFunctionRuntimes(req *ListFunctionRuntimesRequest, opts ...scw.RequestOption) (*ListFunctionRuntimesResponse, error)
- func (s *API) ListFunctions(req *ListFunctionsRequest, opts ...scw.RequestOption) (*ListFunctionsResponse, error)
- func (s *API) ListLogs(req *ListLogsRequest, opts ...scw.RequestOption) (*ListLogsResponse, error)
- func (s *API) ListNamespaces(req *ListNamespacesRequest, opts ...scw.RequestOption) (*ListNamespacesResponse, error)
- func (s *API) ListTokens(req *ListTokensRequest, opts ...scw.RequestOption) (*ListTokensResponse, error)
- func (s *API) ListTriggers(req *ListTriggersRequest, opts ...scw.RequestOption) (*ListTriggersResponse, error)
- func (s *API) Regions() []scw.Region
- func (s *API) UpdateCron(req *UpdateCronRequest, opts ...scw.RequestOption) (*Cron, error)
- func (s *API) UpdateFunction(req *UpdateFunctionRequest, opts ...scw.RequestOption) (*Function, error)
- func (s *API) UpdateNamespace(req *UpdateNamespaceRequest, opts ...scw.RequestOption) (*Namespace, error)
- func (s *API) UpdateTrigger(req *UpdateTriggerRequest, opts ...scw.RequestOption) (*Trigger, error)
- func (s *API) WaitForCron(req *WaitForCronRequest, opts ...scw.RequestOption) (*Cron, error)
- func (s *API) WaitForDomain(req *WaitForDomainRequest, opts ...scw.RequestOption) (*Domain, error)
- func (s *API) WaitForFunction(req *WaitForFunctionRequest, opts ...scw.RequestOption) (*Function, error)
- func (s *API) WaitForNamespace(req *WaitForNamespaceRequest, opts ...scw.RequestOption) (*Namespace, error)
- type CreateCronRequest
- type CreateDomainRequest
- type CreateFunctionRequest
- type CreateNamespaceRequest
- type CreateTokenRequest
- type CreateTriggerRequest
- type CreateTriggerRequestMnqNatsClientConfig
- type CreateTriggerRequestMnqSqsClientConfig
- type CreateTriggerRequestSqsClientConfig
- type Cron
- type CronStatus
- type DeleteCronRequest
- type DeleteDomainRequest
- type DeleteFunctionRequest
- type DeleteNamespaceRequest
- type DeleteTokenRequest
- type DeleteTriggerRequest
- type DeployFunctionRequest
- type Domain
- type DomainStatus
- type DownloadURL
- type Function
- type FunctionHTTPOption
- type FunctionPrivacy
- type FunctionRuntime
- type FunctionStatus
- type GetCronRequest
- type GetDomainRequest
- type GetFunctionDownloadURLRequest
- type GetFunctionRequest
- type GetFunctionUploadURLRequest
- type GetNamespaceRequest
- type GetTokenRequest
- type GetTriggerRequest
- type IssueJWTRequest
- type ListCronsRequest
- type ListCronsRequestOrderBy
- type ListCronsResponse
- type ListDomainsRequest
- type ListDomainsRequestOrderBy
- type ListDomainsResponse
- type ListFunctionRuntimesRequest
- type ListFunctionRuntimesResponse
- type ListFunctionsRequest
- type ListFunctionsRequestOrderBy
- type ListFunctionsResponse
- type ListLogsRequest
- type ListLogsRequestOrderBy
- type ListLogsResponse
- type ListNamespacesRequest
- type ListNamespacesRequestOrderBy
- type ListNamespacesResponse
- type ListTokensRequest
- type ListTokensRequestOrderBy
- type ListTokensResponse
- type ListTriggersRequest
- type ListTriggersRequestOrderBy
- type ListTriggersResponse
- type Log
- type LogStream
- type Namespace
- type NamespaceStatus
- type NullValue
- type Runtime
- type RuntimeStatus
- type Secret
- type SecretHashedValue
- type Token
- type TokenStatus
- type Trigger
- type TriggerInputType
- type TriggerMnqNatsClientConfig
- type TriggerMnqSqsClientConfig
- type TriggerSqsClientConfig
- type TriggerStatus
- type UpdateCronRequest
- type UpdateFunctionRequest
- type UpdateNamespaceRequest
- type UpdateTriggerRequest
- type UpdateTriggerRequestMnqNatsClientConfig
- type UpdateTriggerRequestMnqSqsClientConfig
- type UpdateTriggerRequestSqsClientConfig
- type UploadURL
- type WaitForCronRequest
- type WaitForDomainRequest
- type WaitForFunctionRequest
- type WaitForNamespaceRequest
Constants ¶
const ( CronStatusUnknown = CronStatus("unknown") CronStatusReady = CronStatus("ready") CronStatusDeleting = CronStatus("deleting") CronStatusError = CronStatus("error") CronStatusLocked = CronStatus("locked") CronStatusCreating = CronStatus("creating") CronStatusPending = CronStatus("pending") )
const ( DomainStatusUnknown = DomainStatus("unknown") DomainStatusReady = DomainStatus("ready") DomainStatusDeleting = DomainStatus("deleting") DomainStatusError = DomainStatus("error") DomainStatusCreating = DomainStatus("creating") DomainStatusPending = DomainStatus("pending") )
const ( FunctionHTTPOptionUnknownHTTPOption = FunctionHTTPOption("unknown_http_option") FunctionHTTPOptionEnabled = FunctionHTTPOption("enabled") FunctionHTTPOptionRedirected = FunctionHTTPOption("redirected") )
const ( FunctionPrivacyUnknownPrivacy = FunctionPrivacy("unknown_privacy") FunctionPrivacyPublic = FunctionPrivacy("public") FunctionPrivacyPrivate = FunctionPrivacy("private") )
const ( FunctionRuntimeUnknownRuntime = FunctionRuntime("unknown_runtime") FunctionRuntimeGolang = FunctionRuntime("golang") FunctionRuntimePython = FunctionRuntime("python") FunctionRuntimePython3 = FunctionRuntime("python3") FunctionRuntimeNode8 = FunctionRuntime("node8") FunctionRuntimeNode10 = FunctionRuntime("node10") FunctionRuntimeNode14 = FunctionRuntime("node14") FunctionRuntimeNode16 = FunctionRuntime("node16") FunctionRuntimeNode17 = FunctionRuntime("node17") FunctionRuntimePython37 = FunctionRuntime("python37") FunctionRuntimePython38 = FunctionRuntime("python38") FunctionRuntimePython39 = FunctionRuntime("python39") FunctionRuntimePython310 = FunctionRuntime("python310") FunctionRuntimeGo113 = FunctionRuntime("go113") FunctionRuntimeGo117 = FunctionRuntime("go117") FunctionRuntimeGo118 = FunctionRuntime("go118") FunctionRuntimeNode18 = FunctionRuntime("node18") FunctionRuntimeRust165 = FunctionRuntime("rust165") FunctionRuntimeGo119 = FunctionRuntime("go119") FunctionRuntimePython311 = FunctionRuntime("python311") FunctionRuntimePhp82 = FunctionRuntime("php82") FunctionRuntimeNode19 = FunctionRuntime("node19") FunctionRuntimeGo120 = FunctionRuntime("go120") )
const ( FunctionStatusUnknown = FunctionStatus("unknown") FunctionStatusReady = FunctionStatus("ready") FunctionStatusDeleting = FunctionStatus("deleting") FunctionStatusError = FunctionStatus("error") FunctionStatusLocked = FunctionStatus("locked") FunctionStatusCreating = FunctionStatus("creating") FunctionStatusPending = FunctionStatus("pending") FunctionStatusCreated = FunctionStatus("created") )
const ( ListCronsRequestOrderByCreatedAtAsc = ListCronsRequestOrderBy("created_at_asc") ListCronsRequestOrderByCreatedAtDesc = ListCronsRequestOrderBy("created_at_desc") )
const ( ListDomainsRequestOrderByCreatedAtAsc = ListDomainsRequestOrderBy("created_at_asc") ListDomainsRequestOrderByCreatedAtDesc = ListDomainsRequestOrderBy("created_at_desc") ListDomainsRequestOrderByHostnameAsc = ListDomainsRequestOrderBy("hostname_asc") ListDomainsRequestOrderByHostnameDesc = ListDomainsRequestOrderBy("hostname_desc") )
const ( ListFunctionsRequestOrderByCreatedAtAsc = ListFunctionsRequestOrderBy("created_at_asc") ListFunctionsRequestOrderByCreatedAtDesc = ListFunctionsRequestOrderBy("created_at_desc") ListFunctionsRequestOrderByNameAsc = ListFunctionsRequestOrderBy("name_asc") ListFunctionsRequestOrderByNameDesc = ListFunctionsRequestOrderBy("name_desc") )
const ( ListLogsRequestOrderByTimestampDesc = ListLogsRequestOrderBy("timestamp_desc") ListLogsRequestOrderByTimestampAsc = ListLogsRequestOrderBy("timestamp_asc") )
const ( ListNamespacesRequestOrderByCreatedAtAsc = ListNamespacesRequestOrderBy("created_at_asc") ListNamespacesRequestOrderByCreatedAtDesc = ListNamespacesRequestOrderBy("created_at_desc") ListNamespacesRequestOrderByNameAsc = ListNamespacesRequestOrderBy("name_asc") ListNamespacesRequestOrderByNameDesc = ListNamespacesRequestOrderBy("name_desc") )
const ( ListTokensRequestOrderByCreatedAtAsc = ListTokensRequestOrderBy("created_at_asc") ListTokensRequestOrderByCreatedAtDesc = ListTokensRequestOrderBy("created_at_desc") )
const ( ListTriggersRequestOrderByCreatedAtAsc = ListTriggersRequestOrderBy("created_at_asc") ListTriggersRequestOrderByCreatedAtDesc = ListTriggersRequestOrderBy("created_at_desc") )
const ( LogStreamUnknown = LogStream("unknown") LogStreamStdout = LogStream("stdout") LogStreamStderr = LogStream("stderr") )
const ( NamespaceStatusUnknown = NamespaceStatus("unknown") NamespaceStatusReady = NamespaceStatus("ready") NamespaceStatusDeleting = NamespaceStatus("deleting") NamespaceStatusError = NamespaceStatus("error") NamespaceStatusLocked = NamespaceStatus("locked") NamespaceStatusCreating = NamespaceStatus("creating") NamespaceStatusPending = NamespaceStatus("pending") )
const ( RuntimeStatusUnknownStatus = RuntimeStatus("unknown_status") RuntimeStatusBeta = RuntimeStatus("beta") RuntimeStatusAvailable = RuntimeStatus("available") RuntimeStatusDeprecated = RuntimeStatus("deprecated") RuntimeStatusEndOfSupport = RuntimeStatus("end_of_support") RuntimeStatusEndOfLife = RuntimeStatus("end_of_life") )
const ( TokenStatusUnknown = TokenStatus("unknown") TokenStatusReady = TokenStatus("ready") TokenStatusDeleting = TokenStatus("deleting") TokenStatusError = TokenStatus("error") TokenStatusCreating = TokenStatus("creating") )
const ( TriggerInputTypeUnknownInputType = TriggerInputType("unknown_input_type") TriggerInputTypeSqs = TriggerInputType("sqs") TriggerInputTypeScwSqs = TriggerInputType("scw_sqs") TriggerInputTypeNats = TriggerInputType("nats") TriggerInputTypeScwNats = TriggerInputType("scw_nats") )
const ( TriggerStatusUnknownStatus = TriggerStatus("unknown_status") TriggerStatusReady = TriggerStatus("ready") TriggerStatusDeleting = TriggerStatus("deleting") TriggerStatusError = TriggerStatus("error") TriggerStatusCreating = TriggerStatus("creating") TriggerStatusPending = TriggerStatus("pending") )
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 functions API.
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.
func (*API) CreateFunction ¶
func (s *API) CreateFunction(req *CreateFunctionRequest, opts ...scw.RequestOption) (*Function, error)
CreateFunction: create a new function.
func (*API) CreateNamespace ¶
func (s *API) CreateNamespace(req *CreateNamespaceRequest, opts ...scw.RequestOption) (*Namespace, error)
CreateNamespace: create a new namespace.
func (*API) CreateToken ¶
func (s *API) CreateToken(req *CreateTokenRequest, opts ...scw.RequestOption) (*Token, error)
CreateToken: create a new revocable token.
func (*API) CreateTrigger ¶
func (s *API) CreateTrigger(req *CreateTriggerRequest, opts ...scw.RequestOption) (*Trigger, error)
func (*API) DeleteCron ¶
func (s *API) DeleteCron(req *DeleteCronRequest, opts ...scw.RequestOption) (*Cron, error)
DeleteCron: delete the cron associated with the given id.
func (*API) DeleteDomain ¶
func (s *API) DeleteDomain(req *DeleteDomainRequest, opts ...scw.RequestOption) (*Domain, error)
DeleteDomain: delete a domain name binding.
func (*API) DeleteFunction ¶
func (s *API) DeleteFunction(req *DeleteFunctionRequest, opts ...scw.RequestOption) (*Function, error)
DeleteFunction: delete the function associated with the given id.
func (*API) DeleteNamespace ¶
func (s *API) DeleteNamespace(req *DeleteNamespaceRequest, opts ...scw.RequestOption) (*Namespace, error)
DeleteNamespace: delete the namespace associated with the given id.
func (*API) DeleteToken ¶
func (s *API) DeleteToken(req *DeleteTokenRequest, opts ...scw.RequestOption) (*Token, error)
DeleteToken: delete a token.
func (*API) DeleteTrigger ¶
func (s *API) DeleteTrigger(req *DeleteTriggerRequest, opts ...scw.RequestOption) (*Trigger, error)
func (*API) DeployFunction ¶
func (s *API) DeployFunction(req *DeployFunctionRequest, opts ...scw.RequestOption) (*Function, error)
DeployFunction: deploy a function associated with the given id.
func (*API) GetCron ¶
func (s *API) GetCron(req *GetCronRequest, opts ...scw.RequestOption) (*Cron, error)
GetCron: get the cron associated with the given id.
func (*API) GetDomain ¶
func (s *API) GetDomain(req *GetDomainRequest, opts ...scw.RequestOption) (*Domain, error)
GetDomain: get a domain name binding.
func (*API) GetFunction ¶
func (s *API) GetFunction(req *GetFunctionRequest, opts ...scw.RequestOption) (*Function, error)
GetFunction: get the function associated with the given id.
func (*API) GetFunctionDownloadURL ¶
func (s *API) GetFunctionDownloadURL(req *GetFunctionDownloadURLRequest, opts ...scw.RequestOption) (*DownloadURL, error)
GetFunctionDownloadURL: get a download URL for a function associated with the given id.
func (*API) GetFunctionUploadURL ¶
func (s *API) GetFunctionUploadURL(req *GetFunctionUploadURLRequest, opts ...scw.RequestOption) (*UploadURL, error)
GetFunctionUploadURL: get an upload URL of a function associated with the given id.
func (*API) GetNamespace ¶
func (s *API) GetNamespace(req *GetNamespaceRequest, opts ...scw.RequestOption) (*Namespace, error)
GetNamespace: get the namespace associated with the given id.
func (*API) GetToken ¶
func (s *API) GetToken(req *GetTokenRequest, opts ...scw.RequestOption) (*Token, error)
GetToken: get a token.
func (*API) GetTrigger ¶
func (s *API) GetTrigger(req *GetTriggerRequest, opts ...scw.RequestOption) (*Trigger, error)
func (*API) IssueJWT ¶
func (s *API) IssueJWT(req *IssueJWTRequest, opts ...scw.RequestOption) (*Token, error)
Deprecated
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.
func (*API) ListFunctionRuntimes ¶
func (s *API) ListFunctionRuntimes(req *ListFunctionRuntimesRequest, opts ...scw.RequestOption) (*ListFunctionRuntimesResponse, error)
ListFunctionRuntimes: list available function runtimes.
func (*API) ListFunctions ¶
func (s *API) ListFunctions(req *ListFunctionsRequest, opts ...scw.RequestOption) (*ListFunctionsResponse, error)
ListFunctions: list all your functions.
func (*API) ListLogs ¶
func (s *API) ListLogs(req *ListLogsRequest, opts ...scw.RequestOption) (*ListLogsResponse, error)
ListLogs: list your application logs.
func (*API) ListNamespaces ¶
func (s *API) ListNamespaces(req *ListNamespacesRequest, opts ...scw.RequestOption) (*ListNamespacesResponse, error)
ListNamespaces: list all your namespaces.
func (*API) ListTokens ¶
func (s *API) ListTokens(req *ListTokensRequest, opts ...scw.RequestOption) (*ListTokensResponse, error)
ListTokens: list all tokens.
func (*API) ListTriggers ¶
func (s *API) ListTriggers(req *ListTriggersRequest, opts ...scw.RequestOption) (*ListTriggersResponse, error)
func (*API) UpdateCron ¶
func (s *API) UpdateCron(req *UpdateCronRequest, opts ...scw.RequestOption) (*Cron, error)
UpdateCron: update the cron associated with the given id.
func (*API) UpdateFunction ¶
func (s *API) UpdateFunction(req *UpdateFunctionRequest, opts ...scw.RequestOption) (*Function, error)
UpdateFunction: update the function associated with the given id.
func (*API) UpdateNamespace ¶
func (s *API) UpdateNamespace(req *UpdateNamespaceRequest, opts ...scw.RequestOption) (*Namespace, error)
UpdateNamespace: update the space associated with the given id.
func (*API) UpdateTrigger ¶
func (s *API) UpdateTrigger(req *UpdateTriggerRequest, opts ...scw.RequestOption) (*Trigger, error)
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) WaitForFunction ¶
func (s *API) WaitForFunction(req *WaitForFunctionRequest, opts ...scw.RequestOption) (*Function, error)
WaitForFunction waits for the Function 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 CreateCronRequest ¶
type CreateDomainRequest ¶
type CreateFunctionRequest ¶
type CreateFunctionRequest struct {
// Region: region to target. If none is passed will use default region from the config.
Region scw.Region `json:"-"`
Name string `json:"name"`
NamespaceID string `json:"namespace_id"`
EnvironmentVariables *map[string]string `json:"environment_variables"`
MinScale *uint32 `json:"min_scale"`
MaxScale *uint32 `json:"max_scale"`
// Runtime:
// Default value: unknown_runtime
Runtime FunctionRuntime `json:"runtime"`
MemoryLimit *uint32 `json:"memory_limit"`
Timeout *scw.Duration `json:"timeout"`
Handler *string `json:"handler"`
// Privacy:
// Default value: unknown_privacy
Privacy FunctionPrivacy `json:"privacy"`
Description *string `json:"description"`
SecretEnvironmentVariables []*Secret `json:"secret_environment_variables"`
// HTTPOption: 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 FunctionHTTPOption `json:"http_option"`
}
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 string `json:"name"`
EnvironmentVariables *map[string]string `json:"environment_variables"`
ProjectID string `json:"project_id"`
Description *string `json:"description"`
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:"-"`
// Precisely one of FunctionID, NamespaceID must be set.
FunctionID *string `json:"function_id,omitempty"`
// Precisely one of FunctionID, NamespaceID must be set.
NamespaceID *string `json:"namespace_id,omitempty"`
Description *string `json:"description"`
ExpiresAt *time.Time `json:"expires_at"`
}
type CreateTriggerRequest ¶
type CreateTriggerRequest struct {
// Region: region to target. If none is passed will use default region from the config.
Region scw.Region `json:"-"`
Name string `json:"name"`
Description string `json:"description"`
FunctionID string `json:"function_id"`
// Precisely one of ScwNatsConfig, ScwSqsConfig, SqsConfig must be set.
ScwSqsConfig *CreateTriggerRequestMnqSqsClientConfig `json:"scw_sqs_config,omitempty"`
// Precisely one of ScwNatsConfig, ScwSqsConfig, SqsConfig must be set.
SqsConfig *CreateTriggerRequestSqsClientConfig `json:"sqs_config,omitempty"`
// Precisely one of ScwNatsConfig, ScwSqsConfig, SqsConfig must be set.
ScwNatsConfig *CreateTriggerRequestMnqNatsClientConfig `json:"scw_nats_config,omitempty"`
}
type Cron ¶
type Cron struct {
ID string `json:"id"`
FunctionID string `json:"function_id"`
Schedule string `json:"schedule"`
Args *scw.JSONObject `json:"args"`
// Status:
// Default value: unknown
Status CronStatus `json:"status"`
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 DeleteCronRequest ¶
type DeleteDomainRequest ¶
type DeleteFunctionRequest ¶
type DeleteNamespaceRequest ¶
type DeleteTokenRequest ¶
type DeleteTriggerRequest ¶
type DeployFunctionRequest ¶
type Domain ¶
type Domain struct {
ID string `json:"id"`
Hostname string `json:"hostname"`
FunctionID string `json:"function_id"`
URL string `json:"url"`
// Status:
// Default value: unknown
Status DomainStatus `json:"status"`
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 DownloadURL ¶
type Function ¶
type Function struct {
ID string `json:"id"`
Name string `json:"name"`
NamespaceID string `json:"namespace_id"`
// Status:
// Default value: unknown
Status FunctionStatus `json:"status"`
EnvironmentVariables map[string]string `json:"environment_variables"`
MinScale uint32 `json:"min_scale"`
MaxScale uint32 `json:"max_scale"`
// Runtime:
// Default value: unknown_runtime
Runtime FunctionRuntime `json:"runtime"`
MemoryLimit uint32 `json:"memory_limit"`
CPULimit uint32 `json:"cpu_limit"`
Timeout *scw.Duration `json:"timeout"`
Handler string `json:"handler"`
ErrorMessage *string `json:"error_message"`
// Privacy:
// Default value: unknown_privacy
Privacy FunctionPrivacy `json:"privacy"`
Description *string `json:"description"`
DomainName string `json:"domain_name"`
SecretEnvironmentVariables []*SecretHashedValue `json:"secret_environment_variables"`
Region scw.Region `json:"region"`
// HTTPOption: 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 FunctionHTTPOption `json:"http_option"`
RuntimeMessage string `json:"runtime_message"`
}
Function: function.
type FunctionHTTPOption ¶
type FunctionHTTPOption string
func (FunctionHTTPOption) MarshalJSON ¶
func (enum FunctionHTTPOption) MarshalJSON() ([]byte, error)
func (FunctionHTTPOption) String ¶
func (enum FunctionHTTPOption) String() string
func (*FunctionHTTPOption) UnmarshalJSON ¶
func (enum *FunctionHTTPOption) UnmarshalJSON(data []byte) error
type FunctionPrivacy ¶
type FunctionPrivacy string
func (FunctionPrivacy) MarshalJSON ¶
func (enum FunctionPrivacy) MarshalJSON() ([]byte, error)
func (FunctionPrivacy) String ¶
func (enum FunctionPrivacy) String() string
func (*FunctionPrivacy) UnmarshalJSON ¶
func (enum *FunctionPrivacy) UnmarshalJSON(data []byte) error
type FunctionRuntime ¶
type FunctionRuntime string
func (FunctionRuntime) MarshalJSON ¶
func (enum FunctionRuntime) MarshalJSON() ([]byte, error)
func (FunctionRuntime) String ¶
func (enum FunctionRuntime) String() string
func (*FunctionRuntime) UnmarshalJSON ¶
func (enum *FunctionRuntime) UnmarshalJSON(data []byte) error
type FunctionStatus ¶
type FunctionStatus string
func (FunctionStatus) MarshalJSON ¶
func (enum FunctionStatus) MarshalJSON() ([]byte, error)
func (FunctionStatus) String ¶
func (enum FunctionStatus) String() string
func (*FunctionStatus) UnmarshalJSON ¶
func (enum *FunctionStatus) UnmarshalJSON(data []byte) error
type GetCronRequest ¶
type GetDomainRequest ¶
type GetFunctionRequest ¶
type GetNamespaceRequest ¶
type GetTokenRequest ¶
type GetTriggerRequest ¶
type IssueJWTRequest ¶
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 *int32 `json:"-"`
PageSize *uint32 `json:"-"`
// OrderBy:
// Default value: created_at_asc
OrderBy ListCronsRequestOrderBy `json:"-"`
FunctionID 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 []*Cron `json:"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 *int32 `json:"-"`
PageSize *uint32 `json:"-"`
// OrderBy:
// Default value: created_at_asc
OrderBy ListDomainsRequestOrderBy `json:"-"`
FunctionID 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 []*Domain `json:"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 ListFunctionRuntimesResponse ¶
type ListFunctionRuntimesResponse struct {
Runtimes []*Runtime `json:"runtimes"`
TotalCount uint32 `json:"total_count"`
}
ListFunctionRuntimesResponse: list function runtimes response.
type ListFunctionsRequest ¶
type ListFunctionsRequest struct {
// Region: region to target. If none is passed will use default region from the config.
Region scw.Region `json:"-"`
Page *int32 `json:"-"`
PageSize *uint32 `json:"-"`
// OrderBy:
// Default value: created_at_asc
OrderBy ListFunctionsRequestOrderBy `json:"-"`
NamespaceID string `json:"-"`
Name *string `json:"-"`
OrganizationID *string `json:"-"`
ProjectID *string `json:"-"`
}
type ListFunctionsRequestOrderBy ¶
type ListFunctionsRequestOrderBy string
func (ListFunctionsRequestOrderBy) MarshalJSON ¶
func (enum ListFunctionsRequestOrderBy) MarshalJSON() ([]byte, error)
func (ListFunctionsRequestOrderBy) String ¶
func (enum ListFunctionsRequestOrderBy) String() string
func (*ListFunctionsRequestOrderBy) UnmarshalJSON ¶
func (enum *ListFunctionsRequestOrderBy) UnmarshalJSON(data []byte) error
type ListFunctionsResponse ¶
type ListFunctionsResponse struct {
Functions []*Function `json:"functions"`
TotalCount uint32 `json:"total_count"`
}
ListFunctionsResponse: list functions response.
func (*ListFunctionsResponse) UnsafeAppend ¶
func (r *ListFunctionsResponse) UnsafeAppend(res interface{}) (uint32, error)
UnsafeAppend should not be used Internal usage only
func (*ListFunctionsResponse) UnsafeGetTotalCount ¶
func (r *ListFunctionsResponse) 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:"-"`
FunctionID string `json:"-"`
Page *int32 `json:"-"`
PageSize *uint32 `json:"-"`
// OrderBy:
// 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 ¶
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 *int32 `json:"-"`
PageSize *uint32 `json:"-"`
// OrderBy:
// Default value: created_at_asc
OrderBy ListNamespacesRequestOrderBy `json:"-"`
Name *string `json:"-"`
OrganizationID *string `json:"-"`
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 []*Namespace `json:"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 *int32 `json:"-"`
PageSize *uint32 `json:"-"`
// OrderBy:
// Default value: created_at_asc
OrderBy ListTokensRequestOrderBy `json:"-"`
FunctionID *string `json:"-"`
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 ListTriggersRequest ¶
type ListTriggersRequest struct {
// Region: region to target. If none is passed will use default region from the config.
Region scw.Region `json:"-"`
Page *int32 `json:"-"`
PageSize *uint32 `json:"-"`
// OrderBy:
// Default value: created_at_asc
OrderBy ListTriggersRequestOrderBy `json:"-"`
FunctionID *string `json:"-"`
NamespaceID *string `json:"-"`
ProjectID *string `json:"-"`
}
type ListTriggersRequestOrderBy ¶
type ListTriggersRequestOrderBy string
func (ListTriggersRequestOrderBy) MarshalJSON ¶
func (enum ListTriggersRequestOrderBy) MarshalJSON() ([]byte, error)
func (ListTriggersRequestOrderBy) String ¶
func (enum ListTriggersRequestOrderBy) String() string
func (*ListTriggersRequestOrderBy) UnmarshalJSON ¶
func (enum *ListTriggersRequestOrderBy) UnmarshalJSON(data []byte) error
type ListTriggersResponse ¶
type ListTriggersResponse struct {
Triggers []*Trigger `json:"triggers"`
TotalCount uint32 `json:"total_count"`
}
func (*ListTriggersResponse) UnsafeAppend ¶
func (r *ListTriggersResponse) UnsafeAppend(res interface{}) (uint32, error)
UnsafeAppend should not be used Internal usage only
func (*ListTriggersResponse) UnsafeGetTotalCount ¶
func (r *ListTriggersResponse) 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 (*LogStream) UnmarshalJSON ¶
type Namespace ¶
type Namespace struct {
ID string `json:"id"`
Name string `json:"name"`
EnvironmentVariables map[string]string `json:"environment_variables"`
OrganizationID string `json:"organization_id"`
ProjectID string `json:"project_id"`
// Status:
// Default value: unknown
Status NamespaceStatus `json:"status"`
RegistryNamespaceID string `json:"registry_namespace_id"`
ErrorMessage *string `json:"error_message"`
RegistryEndpoint string `json:"registry_endpoint"`
Description *string `json:"description"`
SecretEnvironmentVariables []*SecretHashedValue `json:"secret_environment_variables"`
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 (*NullValue) UnmarshalJSON ¶
type Runtime ¶
type Runtime struct {
Name string `json:"name"`
Language string `json:"language"`
Version string `json:"version"`
DefaultHandler string `json:"default_handler"`
CodeSample string `json:"code_sample"`
// Status:
// Default value: unknown_status
Status RuntimeStatus `json:"status"`
StatusMessage string `json:"status_message"`
Extension string `json:"extension"`
Implementation string `json:"implementation"`
}
type RuntimeStatus ¶
type RuntimeStatus string
func (RuntimeStatus) MarshalJSON ¶
func (enum RuntimeStatus) MarshalJSON() ([]byte, error)
func (RuntimeStatus) String ¶
func (enum RuntimeStatus) String() string
func (*RuntimeStatus) UnmarshalJSON ¶
func (enum *RuntimeStatus) UnmarshalJSON(data []byte) error
type SecretHashedValue ¶
type Token ¶
type Token struct {
ID string `json:"id"`
Token string `json:"token"`
// Precisely one of FunctionID, NamespaceID must be set.
FunctionID *string `json:"function_id,omitempty"`
// Precisely one of FunctionID, NamespaceID must be set.
NamespaceID *string `json:"namespace_id,omitempty"`
// Deprecated
PublicKey *string `json:"public_key,omitempty"`
// Status:
// Default value: unknown
Status TokenStatus `json:"status"`
Description *string `json:"description"`
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 Trigger ¶
type Trigger struct {
ID string `json:"id"`
Name string `json:"name"`
Description string `json:"description"`
// InputType:
// Default value: unknown_input_type
InputType TriggerInputType `json:"input_type"`
// Status:
// Default value: unknown_status
Status TriggerStatus `json:"status"`
ErrorMessage *string `json:"error_message"`
FunctionID string `json:"function_id"`
// Precisely one of ScwNatsConfig, ScwSqsConfig, SqsConfig must be set.
ScwSqsConfig *TriggerMnqSqsClientConfig `json:"scw_sqs_config,omitempty"`
// Precisely one of ScwNatsConfig, ScwSqsConfig, SqsConfig must be set.
SqsConfig *TriggerSqsClientConfig `json:"sqs_config,omitempty"`
// Precisely one of ScwNatsConfig, ScwSqsConfig, SqsConfig must be set.
ScwNatsConfig *TriggerMnqNatsClientConfig `json:"scw_nats_config,omitempty"`
}
type TriggerInputType ¶
type TriggerInputType string
func (TriggerInputType) MarshalJSON ¶
func (enum TriggerInputType) MarshalJSON() ([]byte, error)
func (TriggerInputType) String ¶
func (enum TriggerInputType) String() string
func (*TriggerInputType) UnmarshalJSON ¶
func (enum *TriggerInputType) UnmarshalJSON(data []byte) error
type TriggerSqsClientConfig ¶
type TriggerStatus ¶
type TriggerStatus string
func (TriggerStatus) MarshalJSON ¶
func (enum TriggerStatus) MarshalJSON() ([]byte, error)
func (TriggerStatus) String ¶
func (enum TriggerStatus) String() string
func (*TriggerStatus) UnmarshalJSON ¶
func (enum *TriggerStatus) UnmarshalJSON(data []byte) error
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 string `json:"-"`
FunctionID *string `json:"function_id"`
Schedule *string `json:"schedule"`
Args *scw.JSONObject `json:"args"`
Name *string `json:"name"`
}
type UpdateFunctionRequest ¶
type UpdateFunctionRequest struct {
// Region: region to target. If none is passed will use default region from the config.
Region scw.Region `json:"-"`
FunctionID string `json:"-"`
EnvironmentVariables *map[string]string `json:"environment_variables"`
MinScale *uint32 `json:"min_scale"`
MaxScale *uint32 `json:"max_scale"`
// Runtime:
// Default value: unknown_runtime
Runtime FunctionRuntime `json:"runtime"`
MemoryLimit *uint32 `json:"memory_limit"`
Timeout *scw.Duration `json:"timeout"`
Redeploy *bool `json:"redeploy"`
Handler *string `json:"handler"`
// Privacy:
// Default value: unknown_privacy
Privacy FunctionPrivacy `json:"privacy"`
Description *string `json:"description"`
SecretEnvironmentVariables []*Secret `json:"secret_environment_variables"`
// HTTPOption: 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 FunctionHTTPOption `json:"http_option"`
}
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 string `json:"-"`
EnvironmentVariables *map[string]string `json:"environment_variables"`
Description *string `json:"description"`
SecretEnvironmentVariables []*Secret `json:"secret_environment_variables"`
}
type UpdateTriggerRequest ¶
type UpdateTriggerRequest struct {
// Region: region to target. If none is passed will use default region from the config.
Region scw.Region `json:"-"`
TriggerID string `json:"-"`
Name *string `json:"name"`
Description *string `json:"description"`
// Precisely one of ScwNatsConfig, ScwSqsConfig, SqsConfig must be set.
ScwSqsConfig *UpdateTriggerRequestMnqSqsClientConfig `json:"scw_sqs_config,omitempty"`
// Precisely one of ScwNatsConfig, ScwSqsConfig, SqsConfig must be set.
SqsConfig *UpdateTriggerRequestSqsClientConfig `json:"sqs_config,omitempty"`
// Precisely one of ScwNatsConfig, ScwSqsConfig, SqsConfig must be set.
ScwNatsConfig *UpdateTriggerRequestMnqNatsClientConfig `json:"scw_nats_config,omitempty"`
}
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.