redis

package module
v0.13.0 Latest Latest
Warning

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

 Go to latest Published: Apr 11, 2024 License: Apache-2.0 Imports: 22 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CacheExpires 

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

func IsNil 

func IsNil(i interface{}) bool

IsNil checks if an input is nil

func NewConfiguration 

func NewConfiguration() *config.Configuration

NewConfiguration returns a new Configuration object

func ParameterValueToString 

func ParameterValueToString(obj interface{}, key string) string

func PtrBool 

func PtrBool(v bool) *bool

PtrBool is a helper routine that returns a pointer to given boolean value.

func PtrFloat32 

func PtrFloat32(v float32) *float32

PtrFloat32 is a helper routine that returns a pointer to given float value.

func PtrFloat64 

func PtrFloat64(v float64) *float64

PtrFloat64 is a helper routine that returns a pointer to given float value.

func PtrInt 

func PtrInt(v int) *int

PtrInt is a helper routine that returns a pointer to given integer value.

func PtrInt32 

func PtrInt32(v int32) *int32

PtrInt32 is a helper routine that returns a pointer to given integer value.

func PtrInt64 

func PtrInt64(v int64) *int64

PtrInt64 is a helper routine that returns a pointer to given integer value.

func PtrString 

func PtrString(v string) *string

PtrString is a helper routine that returns a pointer to given string value.

func PtrTime 

func PtrTime(v time.Time) *time.Time

PtrTime is helper routine that returns a pointer to given Time 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) 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 (a *APIClient) CreateCredentialsExecute(ctx context.Context, projectId string, instanceId string) (*CredentialsResponse, error)

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 (a *APIClient) CreateInstanceExecute(ctx context.Context, projectId string) (*CreateInstanceResponse, error)

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 (a *APIClient) DeleteCredentialsExecute(ctx context.Context, projectId string, instanceId string, credentialsId string) error

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 (a *APIClient) DeleteInstanceExecute(ctx context.Context, projectId string, instanceId string) error

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 (a *APIClient) GetCredentialsExecute(ctx context.Context, projectId string, instanceId string, credentialsId string) (*CredentialsResponse, error)

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 (a *APIClient) GetInstanceExecute(ctx context.Context, projectId string, instanceId string) (*Instance, error)

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 (a *APIClient) ListCredentialsExecute(ctx context.Context, projectId string, instanceId string) (*ListCredentialsResponse, error)

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 (a *APIClient) ListInstancesExecute(ctx context.Context, projectId string) (*ListInstancesResponse, error)

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 (a *APIClient) ListOfferingsExecute(ctx context.Context, projectId string) (*ListOfferingsResponse, error)

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 (a *APIClient) PartialUpdateInstanceExecute(ctx context.Context, projectId string, instanceId string) 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 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 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 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 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"`
}

type CreateInstancePayload 

type CreateInstancePayload struct {
	// REQUIRED
	InstanceName *string             `json:"instanceName"`
	Parameters   *InstanceParameters `json:"parameters,omitempty"`
	// REQUIRED
	PlanId *string `json:"planId"`
}

type CreateInstanceResponse 

type CreateInstanceResponse struct {
	// REQUIRED
	InstanceId *string `json:"instanceId"`
}

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"`
}

type CredentialsListItem 

type CredentialsListItem struct {
	// REQUIRED
	Id *string `json:"id"`
}

type CredentialsResponse 

type CredentialsResponse struct {
	// REQUIRED
	Id  *string         `json:"id"`
	Raw *RawCredentials `json:"raw,omitempty"`
	// REQUIRED
	Uri *string `json:"uri"`
}

type DefaultApiService 

type DefaultApiService service

DefaultApiService DefaultApi service

type ElasticsearchInstanceParameters added in v0.11.0 

type ElasticsearchInstanceParameters struct {
	EnableMonitoring *bool `json:"enable_monitoring,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"`
	// 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"`
	// 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"`
	MonitoringInstanceId *string `json:"monitoring_instance_id,omitempty"`
	// The plugins repository-s3 and repository-azure are enabled by default and cannot be disabled.
	Plugins *[]string `json:"plugins,omitempty"`
	// Comma separated list of IP networks in CIDR notation which are allowed to access this instance.
	SgwAcl *string `json:"sgw_acl,omitempty"`
	// The content follows the nginx configuration file measurement units.
	SslSessionTimeout *string   `json:"ssl_session_timeout,omitempty"`
	Syslog            *[]string `json:"syslog,omitempty"`
}

type Error 

type Error struct {
	// REQUIRED
	Description *string `json:"description"`
	// REQUIRED
	Error *string `json:"error"`
}

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
	// 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"`
}

type InstanceLastOperation 

type InstanceLastOperation struct {
	// REQUIRED
	Description *string `json:"description"`
	// REQUIRED
	State *string `json:"state"`
	// REQUIRED
	Type *string `json:"type"`
}

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"`
}

type InstanceSchema 

type InstanceSchema struct {
	// REQUIRED
	Create *Schema `json:"create"`
	// REQUIRED
	Update *Schema `json:"update"`
}

type ListBackupsResponse 

type ListBackupsResponse struct {
	// REQUIRED
	InstanceBackups *[]Backup `json:"instanceBackups"`
}

type ListCredentialsResponse 

type ListCredentialsResponse struct {
	// REQUIRED
	CredentialsList *[]CredentialsListItem `json:"credentialsList"`
}

type ListInstancesResponse 

type ListInstancesResponse struct {
	// REQUIRED
	Instances *[]Instance `json:"instances"`
}

type ListMetricsResponse 

type ListMetricsResponse struct {
	CpuIdleTime *int64 `json:"cpuIdleTime,omitempty"`
	// REQUIRED
	CpuLoadPercent *int64 `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
	MemoryTotal *int64 `json:"memoryTotal"`
	// REQUIRED
	MemoryUsed *int64 `json:"memoryUsed"`
	// REQUIRED
	ParachuteDiskEphemeralActivated *int64 `json:"parachuteDiskEphemeralActivated"`
	// REQUIRED
	ParachuteDiskEphemeralTotal *int64 `json:"parachuteDiskEphemeralTotal"`
	// REQUIRED
	ParachuteDiskEphemeralUsed *int64 `json:"parachuteDiskEphemeralUsed"`
	// REQUIRED
	ParachuteDiskEphemeralUsedPercent *int64 `json:"parachuteDiskEphemeralUsedPercent"`
	// REQUIRED
	ParachuteDiskEphemeralUsedThreshold *int64 `json:"parachuteDiskEphemeralUsedThreshold"`
	// REQUIRED
	ParachuteDiskPersistentActivated *int64 `json:"parachuteDiskPersistentActivated"`
	// REQUIRED
	ParachuteDiskPersistentTotal *int64 `json:"parachuteDiskPersistentTotal"`
	// REQUIRED
	ParachuteDiskPersistentUsed *int64 `json:"parachuteDiskPersistentUsed"`
	// REQUIRED
	ParachuteDiskPersistentUsedPercent *int64 `json:"parachuteDiskPersistentUsedPercent"`
	// REQUIRED
	ParachuteDiskPersistentUsedThreshold *int64 `json:"parachuteDiskPersistentUsedThreshold"`
}

type ListOfferingsResponse 

type ListOfferingsResponse struct {
	// REQUIRED
	Offerings *[]Offering `json:"offerings"`
}

type LogMe2InstanceParameters added in v0.11.0 

type LogMe2InstanceParameters struct {
	EnableMonitoring     *bool   `json:"enable_monitoring,omitempty"`
	FluentdTcp           *int64  `json:"fluentd-tcp,omitempty"`
	FluentdTls           *int64  `json:"fluentd-tls,omitempty"`
	FluentdTlsCiphers    *string `json:"fluentd-tls-ciphers,omitempty"`
	FluentdTlsMaxVersion *string `json:"fluentd-tls-max-version,omitempty"`
	FluentdTlsMinVersion *string `json:"fluentd-tls-min-version,omitempty"`
	FluentdTlsVersion    *string `json:"fluentd-tls-version,omitempty"`
	FluentdUdp           *int64  `json:"fluentd-udp,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"`
	Groks    *[]map[string]interface{} `json:"groks,omitempty"`
	// Combination of an integer and a timerange when an index will be considered 'd' and can be deleted from OpenSearch. Possible values for the timerange are s, m, h and d.
	IsmDeletionAfter *string  `json:"ism_deletion_after,omitempty"`
	IsmJitter        *float64 `json:"ism_jitter,omitempty"`
	IsmJobInterval   *int64   `json:"ism_job_interval,omitempty"`
	// Default: not set, 46% of available memory will be used. The amount of memory (in MB) allocated as heap by the JVM for OpenSearch.
	JavaHeapspace *int64 `json:"java_heapspace,omitempty"`
	// The amount of memory (in MB) used by the JVM to store metadata for OpenSearch.
	JavaMaxmetaspace *int64 `json:"java_maxmetaspace,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"`
	// 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"`
	MonitoringInstanceId   *string   `json:"monitoring_instance_id,omitempty"`
	OpensearchTlsCiphers   *[]string `json:"opensearch-tls-ciphers,omitempty"`
	OpensearchTlsProtocols *[]string `json:"opensearch-tls-protocols,omitempty"`
	// Comma separated list of IP networks in CIDR notation which are allowed to access this instance.
	SgwAcl       *string   `json:"sgw_acl,omitempty"`
	Syslog       *[]string `json:"syslog,omitempty"`
	SyslogUseUdp *string   `json:"syslog-use-udp,omitempty"`
}

type LogMeCredentials added in v0.13.0 

type LogMeCredentials struct {
	// REQUIRED
	Host *string `json:"host"`
	// REQUIRED
	Password       *string `json:"password"`
	Port           *int64  `json:"port,omitempty"`
	SyslogDrainUrl *string `json:"syslog_drain_url,omitempty"`
	Uri            *string `json:"uri,omitempty"`
	// REQUIRED
	Username *string `json:"username"`
}

type MappedNullable 

type MappedNullable interface {
	ToMap() (map[string]interface{}, error)
}

type MariaDBCredentials added in v0.13.0 

type MariaDBCredentials struct {
	// REQUIRED
	Host  *string   `json:"host"`
	Hosts *[]string `json:"hosts,omitempty"`
	Name  *string   `json:"name,omitempty"`
	// REQUIRED
	Password *string `json:"password"`
	Port     *int64  `json:"port,omitempty"`
	Uri      *string `json:"uri,omitempty"`
	// REQUIRED
	Username *string `json:"username"`
}

type MariaDBInstanceParameters added in v0.11.0 

type MariaDBInstanceParameters struct {
	EnableMonitoring *bool `json:"enable_monitoring,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"`
	// 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"`
	// 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"`
	MonitoringInstanceId *string `json:"monitoring_instance_id,omitempty"`
	// Comma separated list of IP networks in CIDR notation which are allowed to access this instance.
	SgwAcl *string   `json:"sgw_acl,omitempty"`
	Syslog *[]string `json:"syslog,omitempty"`
}

type Metrics added in v0.13.0 

type Metrics struct {
	// REQUIRED
	Metrics *[]ListMetricsResponse `json:"metrics"`
}

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"`
}

type OpenSearchCredentials added in v0.13.0 

type OpenSearchCredentials struct {
	// REQUIRED
	Host  *string   `json:"host"`
	Hosts *[]string `json:"hosts,omitempty"`
	// REQUIRED
	Password *string `json:"password"`
	Port     *int64  `json:"port,omitempty"`
	Scheme   *string `json:"scheme,omitempty"`
	Uri      *string `json:"uri,omitempty"`
	// REQUIRED
	Username *string `json:"username"`
}

type OpenSearchInstanceParameters added in v0.11.0 

type OpenSearchInstanceParameters struct {
	EnableMonitoring *bool `json:"enable_monitoring,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"`
	JavaGarbageCollector *string `json:"java_garbage_collector,omitempty"`
	// Default: not set, 46% of available memory will be used. The amount of memory (in MB) allocated as heap by the JVM for OpenSearch.
	JavaHeapspace *int64 `json:"java_heapspace,omitempty"`
	// The amount of memory (in MB) used by the JVM to store metadata for OpenSearch.
	JavaMaxmetaspace *int64 `json:"java_maxmetaspace,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"`
	// 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"`
	MonitoringInstanceId *string `json:"monitoring_instance_id,omitempty"`
	// The plugins repository-s3 and repository-azure are enabled by default and cannot be disabled.
	Plugins *[]string `json:"plugins,omitempty"`
	// Comma separated list of IP networks in CIDR notation which are allowed to access this instance.
	SgwAcl *string   `json:"sgw_acl,omitempty"`
	Syslog *[]string `json:"syslog,omitempty"`
	// Only Java format is supported.
	TlsCiphers   *[]string `json:"tls-ciphers,omitempty"`
	TlsProtocols *string   `json:"tls-protocols,omitempty"`
}

type PartialUpdateInstancePayload 

type PartialUpdateInstancePayload struct {
	InstanceName *string             `json:"instanceName,omitempty"`
	Parameters   *InstanceParameters `json:"parameters,omitempty"`
	PlanId       *string             `json:"planId,omitempty"`
}

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"`
}

type PostgreSQLInstanceParameters added in v0.11.0 

type PostgreSQLInstanceParameters struct {
	// The units of the property are seconds.
	ArchiveTimeout      *int64  `json:"archive_timeout,omitempty"`
	ClientMinMessages   *string `json:"client_min_messages,omitempty"`
	ContinuousArchiving *string `json:"continuous_archiving,omitempty"`
	// This option can only be set during creation of the service instance, and cannot be changed later.
	DataChecksums *string   `json:"data_checksums,omitempty"`
	DeletePlugins *[]string `json:"delete_plugins,omitempty"`
	// The units of the property are MB. Please note, that our BOSH release includes an algorithm which calculates a usable value for this property on the fly based on the resources of the VM running.
	EffectiveCacheSize *int64 `json:"effective_cache_size,omitempty"`
	EnableMonitoring   *bool  `json:"enable_monitoring,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"`
	// The units of the property are milliseconds.
	IdleInTransactionSessionTimeout *int64 `json:"idle_in_transaction_session_timeout,omitempty"`
	// The plugins pgcrypto and citext are enabled by default.
	InstallPlugins          *[]string `json:"install_plugins,omitempty"`
	LogErrorVerbosity       *string   `json:"log_error_verbosity,omitempty"`
	LogMinDurationStatement *int64    `json:"log_min_duration_statement,omitempty"`
	LogStatement            *string   `json:"log_statement,omitempty"`
	Loglevel                *string   `json:"loglevel,omitempty"`
	// The units of the property are kilobytes.
	MaintenanceWorkMem *int64 `json:"maintenance_work_mem,omitempty"`
	// You cannot decrease max_connections as this will break clustering. The default value increases with instance size.
	MaxConnections *int64 `json:"max_connections,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"`
	MaxReplicationSlots *int64 `json:"max_replication_slots,omitempty"`
	MaxWalSenders       *int64 `json:"max_wal_senders,omitempty"`
	// Expects an array of database names. If the parameter is not set or the array is set to empty, then metrics will be collected for all databases.
	MetricDatabases               *[]string `json:"metric_databases,omitempty"`
	MetricPgDatabaseSize          *int64    `json:"metric_pg_database_size,omitempty"`
	MetricPgReplication           *int64    `json:"metric_pg_replication,omitempty"`
	MetricPgStatAllIndexes        *int64    `json:"metric_pg_stat_all_indexes,omitempty"`
	MetricPgStatAllTables         *int64    `json:"metric_pg_stat_all_tables,omitempty"`
	MetricPgStatArchiverTable     *int64    `json:"metric_pg_stat_archiver_table,omitempty"`
	MetricPgStatDatabase          *int64    `json:"metric_pg_stat_database,omitempty"`
	MetricPgStatDatabaseConflicts *int64    `json:"metric_pg_stat_database_conflicts,omitempty"`
	MetricPgStatioAllIndexes      *int64    `json:"metric_pg_statio_all_indexes,omitempty"`
	MetricPgStatioAllTables       *int64    `json:"metric_pg_statio_all_tables,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"`
	MonitoringInstanceId   *string   `json:"monitoring_instance_id,omitempty"`
	PgLogMinErrorStatement *string   `json:"pg_log_min_error_statement,omitempty"`
	PgLogMinMessages       *string   `json:"pg_log_min_messages,omitempty"`
	RepmgrLoglevel         *string   `json:"repmgr_loglevel,omitempty"`
	RolePrivileges         *[]string `json:"role_privileges,omitempty"`
	// Comma separated list of IP networks in CIDR notation which are allowed to access this instance.
	SgwAcl *string `json:"sgw_acl,omitempty"`
	// The units of the property are MB.
	SharedBuffers         *int64  `json:"shared_buffers,omitempty"`
	SslCiphers            *string `json:"ssl_ciphers,omitempty"`
	SslMinProtocolVersion *string `json:"ssl_min_protocol_version,omitempty"`
	// The units of the property are milliseconds.
	StatementTimeout  *int64    `json:"statement_timeout,omitempty"`
	SynchronousCommit *string   `json:"synchronous_commit,omitempty"`
	Syslog            *[]string `json:"syslog,omitempty"`
	// An integer value greater than 0 kilobytes is expected. Alternatively -1 means no limit.
	TempFileLimit *int64 `json:"temp_file_limit,omitempty"`
	// The units of the property are kilobytes.
	TempFiles       *int64  `json:"temp_files,omitempty"`
	TrackIoTiming   *string `json:"track_io_timing,omitempty"`
	WalLevelLogical *bool   `json:"wal_level_logical,omitempty"`
	WalWriterDelay  *int64  `json:"wal_writer_delay,omitempty"`
	// The units of the property are kilobytes. Specifies the amount of memory to be used by internal sort operations and hash tables before writing to temporary disk files.
	WorkMem *int64 `json:"work_mem,omitempty"`
}

type PostgresQLCredentials added in v0.13.0 

type PostgresQLCredentials struct {
	// REQUIRED
	Host  *string   `json:"host"`
	Hosts *[]string `json:"hosts,omitempty"`
	Name  *string   `json:"name,omitempty"`
	// REQUIRED
	Password *string `json:"password"`
	Port     *int64  `json:"port,omitempty"`
	Uri      *string `json:"uri,omitempty"`
	// REQUIRED
	Username *string `json:"username"`
}

type RabbitMQCredentials added in v0.13.0 

type RabbitMQCredentials struct {
	// REQUIRED
	Host  *string   `json:"host"`
	Hosts *[]string `json:"hosts,omitempty"`
	// for rabbitmq only
	HttpApiUri  *string   `json:"http_api_uri,omitempty"`
	HttpApiUris *[]string `json:"http_api_uris,omitempty"`
	Management  *string   `json:"management,omitempty"`
	// REQUIRED
	Password *string   `json:"password"`
	Port     *int64    `json:"port,omitempty"`
	Uri      *string   `json:"uri,omitempty"`
	Uris     *[]string `json:"uris,omitempty"`
	// REQUIRED
	Username *string `json:"username"`
}

type RabbitMQInstanceParameters added in v0.11.0 

type RabbitMQInstanceParameters struct {
	// The unit is milliseconds.
	ConsumerTimeout  *int64 `json:"consumer_timeout,omitempty"`
	EnableMonitoring *bool  `json:"enable_monitoring,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"`
	// 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"`
	// 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"`
	MonitoringInstanceId *string   `json:"monitoring_instance_id,omitempty"`
	Plugins              *[]string `json:"plugins,omitempty"`
	Roles                *[]string `json:"roles,omitempty"`
	// Comma separated list of IP networks in CIDR notation which are allowed to access this instance.
	SgwAcl       *string   `json:"sgw_acl,omitempty"`
	Syslog       *[]string `json:"syslog,omitempty"`
	TlsCiphers   *[]string `json:"tls-ciphers,omitempty"`
	TlsProtocols *string   `json:"tls-protocols,omitempty"`
}

type RawCredentials 

type RawCredentials struct {
	// REQUIRED
	Credentials *Credentials `json:"credentials"`
}

type Schema 

type Schema struct {
	// REQUIRED
	Parameters *map[string]interface{} `json:"parameters"`
}

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.