function

package
v1.0.0-beta.12 Latest Latest
Warning

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

Go to latest
Published: Jan 17, 2023 License: Apache-2.0 Imports: 14 Imported by: 2

Documentation

Overview

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

Index

Constants

View Source
const (
	// CronStatusUnknown is [insert doc].
	CronStatusUnknown = CronStatus("unknown")
	// CronStatusReady is [insert doc].
	CronStatusReady = CronStatus("ready")
	// CronStatusDeleting is [insert doc].
	CronStatusDeleting = CronStatus("deleting")
	// CronStatusError is [insert doc].
	CronStatusError = CronStatus("error")
	// CronStatusLocked is [insert doc].
	CronStatusLocked = CronStatus("locked")
	// CronStatusCreating is [insert doc].
	CronStatusCreating = CronStatus("creating")
	// CronStatusPending is [insert doc].
	CronStatusPending = CronStatus("pending")
)
View Source
const (
	// DomainStatusUnknown is [insert doc].
	DomainStatusUnknown = DomainStatus("unknown")
	// DomainStatusReady is [insert doc].
	DomainStatusReady = DomainStatus("ready")
	// DomainStatusDeleting is [insert doc].
	DomainStatusDeleting = DomainStatus("deleting")
	// DomainStatusError is [insert doc].
	DomainStatusError = DomainStatus("error")
	// DomainStatusCreating is [insert doc].
	DomainStatusCreating = DomainStatus("creating")
	// DomainStatusPending is [insert doc].
	DomainStatusPending = DomainStatus("pending")
)
View Source
const (
	// FunctionHTTPOptionUnknownHTTPOption is [insert doc].
	FunctionHTTPOptionUnknownHTTPOption = FunctionHTTPOption("unknown_http_option")
	// FunctionHTTPOptionEnabled is [insert doc].
	FunctionHTTPOptionEnabled = FunctionHTTPOption("enabled")
	// FunctionHTTPOptionRedirected is [insert doc].
	FunctionHTTPOptionRedirected = FunctionHTTPOption("redirected")
)
View Source
const (
	// FunctionPrivacyUnknownPrivacy is [insert doc].
	FunctionPrivacyUnknownPrivacy = FunctionPrivacy("unknown_privacy")
	// FunctionPrivacyPublic is [insert doc].
	FunctionPrivacyPublic = FunctionPrivacy("public")
	// FunctionPrivacyPrivate is [insert doc].
	FunctionPrivacyPrivate = FunctionPrivacy("private")
)
View Source
const (
	// FunctionRuntimeUnknownRuntime is [insert doc].
	FunctionRuntimeUnknownRuntime = FunctionRuntime("unknown_runtime")
	// FunctionRuntimeGolang is [insert doc].
	FunctionRuntimeGolang = FunctionRuntime("golang")
	// FunctionRuntimePython is [insert doc].
	FunctionRuntimePython = FunctionRuntime("python")
	// FunctionRuntimePython3 is [insert doc].
	FunctionRuntimePython3 = FunctionRuntime("python3")
	// FunctionRuntimeNode8 is [insert doc].
	FunctionRuntimeNode8 = FunctionRuntime("node8")
	// FunctionRuntimeNode10 is [insert doc].
	FunctionRuntimeNode10 = FunctionRuntime("node10")
	// FunctionRuntimeNode14 is [insert doc].
	FunctionRuntimeNode14 = FunctionRuntime("node14")
	// FunctionRuntimeNode16 is [insert doc].
	FunctionRuntimeNode16 = FunctionRuntime("node16")
	// FunctionRuntimeNode17 is [insert doc].
	FunctionRuntimeNode17 = FunctionRuntime("node17")
	// FunctionRuntimePython37 is [insert doc].
	FunctionRuntimePython37 = FunctionRuntime("python37")
	// FunctionRuntimePython38 is [insert doc].
	FunctionRuntimePython38 = FunctionRuntime("python38")
	// FunctionRuntimePython39 is [insert doc].
	FunctionRuntimePython39 = FunctionRuntime("python39")
	// FunctionRuntimePython310 is [insert doc].
	FunctionRuntimePython310 = FunctionRuntime("python310")
	// FunctionRuntimeGo113 is [insert doc].
	FunctionRuntimeGo113 = FunctionRuntime("go113")
	// FunctionRuntimeGo117 is [insert doc].
	FunctionRuntimeGo117 = FunctionRuntime("go117")
	// FunctionRuntimeGo118 is [insert doc].
	FunctionRuntimeGo118 = FunctionRuntime("go118")
	// FunctionRuntimeNode18 is [insert doc].
	FunctionRuntimeNode18 = FunctionRuntime("node18")
	// FunctionRuntimeRust165 is [insert doc].
	FunctionRuntimeRust165 = FunctionRuntime("rust165")
	// FunctionRuntimeGo119 is [insert doc].
	FunctionRuntimeGo119 = FunctionRuntime("go119")
	// FunctionRuntimePython311 is [insert doc].
	FunctionRuntimePython311 = FunctionRuntime("python311")
	// FunctionRuntimePhp82 is [insert doc].
	FunctionRuntimePhp82 = FunctionRuntime("php82")
)
View Source
const (
	// FunctionStatusUnknown is [insert doc].
	FunctionStatusUnknown = FunctionStatus("unknown")
	// FunctionStatusReady is [insert doc].
	FunctionStatusReady = FunctionStatus("ready")
	// FunctionStatusDeleting is [insert doc].
	FunctionStatusDeleting = FunctionStatus("deleting")
	// FunctionStatusError is [insert doc].
	FunctionStatusError = FunctionStatus("error")
	// FunctionStatusLocked is [insert doc].
	FunctionStatusLocked = FunctionStatus("locked")
	// FunctionStatusCreating is [insert doc].
	FunctionStatusCreating = FunctionStatus("creating")
	// FunctionStatusPending is [insert doc].
	FunctionStatusPending = FunctionStatus("pending")
	// FunctionStatusCreated is [insert doc].
	FunctionStatusCreated = FunctionStatus("created")
)
View Source
const (
	// ListCronsRequestOrderByCreatedAtAsc is [insert doc].
	ListCronsRequestOrderByCreatedAtAsc = ListCronsRequestOrderBy("created_at_asc")
	// ListCronsRequestOrderByCreatedAtDesc is [insert doc].
	ListCronsRequestOrderByCreatedAtDesc = ListCronsRequestOrderBy("created_at_desc")
)
View Source
const (
	// ListDomainsRequestOrderByCreatedAtAsc is [insert doc].
	ListDomainsRequestOrderByCreatedAtAsc = ListDomainsRequestOrderBy("created_at_asc")
	// ListDomainsRequestOrderByCreatedAtDesc is [insert doc].
	ListDomainsRequestOrderByCreatedAtDesc = ListDomainsRequestOrderBy("created_at_desc")
	// ListDomainsRequestOrderByHostnameAsc is [insert doc].
	ListDomainsRequestOrderByHostnameAsc = ListDomainsRequestOrderBy("hostname_asc")
	// ListDomainsRequestOrderByHostnameDesc is [insert doc].
	ListDomainsRequestOrderByHostnameDesc = ListDomainsRequestOrderBy("hostname_desc")
)
View Source
const (
	// ListFunctionsRequestOrderByCreatedAtAsc is [insert doc].
	ListFunctionsRequestOrderByCreatedAtAsc = ListFunctionsRequestOrderBy("created_at_asc")
	// ListFunctionsRequestOrderByCreatedAtDesc is [insert doc].
	ListFunctionsRequestOrderByCreatedAtDesc = ListFunctionsRequestOrderBy("created_at_desc")
	// ListFunctionsRequestOrderByNameAsc is [insert doc].
	ListFunctionsRequestOrderByNameAsc = ListFunctionsRequestOrderBy("name_asc")
	// ListFunctionsRequestOrderByNameDesc is [insert doc].
	ListFunctionsRequestOrderByNameDesc = ListFunctionsRequestOrderBy("name_desc")
)
View Source
const (
	// ListLogsRequestOrderByTimestampDesc is [insert doc].
	ListLogsRequestOrderByTimestampDesc = ListLogsRequestOrderBy("timestamp_desc")
	// ListLogsRequestOrderByTimestampAsc is [insert doc].
	ListLogsRequestOrderByTimestampAsc = ListLogsRequestOrderBy("timestamp_asc")
)
View Source
const (
	// ListNamespacesRequestOrderByCreatedAtAsc is [insert doc].
	ListNamespacesRequestOrderByCreatedAtAsc = ListNamespacesRequestOrderBy("created_at_asc")
	// ListNamespacesRequestOrderByCreatedAtDesc is [insert doc].
	ListNamespacesRequestOrderByCreatedAtDesc = ListNamespacesRequestOrderBy("created_at_desc")
	// ListNamespacesRequestOrderByNameAsc is [insert doc].
	ListNamespacesRequestOrderByNameAsc = ListNamespacesRequestOrderBy("name_asc")
	// ListNamespacesRequestOrderByNameDesc is [insert doc].
	ListNamespacesRequestOrderByNameDesc = ListNamespacesRequestOrderBy("name_desc")
)
View Source
const (
	// ListTokensRequestOrderByCreatedAtAsc is [insert doc].
	ListTokensRequestOrderByCreatedAtAsc = ListTokensRequestOrderBy("created_at_asc")
	// ListTokensRequestOrderByCreatedAtDesc is [insert doc].
	ListTokensRequestOrderByCreatedAtDesc = ListTokensRequestOrderBy("created_at_desc")
)
View Source
const (
	// ListTriggerInputsRequestOrderByCreatedAtAsc is [insert doc].
	ListTriggerInputsRequestOrderByCreatedAtAsc = ListTriggerInputsRequestOrderBy("created_at_asc")
	// ListTriggerInputsRequestOrderByCreatedAtDesc is [insert doc].
	ListTriggerInputsRequestOrderByCreatedAtDesc = ListTriggerInputsRequestOrderBy("created_at_desc")
)
View Source
const (
	// ListTriggersRequestOrderByCreatedAtAsc is [insert doc].
	ListTriggersRequestOrderByCreatedAtAsc = ListTriggersRequestOrderBy("created_at_asc")
	// ListTriggersRequestOrderByCreatedAtDesc is [insert doc].
	ListTriggersRequestOrderByCreatedAtDesc = ListTriggersRequestOrderBy("created_at_desc")
)
View Source
const (
	// LogStreamUnknown is [insert doc].
	LogStreamUnknown = LogStream("unknown")
	// LogStreamStdout is [insert doc].
	LogStreamStdout = LogStream("stdout")
	// LogStreamStderr is [insert doc].
	LogStreamStderr = LogStream("stderr")
)
View Source
const (
	// NamespaceStatusUnknown is [insert doc].
	NamespaceStatusUnknown = NamespaceStatus("unknown")
	// NamespaceStatusReady is [insert doc].
	NamespaceStatusReady = NamespaceStatus("ready")
	// NamespaceStatusDeleting is [insert doc].
	NamespaceStatusDeleting = NamespaceStatus("deleting")
	// NamespaceStatusError is [insert doc].
	NamespaceStatusError = NamespaceStatus("error")
	// NamespaceStatusLocked is [insert doc].
	NamespaceStatusLocked = NamespaceStatus("locked")
	// NamespaceStatusCreating is [insert doc].
	NamespaceStatusCreating = NamespaceStatus("creating")
	// NamespaceStatusPending is [insert doc].
	NamespaceStatusPending = NamespaceStatus("pending")
)
View Source
const (
	// RuntimeStatusUnknownStatus is [insert doc].
	RuntimeStatusUnknownStatus = RuntimeStatus("unknown_status")
	// RuntimeStatusBeta is [insert doc].
	RuntimeStatusBeta = RuntimeStatus("beta")
	// RuntimeStatusAvailable is [insert doc].
	RuntimeStatusAvailable = RuntimeStatus("available")
	// RuntimeStatusDeprecated is [insert doc].
	RuntimeStatusDeprecated = RuntimeStatus("deprecated")
	// RuntimeStatusEndOfSupport is [insert doc].
	RuntimeStatusEndOfSupport = RuntimeStatus("end_of_support")
	// RuntimeStatusEndOfLife is [insert doc].
	RuntimeStatusEndOfLife = RuntimeStatus("end_of_life")
)
View Source
const (
	// TokenStatusUnknown is [insert doc].
	TokenStatusUnknown = TokenStatus("unknown")
	// TokenStatusReady is [insert doc].
	TokenStatusReady = TokenStatus("ready")
	// TokenStatusDeleting is [insert doc].
	TokenStatusDeleting = TokenStatus("deleting")
	// TokenStatusError is [insert doc].
	TokenStatusError = TokenStatus("error")
	// TokenStatusCreating is [insert doc].
	TokenStatusCreating = TokenStatus("creating")
)
View Source
const (
	// TriggerInputStatusUnknown is [insert doc].
	TriggerInputStatusUnknown = TriggerInputStatus("unknown")
	// TriggerInputStatusReady is [insert doc].
	TriggerInputStatusReady = TriggerInputStatus("ready")
	// TriggerInputStatusDeleting is [insert doc].
	TriggerInputStatusDeleting = TriggerInputStatus("deleting")
	// TriggerInputStatusError is [insert doc].
	TriggerInputStatusError = TriggerInputStatus("error")
	// TriggerInputStatusCreating is [insert doc].
	TriggerInputStatusCreating = TriggerInputStatus("creating")
	// TriggerInputStatusPending is [insert doc].
	TriggerInputStatusPending = TriggerInputStatus("pending")
)
View Source
const (
	// TriggerStatusUnknownStatus is [insert doc].
	TriggerStatusUnknownStatus = TriggerStatus("unknown_status")
	// TriggerStatusReady is [insert doc].
	TriggerStatusReady = TriggerStatus("ready")
	// TriggerStatusDeleting is [insert doc].
	TriggerStatusDeleting = TriggerStatus("deleting")
	// TriggerStatusError is [insert doc].
	TriggerStatusError = TriggerStatus("error")
	// TriggerStatusCreating is [insert doc].
	TriggerStatusCreating = TriggerStatus("creating")
	// TriggerStatusPending is [insert doc].
	TriggerStatusPending = TriggerStatus("pending")
)
View Source
const (
	// TriggerTypeUnknownTriggerType is [insert doc].
	TriggerTypeUnknownTriggerType = TriggerType("unknown_trigger_type")
	// TriggerTypeNats is [insert doc].
	TriggerTypeNats = TriggerType("nats")
	// TriggerTypeSqs is [insert doc].
	TriggerTypeSqs = TriggerType("sqs")
)
View Source
const (
	// NullValueNULLVALUE is [insert doc].
	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 NewAPI

func NewAPI(client *scw.Client) *API

NewAPI returns a API object from a Scaleway client.

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) CreateTriggerInput

func (s *API) CreateTriggerInput(req *CreateTriggerInputRequest, opts ...scw.RequestOption) (*TriggerInput, error)

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 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 a function

Delete the function associated with the given 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 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) DeleteTriggerInput

func (s *API) DeleteTriggerInput(req *DeleteTriggerInputRequest, opts ...scw.RequestOption) (*TriggerInput, error)

func (*API) DeployFunction

func (s *API) DeployFunction(req *DeployFunctionRequest, opts ...scw.RequestOption) (*Function, error)

DeployFunction: deploy a function

Deploy a function associated with the given 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 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 a function

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 of a function

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

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 a namespace

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) GetTriggerInput

func (s *API) GetTriggerInput(req *GetTriggerInputRequest, opts ...scw.RequestOption) (*TriggerInput, 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 function runtimes

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) ListTriggerInputs

func (s *API) ListTriggerInputs(req *ListTriggerInputsRequest, opts ...scw.RequestOption) (*ListTriggerInputsResponse, error)

func (*API) ListTriggers

func (s *API) ListTriggers(req *ListTriggersRequest, opts ...scw.RequestOption) (*ListTriggersResponse, error)

func (*API) Regions

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

Regions list localities the api is available in

func (*API) SetTriggerInputs

func (s *API) SetTriggerInputs(req *SetTriggerInputsRequest, opts ...scw.RequestOption) (*SetTriggerInputsResponse, error)

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 given id.

func (*API) UpdateFunction

func (s *API) UpdateFunction(req *UpdateFunctionRequest, opts ...scw.RequestOption) (*Function, error)

UpdateFunction: update an existing function

Update the function associated with the given 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 given id.

func (*API) UpdateTrigger

func (s *API) UpdateTrigger(req *UpdateTriggerRequest, opts ...scw.RequestOption) (*Trigger, error)

func (*API) UpdateTriggerInput

func (s *API) UpdateTriggerInput(req *UpdateTriggerInputRequest, opts ...scw.RequestOption) (*TriggerInput, 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 CreateCronRequest struct {
	// Region:
	//
	// Region to target. If none is passed will use default region from the config
	Region scw.Region `json:"-"`

	FunctionID string `json:"function_id"`

	Schedule string `json:"schedule"`

	Args *scw.JSONObject `json:"args"`

	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 string `json:"hostname"`

	FunctionID string `json:"function_id"`
}

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: configure how HTTP and HTTPS requests are handled
	//
	// possible values:
	//  - redirected: Responds to HTTP request with a 302 redirect to ask the clients to use HTTPS.
	//  - enabled: Serve both HTTP and HTTPS traffic.
	//
	// Default value: unknown_http_option
	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 CreateTriggerInputRequest

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

	TriggerID string `json:"trigger_id"`

	MnqNamespaceID *string `json:"mnq_namespace_id"`

	// Precisely one of NatsConfig, SqsConfig must be set.
	NatsConfig *CreateTriggerInputRequestNatsClientConfigSpec `json:"nats_config,omitempty"`

	// Precisely one of NatsConfig, SqsConfig must be set.
	SqsConfig *CreateTriggerInputRequestSqsClientConfigSpec `json:"sqs_config,omitempty"`
}

type CreateTriggerInputRequestNatsClientConfigSpec

type CreateTriggerInputRequestNatsClientConfigSpec struct {
	Subject string `json:"subject"`
}

type CreateTriggerInputRequestSqsClientConfigSpec

type CreateTriggerInputRequestSqsClientConfigSpec struct {
	Queue string `json:"queue"`
}

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"`
	// Type:
	//
	// Default value: unknown_trigger_type
	Type TriggerType `json:"type"`

	// Precisely one of NatsFailureHandlingPolicy, SqsFailureHandlingPolicy must be set.
	NatsFailureHandlingPolicy *CreateTriggerRequestNatsFailureHandlingPolicy `json:"nats_failure_handling_policy,omitempty"`

	// Precisely one of NatsFailureHandlingPolicy, SqsFailureHandlingPolicy must be set.
	SqsFailureHandlingPolicy *CreateTriggerRequestSqsFailureHandlingPolicy `json:"sqs_failure_handling_policy,omitempty"`
}

type CreateTriggerRequestNatsFailureHandlingPolicy

type CreateTriggerRequestNatsFailureHandlingPolicy struct {
	RetryPolicy *CreateTriggerRequestNatsFailureHandlingPolicyRetryPolicy `json:"retry_policy"`

	// Precisely one of NatsDeadLetter, SqsDeadLetter must be set.
	NatsDeadLetter *CreateTriggerRequestNatsFailureHandlingPolicyNatsDeadLetter `json:"nats_dead_letter,omitempty"`

	// Precisely one of NatsDeadLetter, SqsDeadLetter must be set.
	SqsDeadLetter *CreateTriggerRequestNatsFailureHandlingPolicySqsDeadLetter `json:"sqs_dead_letter,omitempty"`
}

type CreateTriggerRequestNatsFailureHandlingPolicyNatsDeadLetter

type CreateTriggerRequestNatsFailureHandlingPolicyNatsDeadLetter struct {
	MnqNamespaceID *string `json:"mnq_namespace_id"`

	Subject *string `json:"subject"`
}

type CreateTriggerRequestNatsFailureHandlingPolicyRetryPolicy

type CreateTriggerRequestNatsFailureHandlingPolicyRetryPolicy struct {
	MaxRetries *uint32 `json:"max_retries"`

	RetryPeriod *scw.Duration `json:"retry_period"`
}

type CreateTriggerRequestNatsFailureHandlingPolicySqsDeadLetter

type CreateTriggerRequestNatsFailureHandlingPolicySqsDeadLetter struct {
	MnqNamespaceID *string `json:"mnq_namespace_id"`

	Queue *string `json:"queue"`
}

type CreateTriggerRequestSqsFailureHandlingPolicy

type CreateTriggerRequestSqsFailureHandlingPolicy struct {
}

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 DeleteCronRequest struct {
	// Region:
	//
	// Region to target. If none is passed will use default region from the config
	Region scw.Region `json:"-"`

	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 string `json:"-"`
}

type DeleteFunctionRequest

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

	FunctionID 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 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 string `json:"-"`
}

type DeleteTriggerInputRequest

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

	TriggerInputID string `json:"-"`
}

type DeleteTriggerRequest

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

	TriggerID string `json:"-"`
}

type DeployFunctionRequest

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

	FunctionID string `json:"-"`
}

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 DownloadURL struct {
	URL string `json:"url"`

	Headers map[string]*[]string `json:"headers"`
}

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: configure how HTTP and HTTPS requests are handled
	//
	// possible values:
	//  - redirected: Responds to HTTP request with a 302 redirect to ask the clients to use HTTPS.
	//  - enabled: Serve both HTTP and HTTPS traffic.
	//
	// Default value: unknown_http_option
	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 GetCronRequest struct {
	// Region:
	//
	// Region to target. If none is passed will use default region from the config
	Region scw.Region `json:"-"`

	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 string `json:"-"`
}

type GetFunctionDownloadURLRequest

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

	FunctionID string `json:"-"`
}

type GetFunctionRequest

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

	FunctionID string `json:"-"`
}

type GetFunctionUploadURLRequest

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

	FunctionID string `json:"-"`

	ContentLength uint64 `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 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 string `json:"-"`
}

type GetTriggerInputRequest

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

	TriggerInputID string `json:"-"`
}

type GetTriggerRequest

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

	TriggerID 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:"-"`

	FunctionID *string `json:"-"`

	NamespaceID *string `json:"-"`

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

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 ListFunctionRuntimesRequest

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

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

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 *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 ListTriggerInputsRequest

type ListTriggerInputsRequest 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 ListTriggerInputsRequestOrderBy `json:"-"`

	TriggerID string `json:"-"`
}

type ListTriggerInputsRequestOrderBy

type ListTriggerInputsRequestOrderBy string

func (ListTriggerInputsRequestOrderBy) MarshalJSON

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

func (ListTriggerInputsRequestOrderBy) String

func (*ListTriggerInputsRequestOrderBy) UnmarshalJSON

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

type ListTriggerInputsResponse

type ListTriggerInputsResponse struct {
	Inputs []*TriggerInput `json:"inputs"`

	TotalCount uint32 `json:"total_count"`
}

func (*ListTriggerInputsResponse) UnsafeAppend

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

UnsafeAppend should not be used Internal usage only

func (*ListTriggerInputsResponse) UnsafeGetTotalCount

func (r *ListTriggerInputsResponse) 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:"-"`
}

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 (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 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 (enum NullValue) MarshalJSON() ([]byte, error)

func (NullValue) String

func (enum NullValue) String() string

func (*NullValue) UnmarshalJSON

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

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 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 SetTriggerInputsRequest

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

	TriggerInputID string `json:"trigger_input_id"`

	// Precisely one of Nats, Sqs must be set.
	Sqs *SetTriggerInputsRequestSqsConfigs `json:"sqs,omitempty"`

	// Precisely one of Nats, Sqs must be set.
	Nats *SetTriggerInputsRequestNatsConfigs `json:"nats,omitempty"`
}

type SetTriggerInputsRequestNatsConfigs

type SetTriggerInputsRequestNatsConfigs struct {
	Configs []*CreateTriggerInputRequestNatsClientConfigSpec `json:"configs"`
}

type SetTriggerInputsRequestSqsConfigs

type SetTriggerInputsRequestSqsConfigs struct {
	Configs []*CreateTriggerInputRequestSqsClientConfigSpec `json:"configs"`
}

type SetTriggerInputsResponse

type SetTriggerInputsResponse struct {
	TriggerInputs []*TriggerInput `json:"trigger_inputs"`
}

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"`
	// Type:
	//
	// Default value: unknown_trigger_type
	Type TriggerType `json:"type"`
	// Status:
	//
	// Default value: unknown_status
	Status TriggerStatus `json:"status"`

	ErrorMessage *string `json:"error_message"`

	FunctionID string `json:"function_id"`

	// Precisely one of NatsFailureHandlingPolicy, SqsFailureHandlingPolicy must be set.
	NatsFailureHandlingPolicy *TriggerNatsFailureHandlingPolicy `json:"nats_failure_handling_policy,omitempty"`

	// Precisely one of NatsFailureHandlingPolicy, SqsFailureHandlingPolicy must be set.
	SqsFailureHandlingPolicy *TriggerSqsFailureHandlingPolicy `json:"sqs_failure_handling_policy,omitempty"`
}

type TriggerInput

type TriggerInput struct {
	ID string `json:"id"`

	MnqNamespaceID *string `json:"mnq_namespace_id"`
	// Status:
	//
	// Default value: unknown
	Status TriggerInputStatus `json:"status"`

	ErrorMessage *string `json:"error_message"`

	// Precisely one of NatsConfig, SqsConfig must be set.
	NatsConfig *TriggerInputNatsClientConfig `json:"nats_config,omitempty"`

	// Precisely one of NatsConfig, SqsConfig must be set.
	SqsConfig *TriggerInputSqsClientConfig `json:"sqs_config,omitempty"`
}

type TriggerInputNatsClientConfig

type TriggerInputNatsClientConfig struct {
	Subject string `json:"subject"`
}

type TriggerInputSqsClientConfig

type TriggerInputSqsClientConfig struct {
	Queue string `json:"queue"`
}

type TriggerInputStatus

type TriggerInputStatus string

func (TriggerInputStatus) MarshalJSON

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

func (TriggerInputStatus) String

func (enum TriggerInputStatus) String() string

func (*TriggerInputStatus) UnmarshalJSON

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

type TriggerNatsDeadLetter

type TriggerNatsDeadLetter struct {
	MnqNamespaceID string `json:"mnq_namespace_id"`

	Subject string `json:"subject"`
}

type TriggerNatsFailureHandlingPolicy

type TriggerNatsFailureHandlingPolicy struct {
	RetryPolicy *TriggerRetryPolicy `json:"retry_policy"`

	// Precisely one of NatsDeadLetter, SqsDeadLetter must be set.
	NatsDeadLetter *TriggerNatsDeadLetter `json:"nats_dead_letter,omitempty"`

	// Precisely one of NatsDeadLetter, SqsDeadLetter must be set.
	SqsDeadLetter *TriggerSqsDeadLetter `json:"sqs_dead_letter,omitempty"`
}

type TriggerRetryPolicy

type TriggerRetryPolicy struct {
	MaxRetries uint32 `json:"max_retries"`

	RetryPeriod *scw.Duration `json:"retry_period"`
}

type TriggerSqsDeadLetter

type TriggerSqsDeadLetter struct {
	MnqNamespaceID string `json:"mnq_namespace_id"`

	Queue string `json:"queue"`
}

type TriggerSqsFailureHandlingPolicy

type TriggerSqsFailureHandlingPolicy struct {
}

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 TriggerType

type TriggerType string

func (TriggerType) MarshalJSON

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

func (TriggerType) String

func (enum TriggerType) String() string

func (*TriggerType) UnmarshalJSON

func (enum *TriggerType) 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: configure how HTTP and HTTPS requests are handled
	//
	// possible values:
	//  - redirected: Responds to HTTP request with a 302 redirect to ask the clients to use HTTPS.
	//  - enabled: Serve both HTTP and HTTPS traffic.
	//
	// Default value: unknown_http_option
	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 UpdateTriggerInputRequest

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

	TriggerInputID string `json:"-"`

	// Precisely one of NatsConfig, SqsConfig must be set.
	NatsConfig *UpdateTriggerInputRequestNatsClientConfigSpec `json:"nats_config,omitempty"`

	// Precisely one of NatsConfig, SqsConfig must be set.
	SqsConfig *UpdateTriggerInputRequestSqsClientConfigSpec `json:"sqs_config,omitempty"`
}

type UpdateTriggerInputRequestNatsClientConfigSpec

type UpdateTriggerInputRequestNatsClientConfigSpec struct {
	Subject *string `json:"subject"`
}

type UpdateTriggerInputRequestSqsClientConfigSpec

type UpdateTriggerInputRequestSqsClientConfigSpec struct {
	Queue *string `json:"queue"`
}

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 NatsConfig, SqsConfig must be set.
	NatsConfig *CreateTriggerRequestNatsFailureHandlingPolicy `json:"nats_config,omitempty"`

	// Precisely one of NatsConfig, SqsConfig must be set.
	SqsConfig *CreateTriggerRequestSqsFailureHandlingPolicy `json:"sqs_config,omitempty"`
}

type UploadURL

type UploadURL struct {
	URL string `json:"url"`

	Headers map[string]*[]string `json:"headers"`
}

UploadURL: upload url

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 WaitForFunctionRequest

type WaitForFunctionRequest struct {
	FunctionID    string
	Region        scw.Region
	Timeout       *time.Duration
	RetryInterval *time.Duration
}

WaitForFunctionRequest is used by WaitForNamespace method.

type WaitForNamespaceRequest

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

WaitForNamespaceRequest is used by WaitForNamespace method.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL