Documentation
¶
Index ¶
- type AccessKeyAttributes
- type AffectedResource
- type AppServicesManifest
- type AppServicesManifestAttributes
- type Classification
- type ClusterConfigurationReloadAttributes
- type ClusterInfoAttributes
- type ClusterInfoEndpointAddress
- type ClusterInfoEndpoints
- type ContainerAttributes
- type ControlPlaneInput
- type ControlPlaneOutput
- type CreateAccessKeyInput
- type CreateAccessKeyOutput
- type CreateContainerInput
- type CreateContainerOutput
- type CreateEventInput
- type CreateUserInput
- type CreateUserOutput
- type DeleteAccessKeyInput
- type DeleteContainerInput
- type DeleteUserInput
- type EventAttributes
- type GetAppServicesManifestsInput
- type GetAppServicesManifestsOutput
- type GetJobInput
- type GetJobOutput
- type GetRunningUserAttributesInput
- type GetRunningUserAttributesOutput
- type JobAttributes
- type JobOutput
- type JobState
- type JobWebHook
- type Kind
- type NewSessionInput
- type ParameterText
- type ParameterUint64
- type Plane
- type ReloadAppServicesConfigJobOutput
- type ReloadClusterConfigOutput
- type ReloadConfigInput
- type Session
- type SessionAttributes
- type Severity
- type UpdateAppServicesManifestInput
- type UpdateClusterInfoInput
- type UpdateClusterInfoOutput
- type UserAttributes
- type Visibility
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AccessKeyAttributes ¶
type AccessKeyAttributes struct {
TTL int `json:"ttl,omitempty"`
CreatedAt string `json:"created_at,omitempty"`
UpdatedAt string `json:"updated_at,omitempty"`
ExpiresAt int `json:"expires_at,omitempty"`
GroupIds []string `json:"group_ids,omitempty"`
UID int `json:"uid,omitempty"`
GIDs []int `json:"gids,omitempty"`
TenantID string `json:"tenant_id,omitempty"`
Kind string `json:"kind,omitempty"`
Plane Plane `json:"plane,omitempty"`
InterfaceKind string `json:"interface_kind,omitempty"`
Label string `json:"label,omitempty"`
}
AccessKeyAttributes holds info about a access key
type AffectedResource ¶
type AppServicesManifest ¶
type AppServicesManifest struct {
Type string `json:"type,omitempty"`
ID int `json:"id,omitempty"`
Attributes AppServicesManifestAttributes `json:"attributes,omitempty"`
}
type AppServicesManifestAttributes ¶
type AppServicesManifestAttributes struct {
AppServices interface{} `json:"app_services,omitempty"`
ClusterName string `json:"cluster_name,omitempty"`
LastModificationJob string `json:"last_modification_job,omitempty"`
RunningModificationJob string `json:"running_modification_job,omitempty"`
State string `json:"state,omitempty"`
TenantID string `json:"tenant_id,omitempty"`
TenantName string `json:"tenant_name,omitempty"`
}
type Classification ¶
type Classification string
const ( UnknownClassification Classification = "unknown" HwClassification Classification = "hw" UaClassification Classification = "ua" BgClassification Classification = "bg" SwClassification Classification = "sw" SLAClassification Classification = "sla" CapClassification Classification = "cap" SecClassification Classification = "sec" AuditClassification Classification = "audit" SystemClassification Classification = "system" )
type ClusterConfigurationReloadAttributes ¶
type ClusterConfigurationReloadAttributes struct {
JobID string `json:"job_id,omitempty"`
}
type ClusterInfoAttributes ¶
type ClusterInfoAttributes struct {
Endpoints ClusterInfoEndpoints `json:"endpoints,omitempty"`
}
type ClusterInfoEndpointAddress ¶
type ClusterInfoEndpointAddress struct {
ServiceID string `json:"service_id,omitempty"`
DisplayName string `json:"display_name,omitempty"`
Description string `json:"description,omitempty"`
Version string `json:"version,omitempty"`
Urls []string `json:"urls,omitempty"`
APIUrls []string `json:"api_urls,omitempty"`
}
type ClusterInfoEndpoints ¶
type ClusterInfoEndpoints struct {
AppServices []ClusterInfoEndpointAddress `json:"app_services,omitempty"`
}
type ContainerAttributes ¶
type ContainerAttributes struct {
Name string `json:"name,omitempty"`
}
type ControlPlaneInput ¶
type ControlPlaneOutput ¶
type CreateAccessKeyInput ¶
type CreateAccessKeyInput struct {
ControlPlaneInput
AccessKeyAttributes
}
CreateAccessKeyInput specifies how to create an access key
type CreateAccessKeyOutput ¶
type CreateAccessKeyOutput struct {
ControlPlaneOutput
AccessKeyAttributes
}
CreateAccessKeyOutput holds the response from creating an access key
type CreateContainerInput ¶
type CreateContainerInput struct {
ControlPlaneInput
ContainerAttributes
}
CreateContainerInput specifies how to create a container
type CreateContainerOutput ¶
type CreateContainerOutput struct {
ControlPlaneOutput
ContainerAttributes
}
CreateContainerOutput holds the response from creating a container
type CreateEventInput ¶
type CreateEventInput struct {
ControlPlaneInput
EventAttributes
}
CreateEventInput specifies how to create an event
type CreateUserInput ¶
type CreateUserInput struct {
ControlPlaneInput
UserAttributes
}
CreateUserInput specifies how to create a user
type CreateUserOutput ¶
type CreateUserOutput struct {
ControlPlaneOutput
UserAttributes
}
CreateUserOutput holds the response from creating a user
type DeleteAccessKeyInput ¶
type DeleteAccessKeyInput struct {
ControlPlaneInput
}
DeleteAccessKeyInput specifies how to delete an access key
type DeleteContainerInput ¶
type DeleteContainerInput struct {
ControlPlaneInput
}
DeleteContainerInput specifies how to delete a container
type DeleteUserInput ¶
type DeleteUserInput struct {
ControlPlaneInput
}
DeleteUserInput specifies how to delete a user
type EventAttributes ¶
type EventAttributes struct {
SystemEvent bool `json:"system_event,omitempty"`
Source string `json:"source,omitempty"`
Kind string `json:"kind,omitempty"`
Description string `json:"description,omitempty"`
Severity Severity `json:"severity,omitempty"`
Tags []string `json:"tags,omitempty"`
Visibility Visibility `json:"visibility,omitempty"`
Classification Classification `json:"classification,omitempty"`
TimestampUint64 uint64 `json:"timestamp_uint64,omitempty"`
TimestampIso8601 string `json:"timestamp_iso8601,omitempty"`
ParametersUint64 []ParameterUint64 `json:"parameters_uint64,omitempty"`
ParametersText []ParameterText `json:"parameters_text,omitempty"`
InvokingUserID string `json:"invoking_user_id,omitempty"`
AuditTenant string `json:"audit_tenant,omitempty"`
}
type GetAppServicesManifestsInput ¶
type GetAppServicesManifestsInput struct {
ControlPlaneInput
}
GetAppServicesManifestsInput specifies how to get a app services manifests
type GetAppServicesManifestsOutput ¶
type GetAppServicesManifestsOutput struct {
ControlPlaneOutput
AppServicesManifests []AppServicesManifest
}
GetAppServicesManifestsOutput holds the response from get app services manifests
type GetJobInput ¶
type GetJobInput struct {
ControlPlaneInput
}
GetJobInput specifies how to get a job
type GetJobOutput ¶
type GetJobOutput struct {
ControlPlaneOutput
JobAttributes
}
GetJobOutput specifies holds the response from get jobs
type GetRunningUserAttributesInput ¶
type GetRunningUserAttributesInput struct {
ControlPlaneInput
}
GetRunningUserAttributesInput specifies what access key
type GetRunningUserAttributesOutput ¶
type GetRunningUserAttributesOutput struct {
ControlPlaneOutput
UserAttributes
}
GetRunningUserAttributesOutput holds the response from get user's attributes
type JobAttributes ¶
type JobAttributes struct {
Kind string `json:"kind,omitempty"`
Params string `json:"params,omitempty"`
UIFields string `json:"ui_fields,omitempty"`
MaxTotalExecutionTime int `json:"max_total_execution_time,omitempty"`
MaxWorkerExecutionTime int `json:"max_worker_execution_time,omitempty"`
Delay float64 `json:"delay,omitempty"`
State JobState `json:"state,omitempty"`
Result string `json:"result,omitempty"`
CreatedAt string `json:"created_at,omitempty"`
OnSuccess []JobWebHook `json:"on_success,omitempty"`
OnFailure []JobWebHook `json:"on_failure,omitempty"`
LinkedResources string `json:"linked_resources,omitempty"`
UpdatedAt string `json:"updated_at,omitempty"`
Handler string `json:"handler,omitempty"`
}
type JobOutput ¶
type JobOutput struct {
ControlPlaneOutput
JobAttributes
}
JobOutput holds the response from creating a job
type JobWebHook ¶
type NewSessionInput ¶
type NewSessionInput struct {
ControlPlaneInput
Endpoints []string
AccessKey string
SessionAttributes
}
NewSessionInput specifies how to create a session
type ParameterText ¶
type ParameterUint64 ¶
type ReloadAppServicesConfigJobOutput ¶
type ReloadAppServicesConfigJobOutput struct {
ControlPlaneOutput
JobAttributes
}
ReloadAppServicesConfigJobOutput specifies holds the response from reload app services config
type ReloadClusterConfigOutput ¶
type ReloadClusterConfigOutput struct {
ControlPlaneOutput
ClusterConfigurationReloadAttributes
}
ReloadClusterConfigOutput holds the output for reloading a cluster configuration
type ReloadConfigInput ¶
type ReloadConfigInput struct {
ControlPlaneInput
}
ReloadConfigInput holds the input for reloading a configuration
type Session ¶
type Session interface {
// CreateUserSync creates a user (blocking)
CreateUserSync(*CreateUserInput) (*CreateUserOutput, error)
// DeleteUserSync deletes a user (blocking)
DeleteUserSync(*DeleteUserInput) error
// CreateContainerSync creates a container (blocking)
CreateContainerSync(*CreateContainerInput) (*CreateContainerOutput, error)
// DeleteContainerSync deletes a user (blocking)
DeleteContainerSync(*DeleteContainerInput) error
// UpdateClusterInfoSync updates a cluster info record (blocking)
UpdateClusterInfoSync(*UpdateClusterInfoInput) (*UpdateClusterInfoOutput, error)
// CreateEventSync emits new event (blocking)
CreateEventSync(*CreateEventInput) error
// CreateAccessKeySync creates an access key (blocking)
CreateAccessKeySync(*CreateAccessKeyInput) (*CreateAccessKeyOutput, error)
// DeleteAccessKeySync deletes an access key (blocking)
DeleteAccessKeySync(*DeleteAccessKeyInput) error
// GetRunningUserAttributesSync returns user's attributes related to session's access key (blocking)
GetRunningUserAttributesSync(*GetRunningUserAttributesInput) (*GetRunningUserAttributesOutput, error)
// ReloadClusterConfig reloads the platform cluster configuration (blocking)
ReloadClusterConfig(ctx context.Context) (string, error)
// ReloadEventsConfig reloads the platform events configuration (blocking)
ReloadEventsConfig(ctx context.Context) (string, error)
// ReloadAppServicesConfig reloads the platform app services configuration (blocking)
ReloadAppServicesConfig(ctx context.Context) (string, error)
// ReloadArtifactVersionManifest reloads the platform artifact version manifest configuration (blocking)
ReloadArtifactVersionManifest(ctx context.Context) (string, error)
// ReloadClusterConfigAndWaitForCompletion reloads the platform cluster configuration and waits for completion (blocking)
ReloadClusterConfigAndWaitForCompletion(ctx context.Context, retryInterval, timeout time.Duration) error
// ReloadEventsConfigAndWaitForCompletion reloads the platform events configuration and waits for completion (blocking)
ReloadEventsConfigAndWaitForCompletion(ctx context.Context, retryInterval, timeout time.Duration) error
// ReloadAppServicesConfigAndWaitForCompletion reloads the platform app services configuration and waits for completion (blocking)
ReloadAppServicesConfigAndWaitForCompletion(ctx context.Context, retryInterval, timeout time.Duration) error
// ReloadArtifactVersionManifestAndWaitForCompletion reloads the platform artifact version manifest and waits for completion (blocking)
ReloadArtifactVersionManifestAndWaitForCompletion(ctx context.Context, retryInterval, timeout time.Duration) error
// UpdateAppServicesManifest updates app services manifests of tenant related to session's access key
UpdateAppServicesManifest(*UpdateAppServicesManifestInput) (*GetJobOutput, error)
// GetAppServicesManifests returns app services manifests of tenant related to session's access key
GetAppServicesManifests(*GetAppServicesManifestsInput) (*GetAppServicesManifestsOutput, error)
// WaitForJobCompletion waits for completion of a job with a given id (blocking)
WaitForJobCompletion(ctx context.Context, jobID string, retryInterval, timeout time.Duration) error
// GetJob gets a job (blocking)
GetJob(getJobsInput *GetJobInput) (*GetJobOutput, error)
}
Session allows operations over a controlplane session
type SessionAttributes ¶
type UpdateAppServicesManifestInput ¶
type UpdateAppServicesManifestInput struct {
ControlPlaneInput
AppServicesManifestAttributes
}
UpdateAppServicesManifestInput specifies how to get a app services manifests
type UpdateClusterInfoInput ¶
type UpdateClusterInfoInput struct {
ControlPlaneInput
ClusterInfoAttributes
}
UpdateClusterInfoInput specifies how to update a cluster info record
type UpdateClusterInfoOutput ¶
type UpdateClusterInfoOutput struct {
ControlPlaneOutput
ClusterInfoAttributes
}
UpdateClusterInfoOutput holds the response from updating a cluster info
type UserAttributes ¶
type UserAttributes struct {
AssignedPolicies []string `json:"assigned_policies,omitempty"`
AuthenticationScheme string `json:"authentication_scheme,omitempty"`
CreatedAt string `json:"created_at,omitempty"`
DataAccessMode string `json:"data_access_mode,omitempty"`
Department string `json:"department,omitempty"`
Description string `json:"description,omitempty"`
Email string `json:"email,omitempty"`
Enabled bool `json:"enabled,omitempty"`
FirstName string `json:"first_name,omitempty"`
JobTitle string `json:"job_title,omitempty"`
LastName string `json:"last_name,omitempty"`
PasswordChangedAt string `json:"password_changed_at,omitempty"`
PhoneNumber string `json:"phone_number,omitempty"`
SendPasswordOnCreation bool `json:"send_password_on_creation,omitempty"`
UID int `json:"uid,omitempty"`
UpdatedAt string `json:"updated_at,omitempty"`
Username string `json:"username,omitempty"`
Password string `json:"password,omitempty"`
}
type Visibility ¶
type Visibility string
const ( UnknownVisibility Visibility = "unknown" InternalVisibility Visibility = "internal" ExternalVisibility Visibility = "external" CustomerOnlyVisibility Visibility = "customerOnly" )