Documentation
¶
Index ¶
- func CacheExpires(r *http.Response) time.Time
- func IsNil(i interface{}) bool
- func NewConfiguration() *config.Configuration
- func ParameterValueToString(obj interface{}, key string) string
- func PtrBool(v bool) *bool
- func PtrFloat32(v float32) *float32
- func PtrFloat64(v float64) *float64
- func PtrInt(v int) *int
- func PtrInt32(v int32) *int32
- func PtrInt64(v int64) *int64
- func PtrString(v string) *string
- func PtrTime(v time.Time) *time.Time
- type APIClient
- func (a *APIClient) CreateBackup(ctx context.Context, instanceId string, projectId string) ApiCreateBackupRequest
- func (a *APIClient) CreateBackupExecute(ctx context.Context, instanceId string, projectId string) ([]CreateBackupResponseItem, error)
- func (a *APIClient) CreateCredentials(ctx context.Context, projectId string, instanceId string) ApiCreateCredentialsRequest
- func (a *APIClient) CreateCredentialsExecute(ctx context.Context, projectId string, instanceId string) (*CredentialsResponse, error)
- func (a *APIClient) CreateInstance(ctx context.Context, projectId string) ApiCreateInstanceRequest
- func (a *APIClient) CreateInstanceExecute(ctx context.Context, projectId string) (*CreateInstanceResponse, error)
- func (a *APIClient) DeleteCredentials(ctx context.Context, projectId string, instanceId string, credentialsId string) ApiDeleteCredentialsRequest
- func (a *APIClient) DeleteCredentialsExecute(ctx context.Context, projectId string, instanceId string, credentialsId string) error
- func (a *APIClient) DeleteInstance(ctx context.Context, projectId string, instanceId string) ApiDeleteInstanceRequest
- func (a *APIClient) DeleteInstanceExecute(ctx context.Context, projectId string, instanceId string) error
- func (a *APIClient) DownloadBackup(ctx context.Context, backupId int32, instanceId string, projectId string) ApiDownloadBackupRequest
- func (a *APIClient) DownloadBackupExecute(ctx context.Context, backupId int32, instanceId string, projectId string) (*os.File, error)
- func (c *APIClient) GetConfig() *config.Configuration
- func (a *APIClient) GetCredentials(ctx context.Context, projectId string, instanceId string, credentialsId string) ApiGetCredentialsRequest
- func (a *APIClient) GetCredentialsExecute(ctx context.Context, projectId string, instanceId string, credentialsId string) (*CredentialsResponse, error)
- func (a *APIClient) GetInstance(ctx context.Context, projectId string, instanceId string) ApiGetInstanceRequest
- func (a *APIClient) GetInstanceExecute(ctx context.Context, projectId string, instanceId string) (*Instance, error)
- func (a *APIClient) GetMetrics(ctx context.Context, instanceId string, projectId string) ApiGetMetricsRequest
- func (a *APIClient) GetMetricsExecute(ctx context.Context, instanceId string, projectId string) (*GetMetricsResponse, error)
- func (a *APIClient) ListBackups(ctx context.Context, instanceId string, projectId string) ApiListBackupsRequest
- func (a *APIClient) ListBackupsExecute(ctx context.Context, instanceId string, projectId string) (*ListBackupsResponse, error)
- func (a *APIClient) ListCredentials(ctx context.Context, projectId string, instanceId string) ApiListCredentialsRequest
- func (a *APIClient) ListCredentialsExecute(ctx context.Context, projectId string, instanceId string) (*ListCredentialsResponse, error)
- func (a *APIClient) ListInstances(ctx context.Context, projectId string) ApiListInstancesRequest
- func (a *APIClient) ListInstancesExecute(ctx context.Context, projectId string) (*ListInstancesResponse, error)
- func (a *APIClient) ListOfferings(ctx context.Context, projectId string) ApiListOfferingsRequest
- func (a *APIClient) ListOfferingsExecute(ctx context.Context, projectId string) (*ListOfferingsResponse, error)
- func (a *APIClient) ListRestores(ctx context.Context, instanceId string, projectId string) ApiListRestoresRequest
- func (a *APIClient) ListRestoresExecute(ctx context.Context, instanceId string, projectId string) (*ListRestoresResponse, error)
- func (a *APIClient) PartialUpdateInstance(ctx context.Context, projectId string, instanceId string) ApiPartialUpdateInstanceRequest
- func (a *APIClient) PartialUpdateInstanceExecute(ctx context.Context, projectId string, instanceId string) error
- func (a *APIClient) TriggerRecreate(ctx context.Context, instanceId string, projectId string) ApiTriggerRecreateRequest
- func (a *APIClient) TriggerRecreateExecute(ctx context.Context, instanceId string, projectId string) (*CreateInstanceResponse, error)
- func (a *APIClient) TriggerRestart(ctx context.Context, instanceId string, projectId string) ApiTriggerRestartRequest
- func (a *APIClient) TriggerRestartExecute(ctx context.Context, instanceId string, projectId string) (*CreateInstanceResponse, error)
- func (a *APIClient) TriggerRestore(ctx context.Context, instanceId string, projectId string, backupId int32) ApiTriggerRestoreRequest
- func (a *APIClient) TriggerRestoreExecute(ctx context.Context, instanceId string, projectId string, backupId int32) (*TriggerRestoreResponse, error)
- func (a *APIClient) UpdateBackupsConfig(ctx context.Context, instanceId string, projectId string) ApiUpdateBackupsConfigRequest
- func (a *APIClient) UpdateBackupsConfigExecute(ctx context.Context, instanceId string, projectId string) (*UpdateBackupsConfigResponse, error)
- type ApiCreateBackupRequest
- type ApiCreateCredentialsRequest
- type ApiCreateInstanceRequest
- type ApiDeleteCredentialsRequest
- type ApiDeleteInstanceRequest
- type ApiDownloadBackupRequest
- type ApiGetCredentialsRequest
- type ApiGetInstanceRequest
- type ApiGetMetricsRequest
- type ApiListBackupsRequest
- type ApiListCredentialsRequest
- type ApiListInstancesRequest
- type ApiListOfferingsRequest
- type ApiListRestoresRequest
- type ApiPartialUpdateInstanceRequest
- type ApiTriggerRecreateRequest
- type ApiTriggerRestartRequest
- type ApiTriggerRestoreRequest
- type ApiUpdateBackupsConfigRequest
- type Backup
- type CreateBackupResponseItem
- type CreateInstancePayload
- type CreateInstanceResponse
- type Credentials
- type CredentialsListItem
- type CredentialsResponse
- type DefaultApiService
- type Error
- type GetMetricsResponse
- type Instance
- type InstanceLastOperation
- type InstanceParameters
- type InstanceSchema
- type ListBackupsResponse
- type ListCredentialsResponse
- type ListInstancesResponse
- type ListOfferingsResponse
- type ListRestoresResponse
- type MappedNullable
- type NullableBool
- type NullableFloat32
- type NullableFloat64
- type NullableInt
- type NullableInt32
- type NullableInt64
- type NullableString
- type NullableTime
- type Offering
- type PartialUpdateInstancePayload
- type Plan
- type RawCredentials
- type Restore
- type Schema
- type TriggerRestoreResponse
- type UpdateBackupsConfigPayload
- type UpdateBackupsConfigResponse
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CacheExpires ¶
CacheExpires helper function to determine remaining time before repeating a request.
func NewConfiguration ¶
func NewConfiguration() *config.Configuration
NewConfiguration returns a new Configuration object
func ParameterValueToString ¶
func PtrFloat32 ¶
PtrFloat32 is a helper routine that returns a pointer to given float value.
func PtrFloat64 ¶
PtrFloat64 is a helper routine that returns a pointer to given float value.
Types ¶
type APIClient ¶
type APIClient struct {
// contains filtered or unexported fields
}
APIClient manages communication with the STACKIT Redis API API v1.1.0 In most cases there should be only one, shared, APIClient.
func NewAPIClient ¶
func NewAPIClient(opts ...config.ConfigurationOption) (*APIClient, error)
NewAPIClient creates a new API client. Optionally receives configuration options
func (*APIClient) CreateBackup ¶ added in v0.17.0
func (a *APIClient) CreateBackup(ctx context.Context, instanceId string, projectId string) ApiCreateBackupRequest
CreateBackup: create a backup
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @param instanceId Instance id @param projectId Project id on which user has permissions @return ApiCreateBackupRequest
func (*APIClient) CreateBackupExecute ¶ added in v0.17.0
func (*APIClient) CreateCredentials ¶
func (a *APIClient) CreateCredentials(ctx context.Context, projectId string, instanceId string) ApiCreateCredentialsRequest
CreateCredentials: create new credentials
Create new service credentials
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @param projectId @param instanceId Instance id @return ApiCreateCredentialsRequest
func (*APIClient) CreateCredentialsExecute ¶
func (*APIClient) CreateInstance ¶
func (a *APIClient) CreateInstance(ctx context.Context, projectId string) ApiCreateInstanceRequest
CreateInstance: provision
Provision a service instance.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @param projectId @return ApiCreateInstanceRequest
func (*APIClient) CreateInstanceExecute ¶
func (*APIClient) DeleteCredentials ¶
func (a *APIClient) DeleteCredentials(ctx context.Context, projectId string, instanceId string, credentialsId string) ApiDeleteCredentialsRequest
DeleteCredentials: delete credentials by id
Delete a service credentials.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @param projectId @param instanceId Instance id @param credentialsId Id of the credentials being deleted @return ApiDeleteCredentialsRequest
func (*APIClient) DeleteCredentialsExecute ¶
func (*APIClient) DeleteInstance ¶
func (a *APIClient) DeleteInstance(ctx context.Context, projectId string, instanceId string) ApiDeleteInstanceRequest
DeleteInstance: delete service instance
Deprovision a service instance.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @param projectId @param instanceId Id of instance being deleted @return ApiDeleteInstanceRequest
func (*APIClient) DeleteInstanceExecute ¶
func (*APIClient) DownloadBackup ¶ added in v0.17.0
func (a *APIClient) DownloadBackup(ctx context.Context, backupId int32, instanceId string, projectId string) ApiDownloadBackupRequest
DownloadBackup: download backup
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @param backupId Backup id @param instanceId Instance id @param projectId Project id on which user has permissions @return ApiDownloadBackupRequest
func (*APIClient) DownloadBackupExecute ¶ added in v0.17.0
func (*APIClient) GetConfig ¶
func (c *APIClient) GetConfig() *config.Configuration
Allow modification of underlying config for alternate implementations and testing Caution: modifying the configuration while live can cause data races and potentially unwanted behavior
func (*APIClient) GetCredentials ¶
func (a *APIClient) GetCredentials(ctx context.Context, projectId string, instanceId string, credentialsId string) ApiGetCredentialsRequest
GetCredentials: get credentials by id
get a service credentials by credentials id
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @param projectId @param instanceId Instance id @param credentialsId Credentials id of credentials to fetch @return ApiGetCredentialsRequest
func (*APIClient) GetCredentialsExecute ¶
func (*APIClient) GetInstance ¶
func (a *APIClient) GetInstance(ctx context.Context, projectId string, instanceId string) ApiGetInstanceRequest
GetInstance: get a service instance
get a service instance
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @param projectId @param instanceId Instance id @return ApiGetInstanceRequest
func (*APIClient) GetInstanceExecute ¶
func (*APIClient) GetMetrics ¶ added in v0.14.0
func (a *APIClient) GetMetrics(ctx context.Context, instanceId string, projectId string) ApiGetMetricsRequest
GetMetrics: get latest metrics for cpu load, memory and disk usage
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @param instanceId Instance id @param projectId Project id on which user has permissions @return ApiGetMetricsRequest
func (*APIClient) GetMetricsExecute ¶ added in v0.14.0
func (*APIClient) ListBackups ¶ added in v0.14.0
func (a *APIClient) ListBackups(ctx context.Context, instanceId string, projectId string) ApiListBackupsRequest
ListBackups: get latest backup information for provided instanceId
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @param instanceId Instance id @param projectId Project id on which user has permissions @return ApiListBackupsRequest
func (*APIClient) ListBackupsExecute ¶ added in v0.14.0
func (*APIClient) ListCredentials ¶
func (a *APIClient) ListCredentials(ctx context.Context, projectId string, instanceId string) ApiListCredentialsRequest
ListCredentials: get list of credentials ids
get list all credentials ids for instance
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @param projectId @param instanceId Instance id @return ApiListCredentialsRequest
func (*APIClient) ListCredentialsExecute ¶
func (*APIClient) ListInstances ¶
func (a *APIClient) ListInstances(ctx context.Context, projectId string) ApiListInstancesRequest
ListInstances: get service instances list
Get a list of available instances
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @param projectId @return ApiListInstancesRequest
func (*APIClient) ListInstancesExecute ¶
func (*APIClient) ListOfferings ¶
func (a *APIClient) ListOfferings(ctx context.Context, projectId string) ApiListOfferingsRequest
ListOfferings: get the service offerings
Get the service offerings that the service broker offers.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @param projectId @return ApiListOfferingsRequest
func (*APIClient) ListOfferingsExecute ¶
func (*APIClient) ListRestores ¶ added in v0.17.0
func (a *APIClient) ListRestores(ctx context.Context, instanceId string, projectId string) ApiListRestoresRequest
ListRestores: get latest restore information for provided instanceId
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @param instanceId Instance id @param projectId Project id on which user has permissions @return ApiListRestoresRequest
func (*APIClient) ListRestoresExecute ¶ added in v0.17.0
func (*APIClient) PartialUpdateInstance ¶
func (a *APIClient) PartialUpdateInstance(ctx context.Context, projectId string, instanceId string) ApiPartialUpdateInstanceRequest
PartialUpdateInstance: update a service instance
Update a service instance. This could be a sgw acl update or a plan upgrade.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @param projectId @param instanceId id of the instance being updated @return ApiPartialUpdateInstanceRequest
func (*APIClient) PartialUpdateInstanceExecute ¶
func (*APIClient) TriggerRecreate ¶ added in v0.17.0
func (a *APIClient) TriggerRecreate(ctx context.Context, instanceId string, projectId string) ApiTriggerRecreateRequest
TriggerRecreate: trigger a recreate
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @param instanceId Instance id @param projectId Project id on which user has permissions @return ApiTriggerRecreateRequest
func (*APIClient) TriggerRecreateExecute ¶ added in v0.17.0
func (*APIClient) TriggerRestart ¶ added in v0.17.0
func (a *APIClient) TriggerRestart(ctx context.Context, instanceId string, projectId string) ApiTriggerRestartRequest
TriggerRestart: trigger a restart
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @param instanceId Instance id @param projectId Project id on which user has permissions @return ApiTriggerRestartRequest
func (*APIClient) TriggerRestartExecute ¶ added in v0.17.0
func (*APIClient) TriggerRestore ¶ added in v0.17.0
func (a *APIClient) TriggerRestore(ctx context.Context, instanceId string, projectId string, backupId int32) ApiTriggerRestoreRequest
TriggerRestore: trigger a restore
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @param instanceId Instance id @param projectId Project id on which user has permissions @param backupId Backup id @return ApiTriggerRestoreRequest
func (*APIClient) TriggerRestoreExecute ¶ added in v0.17.0
func (*APIClient) UpdateBackupsConfig ¶ added in v0.17.0
func (a *APIClient) UpdateBackupsConfig(ctx context.Context, instanceId string, projectId string) ApiUpdateBackupsConfigRequest
UpdateBackupsConfig: backups configuration update
Update the configuration for backups for your instance.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @param instanceId Instance id @param projectId Project id on which user has permissions @return ApiUpdateBackupsConfigRequest
func (*APIClient) UpdateBackupsConfigExecute ¶ added in v0.17.0
type ApiCreateBackupRequest ¶ added in v0.17.0
type ApiCreateBackupRequest struct {
// contains filtered or unexported fields
}
func (ApiCreateBackupRequest) Execute ¶ added in v0.17.0
func (r ApiCreateBackupRequest) Execute() ([]CreateBackupResponseItem, error)
type ApiCreateCredentialsRequest ¶
type ApiCreateCredentialsRequest struct {
// contains filtered or unexported fields
}
func (ApiCreateCredentialsRequest) Execute ¶
func (r ApiCreateCredentialsRequest) Execute() (*CredentialsResponse, error)
type ApiCreateInstanceRequest ¶
type ApiCreateInstanceRequest struct {
// contains filtered or unexported fields
}
func (ApiCreateInstanceRequest) CreateInstancePayload ¶
func (r ApiCreateInstanceRequest) CreateInstancePayload(createInstancePayload CreateInstancePayload) ApiCreateInstanceRequest
func (ApiCreateInstanceRequest) Execute ¶
func (r ApiCreateInstanceRequest) Execute() (*CreateInstanceResponse, error)
type ApiDeleteCredentialsRequest ¶
type ApiDeleteCredentialsRequest struct {
// contains filtered or unexported fields
}
func (ApiDeleteCredentialsRequest) Execute ¶
func (r ApiDeleteCredentialsRequest) Execute() error
type ApiDeleteInstanceRequest ¶
type ApiDeleteInstanceRequest struct {
// contains filtered or unexported fields
}
func (ApiDeleteInstanceRequest) Execute ¶
func (r ApiDeleteInstanceRequest) Execute() error
type ApiDownloadBackupRequest ¶ added in v0.17.0
type ApiDownloadBackupRequest struct {
// contains filtered or unexported fields
}
type ApiGetCredentialsRequest ¶
type ApiGetCredentialsRequest struct {
// contains filtered or unexported fields
}
func (ApiGetCredentialsRequest) Execute ¶
func (r ApiGetCredentialsRequest) Execute() (*CredentialsResponse, error)
type ApiGetInstanceRequest ¶
type ApiGetInstanceRequest struct {
// contains filtered or unexported fields
}
func (ApiGetInstanceRequest) Execute ¶
func (r ApiGetInstanceRequest) Execute() (*Instance, error)
type ApiGetMetricsRequest ¶ added in v0.14.0
type ApiGetMetricsRequest struct {
// contains filtered or unexported fields
}
func (ApiGetMetricsRequest) Execute ¶ added in v0.14.0
func (r ApiGetMetricsRequest) Execute() (*GetMetricsResponse, error)
type ApiListBackupsRequest ¶ added in v0.14.0
type ApiListBackupsRequest struct {
// contains filtered or unexported fields
}
func (ApiListBackupsRequest) Execute ¶ added in v0.14.0
func (r ApiListBackupsRequest) Execute() (*ListBackupsResponse, error)
type ApiListCredentialsRequest ¶
type ApiListCredentialsRequest struct {
// contains filtered or unexported fields
}
func (ApiListCredentialsRequest) Execute ¶
func (r ApiListCredentialsRequest) Execute() (*ListCredentialsResponse, error)
type ApiListInstancesRequest ¶
type ApiListInstancesRequest struct {
// contains filtered or unexported fields
}
func (ApiListInstancesRequest) Execute ¶
func (r ApiListInstancesRequest) Execute() (*ListInstancesResponse, error)
type ApiListOfferingsRequest ¶
type ApiListOfferingsRequest struct {
// contains filtered or unexported fields
}
func (ApiListOfferingsRequest) Execute ¶
func (r ApiListOfferingsRequest) Execute() (*ListOfferingsResponse, error)
type ApiListRestoresRequest ¶ added in v0.17.0
type ApiListRestoresRequest struct {
// contains filtered or unexported fields
}
func (ApiListRestoresRequest) Execute ¶ added in v0.17.0
func (r ApiListRestoresRequest) Execute() (*ListRestoresResponse, error)
type ApiPartialUpdateInstanceRequest ¶
type ApiPartialUpdateInstanceRequest struct {
// contains filtered or unexported fields
}
func (ApiPartialUpdateInstanceRequest) Execute ¶
func (r ApiPartialUpdateInstanceRequest) Execute() error
func (ApiPartialUpdateInstanceRequest) PartialUpdateInstancePayload ¶
func (r ApiPartialUpdateInstanceRequest) PartialUpdateInstancePayload(partialUpdateInstancePayload PartialUpdateInstancePayload) ApiPartialUpdateInstanceRequest
type ApiTriggerRecreateRequest ¶ added in v0.17.0
type ApiTriggerRecreateRequest struct {
// contains filtered or unexported fields
}
func (ApiTriggerRecreateRequest) Execute ¶ added in v0.17.0
func (r ApiTriggerRecreateRequest) Execute() (*CreateInstanceResponse, error)
type ApiTriggerRestartRequest ¶ added in v0.17.0
type ApiTriggerRestartRequest struct {
// contains filtered or unexported fields
}
func (ApiTriggerRestartRequest) Execute ¶ added in v0.17.0
func (r ApiTriggerRestartRequest) Execute() (*CreateInstanceResponse, error)
type ApiTriggerRestoreRequest ¶ added in v0.17.0
type ApiTriggerRestoreRequest struct {
// contains filtered or unexported fields
}
func (ApiTriggerRestoreRequest) Execute ¶ added in v0.17.0
func (r ApiTriggerRestoreRequest) Execute() (*TriggerRestoreResponse, error)
type ApiUpdateBackupsConfigRequest ¶ added in v0.17.0
type ApiUpdateBackupsConfigRequest struct {
// contains filtered or unexported fields
}
func (ApiUpdateBackupsConfigRequest) Execute ¶ added in v0.17.0
func (r ApiUpdateBackupsConfigRequest) Execute() (*UpdateBackupsConfigResponse, error)
func (ApiUpdateBackupsConfigRequest) UpdateBackupsConfigPayload ¶ added in v0.17.0
func (r ApiUpdateBackupsConfigRequest) UpdateBackupsConfigPayload(updateBackupsConfigPayload UpdateBackupsConfigPayload) ApiUpdateBackupsConfigRequest
type Backup ¶
type Backup struct {
Downloadable *bool `json:"downloadable,omitempty"`
// REQUIRED
FinishedAt *string `json:"finished_at"`
// REQUIRED
Id *int64 `json:"id"`
Size *int64 `json:"size,omitempty"`
// REQUIRED
Status *string `json:"status"`
TriggeredAt *string `json:"triggered_at,omitempty"`
}
Backup struct for Backup
type CreateBackupResponseItem ¶ added in v0.17.0
type CreateBackupResponseItem struct {
// REQUIRED
Id *int64 `json:"id"`
// REQUIRED
Message *string `json:"message"`
}
CreateBackupResponseItem struct for CreateBackupResponseItem
type CreateInstancePayload ¶
type CreateInstancePayload struct {
// REQUIRED
InstanceName *string `json:"instanceName"`
Parameters *InstanceParameters `json:"parameters,omitempty"`
// REQUIRED
PlanId *string `json:"planId"`
}
CreateInstancePayload struct for CreateInstancePayload
type CreateInstanceResponse ¶
type CreateInstanceResponse struct {
// REQUIRED
InstanceId *string `json:"instanceId"`
}
CreateInstanceResponse struct for CreateInstanceResponse
type Credentials ¶
type Credentials struct {
// REQUIRED
Host *string `json:"host"`
Hosts *[]string `json:"hosts,omitempty"`
LoadBalancedHost *string `json:"load_balanced_host,omitempty"`
// REQUIRED
Password *string `json:"password"`
Port *int64 `json:"port,omitempty"`
Uri *string `json:"uri,omitempty"`
// REQUIRED
Username *string `json:"username"`
}
Credentials struct for Credentials
type CredentialsListItem ¶
type CredentialsListItem struct {
// REQUIRED
Id *string `json:"id"`
}
CredentialsListItem struct for CredentialsListItem
type CredentialsResponse ¶
type CredentialsResponse struct {
// REQUIRED
Id *string `json:"id"`
Raw *RawCredentials `json:"raw,omitempty"`
// REQUIRED
Uri *string `json:"uri"`
}
CredentialsResponse struct for CredentialsResponse
type Error ¶
type Error struct {
// REQUIRED
Description *string `json:"description"`
// REQUIRED
Error *string `json:"error"`
}
Error struct for Error
type GetMetricsResponse ¶ added in v0.14.0
type GetMetricsResponse struct {
CpuIdleTime *int64 `json:"cpuIdleTime,omitempty"`
// REQUIRED
CpuLoadPercent *float64 `json:"cpuLoadPercent"`
CpuSystemTime *int64 `json:"cpuSystemTime,omitempty"`
CpuUserTime *int64 `json:"cpuUserTime,omitempty"`
// REQUIRED
DiskEphemeralTotal *int64 `json:"diskEphemeralTotal"`
// REQUIRED
DiskEphemeralUsed *int64 `json:"diskEphemeralUsed"`
// REQUIRED
DiskPersistentTotal *int64 `json:"diskPersistentTotal"`
// REQUIRED
DiskPersistentUsed *int64 `json:"diskPersistentUsed"`
// REQUIRED
Load1 *float64 `json:"load1"`
// REQUIRED
Load15 *float64 `json:"load15"`
// REQUIRED
Load5 *float64 `json:"load5"`
// REQUIRED
MemoryTotal *int64 `json:"memoryTotal"`
// REQUIRED
MemoryUsed *int64 `json:"memoryUsed"`
// REQUIRED
ParachuteDiskEphemeralActivated *bool `json:"parachuteDiskEphemeralActivated"`
// REQUIRED
ParachuteDiskEphemeralTotal *int64 `json:"parachuteDiskEphemeralTotal"`
// REQUIRED
ParachuteDiskEphemeralUsed *int64 `json:"parachuteDiskEphemeralUsed"`
// REQUIRED
ParachuteDiskEphemeralUsedPercent *int64 `json:"parachuteDiskEphemeralUsedPercent"`
// REQUIRED
ParachuteDiskEphemeralUsedThreshold *int64 `json:"parachuteDiskEphemeralUsedThreshold"`
// REQUIRED
ParachuteDiskPersistentActivated *bool `json:"parachuteDiskPersistentActivated"`
// REQUIRED
ParachuteDiskPersistentTotal *int64 `json:"parachuteDiskPersistentTotal"`
// REQUIRED
ParachuteDiskPersistentUsed *int64 `json:"parachuteDiskPersistentUsed"`
// REQUIRED
ParachuteDiskPersistentUsedPercent *int64 `json:"parachuteDiskPersistentUsedPercent"`
// REQUIRED
ParachuteDiskPersistentUsedThreshold *int64 `json:"parachuteDiskPersistentUsedThreshold"`
}
GetMetricsResponse struct for GetMetricsResponse
type Instance ¶
type Instance struct {
// REQUIRED
CfGuid *string `json:"cfGuid"`
// REQUIRED
CfOrganizationGuid *string `json:"cfOrganizationGuid"`
// REQUIRED
CfSpaceGuid *string `json:"cfSpaceGuid"`
// REQUIRED
DashboardUrl *string `json:"dashboardUrl"`
// REQUIRED
ImageUrl *string `json:"imageUrl"`
InstanceId *string `json:"instanceId,omitempty"`
// REQUIRED
LastOperation *InstanceLastOperation `json:"lastOperation"`
// REQUIRED
Name *string `json:"name"`
// Deprecated: Check the GitHub changelog for alternatives
// REQUIRED
OfferingName *string `json:"offeringName"`
// REQUIRED
OfferingVersion *string `json:"offeringVersion"`
// REQUIRED
Parameters *map[string]interface{} `json:"parameters"`
// REQUIRED
PlanId *string `json:"planId"`
// REQUIRED
PlanName *string `json:"planName"`
Status *string `json:"status,omitempty"`
}
Instance struct for Instance
type InstanceLastOperation ¶
type InstanceLastOperation struct {
// REQUIRED
Description *string `json:"description"`
// REQUIRED
State *string `json:"state"`
// REQUIRED
Type *string `json:"type"`
}
InstanceLastOperation struct for InstanceLastOperation
type InstanceParameters ¶
type InstanceParameters struct {
// The unit is milliseconds.
DownAfterMilliseconds *int64 `json:"down-after-milliseconds,omitempty"`
EnableMonitoring *bool `json:"enable_monitoring,omitempty"`
// The unit is milliseconds.
FailoverTimeout *int64 `json:"failover-timeout,omitempty"`
// If you want to monitor your service with Graphite, you can set the custom parameter graphite. It expects the host and port where the Graphite metrics should be sent to.
Graphite *string `json:"graphite,omitempty"`
LazyfreeLazyEviction *string `json:"lazyfree-lazy-eviction,omitempty"`
LazyfreeLazyExpire *string `json:"lazyfree-lazy-expire,omitempty"`
LuaTimeLimit *int64 `json:"lua-time-limit,omitempty"`
// This component monitors ephemeral and persistent disk usage. If one of these disk usages reaches the default configured threshold of 80%, the a9s Parachute stops all processes on that node.
MaxDiskThreshold *int64 `json:"max_disk_threshold,omitempty"`
Maxclients *int64 `json:"maxclients,omitempty"`
MaxmemoryPolicy *string `json:"maxmemory-policy,omitempty"`
MaxmemorySamples *int64 `json:"maxmemory-samples,omitempty"`
// Frequency of metrics being emitted in seconds
MetricsFrequency *int64 `json:"metrics_frequency,omitempty"`
// Depending on your graphite provider, you might need to prefix the metrics with a certain value, like an API key for example.
MetricsPrefix *string `json:"metrics_prefix,omitempty"`
// The unit is seconds.
MinReplicasMaxLag *int64 `json:"min_replicas_max_lag,omitempty"`
MonitoringInstanceId *string `json:"monitoring_instance_id,omitempty"`
// The allowed value must include the following characters only: [K,E,g,$,l,s,h,z,x,e,A,t]
NotifyKeyspaceEvents *string `json:"notify-keyspace-events,omitempty"`
// Comma separated list of IP networks in CIDR notation which are allowed to access this instance.
SgwAcl *string `json:"sgw_acl,omitempty"`
// This setting must follow the original Redis configuration for RDB.
Snapshot *string `json:"snapshot,omitempty"`
Syslog *[]string `json:"syslog,omitempty"`
TlsCiphers *[]string `json:"tls-ciphers,omitempty"`
TlsCiphersuites *string `json:"tls-ciphersuites,omitempty"`
TlsProtocols *string `json:"tls-protocols,omitempty"`
}
InstanceParameters struct for InstanceParameters
type InstanceSchema ¶
type InstanceSchema struct {
// REQUIRED
Create *Schema `json:"create"`
// REQUIRED
Update *Schema `json:"update"`
}
InstanceSchema struct for InstanceSchema
type ListBackupsResponse ¶
type ListBackupsResponse struct {
// REQUIRED
InstanceBackups *[]Backup `json:"instanceBackups"`
}
ListBackupsResponse struct for ListBackupsResponse
type ListCredentialsResponse ¶
type ListCredentialsResponse struct {
// REQUIRED
CredentialsList *[]CredentialsListItem `json:"credentialsList"`
}
ListCredentialsResponse struct for ListCredentialsResponse
type ListInstancesResponse ¶
type ListInstancesResponse struct {
// REQUIRED
Instances *[]Instance `json:"instances"`
}
ListInstancesResponse struct for ListInstancesResponse
type ListOfferingsResponse ¶
type ListOfferingsResponse struct {
// REQUIRED
Offerings *[]Offering `json:"offerings"`
}
ListOfferingsResponse struct for ListOfferingsResponse
type ListRestoresResponse ¶ added in v0.17.0
type ListRestoresResponse struct {
// REQUIRED
InstanceRestores *[]Restore `json:"instanceRestores"`
}
ListRestoresResponse struct for ListRestoresResponse
type MappedNullable ¶
type NullableBool ¶
type NullableBool struct {
// contains filtered or unexported fields
}
func NewNullableBool ¶
func NewNullableBool(val *bool) *NullableBool
func (NullableBool) Get ¶
func (v NullableBool) Get() *bool
func (NullableBool) IsSet ¶
func (v NullableBool) IsSet() bool
func (NullableBool) MarshalJSON ¶
func (v NullableBool) MarshalJSON() ([]byte, error)
func (*NullableBool) Set ¶
func (v *NullableBool) Set(val *bool)
func (*NullableBool) UnmarshalJSON ¶
func (v *NullableBool) UnmarshalJSON(src []byte) error
func (*NullableBool) Unset ¶
func (v *NullableBool) Unset()
type NullableFloat32 ¶
type NullableFloat32 struct {
// contains filtered or unexported fields
}
func NewNullableFloat32 ¶
func NewNullableFloat32(val *float32) *NullableFloat32
func (NullableFloat32) Get ¶
func (v NullableFloat32) Get() *float32
func (NullableFloat32) IsSet ¶
func (v NullableFloat32) IsSet() bool
func (NullableFloat32) MarshalJSON ¶
func (v NullableFloat32) MarshalJSON() ([]byte, error)
func (*NullableFloat32) Set ¶
func (v *NullableFloat32) Set(val *float32)
func (*NullableFloat32) UnmarshalJSON ¶
func (v *NullableFloat32) UnmarshalJSON(src []byte) error
func (*NullableFloat32) Unset ¶
func (v *NullableFloat32) Unset()
type NullableFloat64 ¶
type NullableFloat64 struct {
// contains filtered or unexported fields
}
func NewNullableFloat64 ¶
func NewNullableFloat64(val *float64) *NullableFloat64
func (NullableFloat64) Get ¶
func (v NullableFloat64) Get() *float64
func (NullableFloat64) IsSet ¶
func (v NullableFloat64) IsSet() bool
func (NullableFloat64) MarshalJSON ¶
func (v NullableFloat64) MarshalJSON() ([]byte, error)
func (*NullableFloat64) Set ¶
func (v *NullableFloat64) Set(val *float64)
func (*NullableFloat64) UnmarshalJSON ¶
func (v *NullableFloat64) UnmarshalJSON(src []byte) error
func (*NullableFloat64) Unset ¶
func (v *NullableFloat64) Unset()
type NullableInt ¶
type NullableInt struct {
// contains filtered or unexported fields
}
func NewNullableInt ¶
func NewNullableInt(val *int) *NullableInt
func (NullableInt) Get ¶
func (v NullableInt) Get() *int
func (NullableInt) IsSet ¶
func (v NullableInt) IsSet() bool
func (NullableInt) MarshalJSON ¶
func (v NullableInt) MarshalJSON() ([]byte, error)
func (*NullableInt) Set ¶
func (v *NullableInt) Set(val *int)
func (*NullableInt) UnmarshalJSON ¶
func (v *NullableInt) UnmarshalJSON(src []byte) error
func (*NullableInt) Unset ¶
func (v *NullableInt) Unset()
type NullableInt32 ¶
type NullableInt32 struct {
// contains filtered or unexported fields
}
func NewNullableInt32 ¶
func NewNullableInt32(val *int32) *NullableInt32
func (NullableInt32) Get ¶
func (v NullableInt32) Get() *int32
func (NullableInt32) IsSet ¶
func (v NullableInt32) IsSet() bool
func (NullableInt32) MarshalJSON ¶
func (v NullableInt32) MarshalJSON() ([]byte, error)
func (*NullableInt32) Set ¶
func (v *NullableInt32) Set(val *int32)
func (*NullableInt32) UnmarshalJSON ¶
func (v *NullableInt32) UnmarshalJSON(src []byte) error
func (*NullableInt32) Unset ¶
func (v *NullableInt32) Unset()
type NullableInt64 ¶
type NullableInt64 struct {
// contains filtered or unexported fields
}
func NewNullableInt64 ¶
func NewNullableInt64(val *int64) *NullableInt64
func (NullableInt64) Get ¶
func (v NullableInt64) Get() *int64
func (NullableInt64) IsSet ¶
func (v NullableInt64) IsSet() bool
func (NullableInt64) MarshalJSON ¶
func (v NullableInt64) MarshalJSON() ([]byte, error)
func (*NullableInt64) Set ¶
func (v *NullableInt64) Set(val *int64)
func (*NullableInt64) UnmarshalJSON ¶
func (v *NullableInt64) UnmarshalJSON(src []byte) error
func (*NullableInt64) Unset ¶
func (v *NullableInt64) Unset()
type NullableString ¶
type NullableString struct {
// contains filtered or unexported fields
}
func NewNullableString ¶
func NewNullableString(val *string) *NullableString
func (NullableString) Get ¶
func (v NullableString) Get() *string
func (NullableString) IsSet ¶
func (v NullableString) IsSet() bool
func (NullableString) MarshalJSON ¶
func (v NullableString) MarshalJSON() ([]byte, error)
func (*NullableString) Set ¶
func (v *NullableString) Set(val *string)
func (*NullableString) UnmarshalJSON ¶
func (v *NullableString) UnmarshalJSON(src []byte) error
func (*NullableString) Unset ¶
func (v *NullableString) Unset()
type NullableTime ¶
type NullableTime struct {
// contains filtered or unexported fields
}
func NewNullableTime ¶
func NewNullableTime(val *time.Time) *NullableTime
func (NullableTime) Get ¶
func (v NullableTime) Get() *time.Time
func (NullableTime) IsSet ¶
func (v NullableTime) IsSet() bool
func (NullableTime) MarshalJSON ¶
func (v NullableTime) MarshalJSON() ([]byte, error)
func (*NullableTime) Set ¶
func (v *NullableTime) Set(val *time.Time)
func (*NullableTime) UnmarshalJSON ¶
func (v *NullableTime) UnmarshalJSON(src []byte) error
func (*NullableTime) Unset ¶
func (v *NullableTime) Unset()
type Offering ¶
type Offering struct {
// REQUIRED
Description *string `json:"description"`
// REQUIRED
DocumentationUrl *string `json:"documentationUrl"`
// REQUIRED
ImageUrl *string `json:"imageUrl"`
// REQUIRED
Latest *bool `json:"latest"`
Lifecycle *string `json:"lifecycle,omitempty"`
// REQUIRED
Name *string `json:"name"`
// REQUIRED
Plans *[]Plan `json:"plans"`
// REQUIRED
QuotaCount *int64 `json:"quotaCount"`
Schema *InstanceSchema `json:"schema,omitempty"`
// REQUIRED
Version *string `json:"version"`
}
Offering struct for Offering
type PartialUpdateInstancePayload ¶
type PartialUpdateInstancePayload struct {
InstanceName *string `json:"instanceName,omitempty"`
Parameters *InstanceParameters `json:"parameters,omitempty"`
PlanId *string `json:"planId,omitempty"`
}
PartialUpdateInstancePayload struct for PartialUpdateInstancePayload
type Plan ¶
type Plan struct {
// REQUIRED
Description *string `json:"description"`
// REQUIRED
Free *bool `json:"free"`
// REQUIRED
Id *string `json:"id"`
// REQUIRED
Name *string `json:"name"`
// REQUIRED
SkuName *string `json:"skuName"`
}
Plan struct for Plan
type RawCredentials ¶
type RawCredentials struct {
// REQUIRED
Credentials *Credentials `json:"credentials"`
}
RawCredentials struct for RawCredentials
type Restore ¶ added in v0.17.0
type Restore struct {
// REQUIRED
BackupId *int64 `json:"backup_id"`
// REQUIRED
FinishedAt *string `json:"finished_at"`
// REQUIRED
Id *int64 `json:"id"`
// REQUIRED
Status *string `json:"status"`
TriggeredAt *string `json:"triggered_at,omitempty"`
}
Restore struct for Restore
type Schema ¶
type Schema struct {
// REQUIRED
Parameters *map[string]interface{} `json:"parameters"`
}
Schema struct for Schema
type TriggerRestoreResponse ¶ added in v0.17.0
type TriggerRestoreResponse struct {
// REQUIRED
Id *int64 `json:"id"`
}
TriggerRestoreResponse struct for TriggerRestoreResponse
type UpdateBackupsConfigPayload ¶ added in v0.17.0
type UpdateBackupsConfigPayload struct {
EncryptionKey *string `json:"encryption_key,omitempty"`
}
UpdateBackupsConfigPayload struct for UpdateBackupsConfigPayload
type UpdateBackupsConfigResponse ¶ added in v0.17.0
type UpdateBackupsConfigResponse struct {
// REQUIRED
Message *string `json:"message"`
}
UpdateBackupsConfigResponse struct for UpdateBackupsConfigResponse
Source Files
¶
- api_default.go
- client.go
- configuration.go
- model_backup.go
- model_create_backup_response_item.go
- model_create_instance_payload.go
- model_create_instance_response.go
- model_credentials.go
- model_credentials_list_item.go
- model_credentials_response.go
- model_error.go
- model_get_metrics_response.go
- model_instance.go
- model_instance_last_operation.go
- model_instance_parameters.go
- model_instance_schema.go
- model_list_backups_response.go
- model_list_credentials_response.go
- model_list_instances_response.go
- model_list_offerings_response.go
- model_list_restores_response.go
- model_offering.go
- model_partial_update_instance_payload.go
- model_plan.go
- model_raw_credentials.go
- model_restore.go
- model_schema.go
- model_trigger_restore_response.go
- model_update_backups_config_payload.go
- model_update_backups_config_response.go
- utils.go