clouddatabasesv5

package
v0.7.1 Latest Latest
Warning

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

 Go to latest Published: Nov 20, 2024 License: Apache-2.0 Imports: 9 Imported by: 4

Documentation

Overview

Package clouddatabasesv5 : Operations and models for the CloudDatabasesV5 service

Index

Constants

View Source 
const (
	BackupTypeOnDemandConst  = "on_demand"
	BackupTypeScheduledConst = "scheduled"
)

Constants associated with the Backup.Type property. The type of backup.

View Source 
const (
	BackupStatusCompletedConst = "completed"
	BackupStatusFailedConst    = "failed"
	BackupStatusRunningConst   = "running"
)

Constants associated with the Backup.Status property. The status of this backup.

View Source 
const (
	CompleteConnectionOptionsEndpointTypePrivateConst = "private"
	CompleteConnectionOptionsEndpointTypePublicConst  = "public"
)

Constants associated with the CompleteConnectionOptions.EndpointType property. Endpoint Type. The select endpoint must be enabled on the deployment before its connection information can be fetched.

View Source 
const (
	ConfigurationLogConnectionsOffConst = "off"
	ConfigurationLogConnectionsOnConst  = "on"
)

Constants associated with the Configuration.LogConnections property. Causes each attempted connection to the server to be logged, as well as successful completion of client authentication.

View Source 
const (
	ConfigurationLogDisconnectionsOffConst = "off"
	ConfigurationLogDisconnectionsOnConst  = "on"
)

Constants associated with the Configuration.LogDisconnections property. Causes session terminations to be logged. The log output provides information similar to log_connections, plus the duration of the session.

View Source 
const (
	ConfigurationSynchronousCommitLocalConst = "local"
	ConfigurationSynchronousCommitOffConst   = "off"
)

Constants associated with the Configuration.SynchronousCommit property. Sets the current transaction's synchronization level. Off can result in data loss. remote_write with enable synchronous replication which will impact performance and availabilty.

View Source 
const (
	ConfigurationWalLevelLogicalConst = "logical"
	ConfigurationWalLevelReplicaConst = "replica"
)

Constants associated with the Configuration.WalLevel property. Controls WAL level. Allowed values are replica or logical. Set to logical to use logical decoding. If you are not using logical decoding, using logical increases the WAL size, which has several disadvantages and no real advantage.

View Source 
const (
	ConfigurationMaxmemoryPolicyAllkeysLruConst     = "allkeys-lru"
	ConfigurationMaxmemoryPolicyAllkeysRandomConst  = "allkeys-random"
	ConfigurationMaxmemoryPolicyNoevictionConst     = "noeviction"
	ConfigurationMaxmemoryPolicyVolatileLruConst    = "volatile-lru"
	ConfigurationMaxmemoryPolicyVolatileRandomConst = "volatile-random"
	ConfigurationMaxmemoryPolicyVolatileTTLConst    = "volatile-ttl"
)

Constants associated with the Configuration.MaxmemoryPolicy property. The policy with which Redis evicts keys when maximum memory is reached.

View Source 
const (
	ConfigurationAppendonlyNoConst  = "no"
	ConfigurationAppendonlyYesConst = "yes"
)

Constants associated with the Configuration.Appendonly property. If set to yes this will enable AOF persistence.

View Source 
const (
	ConfigurationStopWritesOnBgsaveErrorNoConst  = "no"
	ConfigurationStopWritesOnBgsaveErrorYesConst = "yes"
)

Constants associated with the Configuration.StopWritesOnBgsaveError property. Whether or not to stop accepting writes when background persistence actions fail.

View Source 
const (
	ConfigurationDefaultAuthenticationPluginCachingSha2PasswordConst = "caching_sha2_password"
	ConfigurationDefaultAuthenticationPluginMysqlNativePasswordConst = "mysql_native_password"
	ConfigurationDefaultAuthenticationPluginSha256PasswordConst      = "sha256_password"
)

Constants associated with the Configuration.DefaultAuthenticationPlugin property. Determines which authentication plugin the server assigns to new accounts created by CREATE USER and GRANT statements that do not explicitly specify an authentication plugin.

View Source 
const (
	DeployablesVersionsItemStatusBetaConst       = "beta"
	DeployablesVersionsItemStatusDeprecatedConst = "deprecated"
	DeployablesVersionsItemStatusStableConst     = "stable"
)

Constants associated with the DeployablesVersionsItem.Status property. The status of this version: To be finalized.

View Source 
const (
	GetConnectionOptionsEndpointTypePrivateConst = "private"
	GetConnectionOptionsEndpointTypePublicConst  = "public"
)

Constants associated with the GetConnectionOptions.EndpointType property. Endpoint Type. The endpoint must be enabled on the deployment before its connection information can be fetched.

View Source 
const (
	GetDefaultScalingGroupsOptionsTypeEtcdConst       = "etcd"
	GetDefaultScalingGroupsOptionsTypePostgresqlConst = "postgresql"
)

Constants associated with the GetDefaultScalingGroupsOptions.Type property. Database type name.

View Source 
const (
	GroupIDAnalyticsConst   = "analytics"
	GroupIDBiConnectorConst = "bi_connector"
	GroupIDMemberConst      = "member"
	GroupIDSearchConst      = "search"
)

Constants associated with the Group.ID property. Id/name for group.

View Source 
const (
	TaskStatusCompletedConst = "completed"
	TaskStatusFailedConst    = "failed"
	TaskStatusRunningConst   = "running"
)

Constants associated with the Task.Status property. The status of the task.

View Source 
const (
	ConfigurationMySQLConfigurationDefaultAuthenticationPluginCachingSha2PasswordConst = "caching_sha2_password"
	ConfigurationMySQLConfigurationDefaultAuthenticationPluginMysqlNativePasswordConst = "mysql_native_password"
	ConfigurationMySQLConfigurationDefaultAuthenticationPluginSha256PasswordConst      = "sha256_password"
)

Constants associated with the ConfigurationMySQLConfiguration.DefaultAuthenticationPlugin property. Determines which authentication plugin the server assigns to new accounts created by CREATE USER and GRANT statements that do not explicitly specify an authentication plugin.

View Source 
const (
	ConfigurationPgConfigurationLogConnectionsOffConst = "off"
	ConfigurationPgConfigurationLogConnectionsOnConst  = "on"
)

Constants associated with the ConfigurationPgConfiguration.LogConnections property. Causes each attempted connection to the server to be logged, as well as successful completion of client authentication.

View Source 
const (
	ConfigurationPgConfigurationLogDisconnectionsOffConst = "off"
	ConfigurationPgConfigurationLogDisconnectionsOnConst  = "on"
)

Constants associated with the ConfigurationPgConfiguration.LogDisconnections property. Causes session terminations to be logged. The log output provides information similar to log_connections, plus the duration of the session.

View Source 
const (
	ConfigurationPgConfigurationSynchronousCommitLocalConst = "local"
	ConfigurationPgConfigurationSynchronousCommitOffConst   = "off"
)

Constants associated with the ConfigurationPgConfiguration.SynchronousCommit property. Sets the current transaction's synchronization level. Off can result in data loss. remote_write with enable synchronous replication which will impact performance and availabilty.

View Source 
const (
	ConfigurationPgConfigurationWalLevelLogicalConst = "logical"
	ConfigurationPgConfigurationWalLevelReplicaConst = "replica"
)

Constants associated with the ConfigurationPgConfiguration.WalLevel property. Controls WAL level. Allowed values are replica or logical. Set to logical to use logical decoding. If you are not using logical decoding, using logical increases the WAL size, which has several disadvantages and no real advantage.

View Source 
const (
	ConfigurationRedisConfigurationMaxmemoryPolicyAllkeysLruConst     = "allkeys-lru"
	ConfigurationRedisConfigurationMaxmemoryPolicyAllkeysRandomConst  = "allkeys-random"
	ConfigurationRedisConfigurationMaxmemoryPolicyNoevictionConst     = "noeviction"
	ConfigurationRedisConfigurationMaxmemoryPolicyVolatileLruConst    = "volatile-lru"
	ConfigurationRedisConfigurationMaxmemoryPolicyVolatileRandomConst = "volatile-random"
	ConfigurationRedisConfigurationMaxmemoryPolicyVolatileTTLConst    = "volatile-ttl"
)

Constants associated with the ConfigurationRedisConfiguration.MaxmemoryPolicy property. The policy with which Redis evicts keys when maximum memory is reached.

View Source 
const (
	ConfigurationRedisConfigurationAppendonlyNoConst  = "no"
	ConfigurationRedisConfigurationAppendonlyYesConst = "yes"
)

Constants associated with the ConfigurationRedisConfiguration.Appendonly property. If set to yes this will enable AOF persistence.

View Source 
const (
	ConfigurationRedisConfigurationStopWritesOnBgsaveErrorNoConst  = "no"
	ConfigurationRedisConfigurationStopWritesOnBgsaveErrorYesConst = "yes"
)

Constants associated with the ConfigurationRedisConfiguration.StopWritesOnBgsaveError property. Whether or not to stop accepting writes when background persistence actions fail.

View Source 
const (
	UserOpsManagerUserRoleGroupDataAccessAdminConst = "group_data_access_admin"
	UserOpsManagerUserRoleGroupReadOnlyConst        = "group_read_only"
)

Constants associated with the UserOpsManagerUser.Role property. Role for new user. Available for MongoDB Enterprise Ops Manager users.

View Source 
const DefaultServiceName = "cloud_databases"

DefaultServiceName is the default key used to find external configuration information.

View Source 
const DefaultServiceURL = "https://api.us-south.databases.cloud.ibm.com/v5/ibm"

DefaultServiceURL is the default URL to make service requests to.

View Source 
const (
	GetDefaultScalingGroupsOptionsHostFlavorMultitenantConst = "multitenant"
)

Constants associated with the GetDefaultScalingGroupsOptions.HostFlavor property. When a host_flavor of 'multitenant' is included with the request, IBM Cloud Database's new shared compute default groups will be returned.

View Source 
const ParameterizedServiceURL = "https://api.{region}.databases.cloud.ibm.com/v5/{platform}"

Variables

This section is empty.

Functions

func ConstructServiceURL added in v0.2.0 

func ConstructServiceURL(providedUrlVariables map[string]string) (string, error)

ConstructServiceURL constructs a service URL from the parameterized URL.

func GetServiceURLForRegion 

func GetServiceURLForRegion(region string) (string, error)

GetServiceURLForRegion returns the service URL to be used for the specified region

func UnmarshalAddAllowlistEntryResponse 

func UnmarshalAddAllowlistEntryResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalAddAllowlistEntryResponse unmarshals an instance of AddAllowlistEntryResponse from the specified map of raw messages.

func UnmarshalAllowlistEntry 

func UnmarshalAllowlistEntry(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalAllowlistEntry unmarshals an instance of AllowlistEntry from the specified map of raw messages.

func UnmarshalAutoscalingCPUGroupCPU 

func UnmarshalAutoscalingCPUGroupCPU(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalAutoscalingCPUGroupCPU unmarshals an instance of AutoscalingCPUGroupCPU from the specified map of raw messages.

func UnmarshalAutoscalingCPUGroupCPURate 

func UnmarshalAutoscalingCPUGroupCPURate(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalAutoscalingCPUGroupCPURate unmarshals an instance of AutoscalingCPUGroupCPURate from the specified map of raw messages.

func UnmarshalAutoscalingDiskGroupDisk 

func UnmarshalAutoscalingDiskGroupDisk(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalAutoscalingDiskGroupDisk unmarshals an instance of AutoscalingDiskGroupDisk from the specified map of raw messages.

func UnmarshalAutoscalingDiskGroupDiskRate 

func UnmarshalAutoscalingDiskGroupDiskRate(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalAutoscalingDiskGroupDiskRate unmarshals an instance of AutoscalingDiskGroupDiskRate from the specified map of raw messages.

func UnmarshalAutoscalingDiskGroupDiskScalers 

func UnmarshalAutoscalingDiskGroupDiskScalers(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalAutoscalingDiskGroupDiskScalers unmarshals an instance of AutoscalingDiskGroupDiskScalers from the specified map of raw messages.

func UnmarshalAutoscalingDiskGroupDiskScalersCapacity 

func UnmarshalAutoscalingDiskGroupDiskScalersCapacity(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalAutoscalingDiskGroupDiskScalersCapacity unmarshals an instance of AutoscalingDiskGroupDiskScalersCapacity from the specified map of raw messages.

func UnmarshalAutoscalingDiskGroupDiskScalersIoUtilization 

func UnmarshalAutoscalingDiskGroupDiskScalersIoUtilization(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalAutoscalingDiskGroupDiskScalersIoUtilization unmarshals an instance of AutoscalingDiskGroupDiskScalersIoUtilization from the specified map of raw messages.

func UnmarshalAutoscalingGroup 

func UnmarshalAutoscalingGroup(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalAutoscalingGroup unmarshals an instance of AutoscalingGroup from the specified map of raw messages.

func UnmarshalAutoscalingGroupAutoscaling 

func UnmarshalAutoscalingGroupAutoscaling(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalAutoscalingGroupAutoscaling unmarshals an instance of AutoscalingGroupAutoscaling from the specified map of raw messages.

func UnmarshalAutoscalingMemoryGroupMemory 

func UnmarshalAutoscalingMemoryGroupMemory(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalAutoscalingMemoryGroupMemory unmarshals an instance of AutoscalingMemoryGroupMemory from the specified map of raw messages.

func UnmarshalAutoscalingMemoryGroupMemoryRate 

func UnmarshalAutoscalingMemoryGroupMemoryRate(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalAutoscalingMemoryGroupMemoryRate unmarshals an instance of AutoscalingMemoryGroupMemoryRate from the specified map of raw messages.

func UnmarshalAutoscalingMemoryGroupMemoryScalers 

func UnmarshalAutoscalingMemoryGroupMemoryScalers(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalAutoscalingMemoryGroupMemoryScalers unmarshals an instance of AutoscalingMemoryGroupMemoryScalers from the specified map of raw messages.

func UnmarshalAutoscalingMemoryGroupMemoryScalersIoUtilization 

func UnmarshalAutoscalingMemoryGroupMemoryScalersIoUtilization(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalAutoscalingMemoryGroupMemoryScalersIoUtilization unmarshals an instance of AutoscalingMemoryGroupMemoryScalersIoUtilization from the specified map of raw messages.

func UnmarshalAutoscalingSetGroupAutoscaling 

func UnmarshalAutoscalingSetGroupAutoscaling(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalAutoscalingSetGroupAutoscaling unmarshals an instance of AutoscalingSetGroupAutoscaling from the specified map of raw messages.

func UnmarshalAutoscalingSetGroupAutoscalingAutoscalingCPUGroup 

func UnmarshalAutoscalingSetGroupAutoscalingAutoscalingCPUGroup(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalAutoscalingSetGroupAutoscalingAutoscalingCPUGroup unmarshals an instance of AutoscalingSetGroupAutoscalingAutoscalingCPUGroup from the specified map of raw messages.

func UnmarshalAutoscalingSetGroupAutoscalingAutoscalingDiskGroup 

func UnmarshalAutoscalingSetGroupAutoscalingAutoscalingDiskGroup(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalAutoscalingSetGroupAutoscalingAutoscalingDiskGroup unmarshals an instance of AutoscalingSetGroupAutoscalingAutoscalingDiskGroup from the specified map of raw messages.

func UnmarshalAutoscalingSetGroupAutoscalingAutoscalingMemoryGroup 

func UnmarshalAutoscalingSetGroupAutoscalingAutoscalingMemoryGroup(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalAutoscalingSetGroupAutoscalingAutoscalingMemoryGroup unmarshals an instance of AutoscalingSetGroupAutoscalingAutoscalingMemoryGroup from the specified map of raw messages.

func UnmarshalBackup 

func UnmarshalBackup(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalBackup unmarshals an instance of Backup from the specified map of raw messages.

func UnmarshalBackups 

func UnmarshalBackups(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalBackups unmarshals an instance of Backups from the specified map of raw messages.

func UnmarshalCompleteConnectionResponse added in v0.2.0 

func UnmarshalCompleteConnectionResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalCompleteConnectionResponse unmarshals an instance of CompleteConnectionResponse from the specified map of raw messages.

func UnmarshalConfiguration added in v0.2.0 

func UnmarshalConfiguration(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalConfiguration unmarshals an instance of Configuration from the specified map of raw messages.

func UnmarshalConfigurationMySQLConfiguration added in v0.2.0 

func UnmarshalConfigurationMySQLConfiguration(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalConfigurationMySQLConfiguration unmarshals an instance of ConfigurationMySQLConfiguration from the specified map of raw messages.

func UnmarshalConfigurationPgConfiguration added in v0.2.0 

func UnmarshalConfigurationPgConfiguration(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalConfigurationPgConfiguration unmarshals an instance of ConfigurationPgConfiguration from the specified map of raw messages.

func UnmarshalConfigurationRabbitMqConfiguration added in v0.3.1 

func UnmarshalConfigurationRabbitMqConfiguration(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalConfigurationRabbitMqConfiguration unmarshals an instance of ConfigurationRabbitMqConfiguration from the specified map of raw messages.

func UnmarshalConfigurationRedisConfiguration added in v0.2.0 

func UnmarshalConfigurationRedisConfiguration(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalConfigurationRedisConfiguration unmarshals an instance of ConfigurationRedisConfiguration from the specified map of raw messages.

func UnmarshalConnection 

func UnmarshalConnection(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalConnection unmarshals an instance of Connection from the specified map of raw messages.

func UnmarshalConnectionAuthentication added in v0.2.0 

func UnmarshalConnectionAuthentication(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalConnectionAuthentication unmarshals an instance of ConnectionAuthentication from the specified map of raw messages.

func UnmarshalConnectionCertificate added in v0.2.0 

func UnmarshalConnectionCertificate(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalConnectionCertificate unmarshals an instance of ConnectionCertificate from the specified map of raw messages.

func UnmarshalConnectionCli 

func UnmarshalConnectionCli(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalConnectionCli unmarshals an instance of ConnectionCli from the specified map of raw messages.

func UnmarshalConnectionElasticsearchConnection added in v0.2.0 

func UnmarshalConnectionElasticsearchConnection(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalConnectionElasticsearchConnection unmarshals an instance of ConnectionElasticsearchConnection from the specified map of raw messages.

func UnmarshalConnectionEnterpriseDbConnection added in v0.2.0 

func UnmarshalConnectionEnterpriseDbConnection(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalConnectionEnterpriseDbConnection unmarshals an instance of ConnectionEnterpriseDbConnection from the specified map of raw messages.

func UnmarshalConnectionEtcdConnection added in v0.2.0 

func UnmarshalConnectionEtcdConnection(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalConnectionEtcdConnection unmarshals an instance of ConnectionEtcdConnection from the specified map of raw messages.

func UnmarshalConnectionHost added in v0.2.0 

func UnmarshalConnectionHost(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalConnectionHost unmarshals an instance of ConnectionHost from the specified map of raw messages.

func UnmarshalConnectionMongoDbConnection added in v0.2.0 

func UnmarshalConnectionMongoDbConnection(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalConnectionMongoDbConnection unmarshals an instance of ConnectionMongoDbConnection from the specified map of raw messages.

func UnmarshalConnectionMongoDbeeConnection added in v0.2.0 

func UnmarshalConnectionMongoDbeeConnection(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalConnectionMongoDbeeConnection unmarshals an instance of ConnectionMongoDbeeConnection from the specified map of raw messages.

func UnmarshalConnectionMongoDbeeOpsManagerConnection added in v0.2.0 

func UnmarshalConnectionMongoDbeeOpsManagerConnection(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalConnectionMongoDbeeOpsManagerConnection unmarshals an instance of ConnectionMongoDbeeOpsManagerConnection from the specified map of raw messages.

func UnmarshalConnectionMySQLConnection added in v0.2.0 

func UnmarshalConnectionMySQLConnection(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalConnectionMySQLConnection unmarshals an instance of ConnectionMySQLConnection from the specified map of raw messages.

func UnmarshalConnectionPostgreSQLConnection added in v0.2.0 

func UnmarshalConnectionPostgreSQLConnection(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalConnectionPostgreSQLConnection unmarshals an instance of ConnectionPostgreSQLConnection from the specified map of raw messages.

func UnmarshalConnectionRabbitMqConnection added in v0.2.0 

func UnmarshalConnectionRabbitMqConnection(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalConnectionRabbitMqConnection unmarshals an instance of ConnectionRabbitMqConnection from the specified map of raw messages.

func UnmarshalConnectionRedisConnection added in v0.2.0 

func UnmarshalConnectionRedisConnection(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalConnectionRedisConnection unmarshals an instance of ConnectionRedisConnection from the specified map of raw messages.

func UnmarshalConnectionURI added in v0.2.0 

func UnmarshalConnectionURI(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalConnectionURI unmarshals an instance of ConnectionURI from the specified map of raw messages.

func UnmarshalCreateDatabaseUserResponse 

func UnmarshalCreateDatabaseUserResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalCreateDatabaseUserResponse unmarshals an instance of CreateDatabaseUserResponse from the specified map of raw messages.

func UnmarshalCreateLogicalReplicationSlotResponse added in v0.3.0 

func UnmarshalCreateLogicalReplicationSlotResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalCreateLogicalReplicationSlotResponse unmarshals an instance of CreateLogicalReplicationSlotResponse from the specified map of raw messages.

func UnmarshalDeleteAllowlistEntryResponse 

func UnmarshalDeleteAllowlistEntryResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDeleteAllowlistEntryResponse unmarshals an instance of DeleteAllowlistEntryResponse from the specified map of raw messages.

func UnmarshalDeleteDatabaseUserResponse 

func UnmarshalDeleteDatabaseUserResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDeleteDatabaseUserResponse unmarshals an instance of DeleteDatabaseUserResponse from the specified map of raw messages.

func UnmarshalDeleteLogicalReplicationSlotResponse added in v0.3.0 

func UnmarshalDeleteLogicalReplicationSlotResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDeleteLogicalReplicationSlotResponse unmarshals an instance of DeleteLogicalReplicationSlotResponse from the specified map of raw messages.

func UnmarshalDeployables 

func UnmarshalDeployables(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDeployables unmarshals an instance of Deployables from the specified map of raw messages.

func UnmarshalDeployablesVersionsItem 

func UnmarshalDeployablesVersionsItem(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDeployablesVersionsItem unmarshals an instance of DeployablesVersionsItem from the specified map of raw messages.

func UnmarshalDeployablesVersionsItemTransitionsItem 

func UnmarshalDeployablesVersionsItemTransitionsItem(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDeployablesVersionsItemTransitionsItem unmarshals an instance of DeployablesVersionsItemTransitionsItem from the specified map of raw messages.

func UnmarshalDeployment 

func UnmarshalDeployment(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDeployment unmarshals an instance of Deployment from the specified map of raw messages.

func UnmarshalGetAllowlistResponse added in v0.2.0 

func UnmarshalGetAllowlistResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGetAllowlistResponse unmarshals an instance of GetAllowlistResponse from the specified map of raw messages.

func UnmarshalGetBackupInfoResponse 

func UnmarshalGetBackupInfoResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGetBackupInfoResponse unmarshals an instance of GetBackupInfoResponse from the specified map of raw messages.

func UnmarshalGetConnectionResponse added in v0.2.0 

func UnmarshalGetConnectionResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGetConnectionResponse unmarshals an instance of GetConnectionResponse from the specified map of raw messages.

func UnmarshalGetDefaultScalingGroupsResponse added in v0.2.0 

func UnmarshalGetDefaultScalingGroupsResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGetDefaultScalingGroupsResponse unmarshals an instance of GetDefaultScalingGroupsResponse from the specified map of raw messages.

func UnmarshalGetDeploymentInfoResponse 

func UnmarshalGetDeploymentInfoResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGetDeploymentInfoResponse unmarshals an instance of GetDeploymentInfoResponse from the specified map of raw messages.

func UnmarshalGetPitrDataResponse added in v0.2.0 

func UnmarshalGetPitrDataResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGetPitrDataResponse unmarshals an instance of GetPitrDataResponse from the specified map of raw messages.

func UnmarshalGetTaskResponse 

func UnmarshalGetTaskResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGetTaskResponse unmarshals an instance of GetTaskResponse from the specified map of raw messages.

func UnmarshalGroup 

func UnmarshalGroup(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGroup unmarshals an instance of Group from the specified map of raw messages.

func UnmarshalGroupCPU 

func UnmarshalGroupCPU(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGroupCPU unmarshals an instance of GroupCPU from the specified map of raw messages.

func UnmarshalGroupDisk 

func UnmarshalGroupDisk(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGroupDisk unmarshals an instance of GroupDisk from the specified map of raw messages.

func UnmarshalGroupHostFlavor added in v0.5.0 

func UnmarshalGroupHostFlavor(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGroupHostFlavor unmarshals an instance of GroupHostFlavor from the specified map of raw messages.

func UnmarshalGroupMembers 

func UnmarshalGroupMembers(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGroupMembers unmarshals an instance of GroupMembers from the specified map of raw messages.

func UnmarshalGroupMemory 

func UnmarshalGroupMemory(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGroupMemory unmarshals an instance of GroupMemory from the specified map of raw messages.

func UnmarshalGroupScaling added in v0.2.0 

func UnmarshalGroupScaling(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGroupScaling unmarshals an instance of GroupScaling from the specified map of raw messages.

func UnmarshalGroupScalingCPU added in v0.2.0 

func UnmarshalGroupScalingCPU(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGroupScalingCPU unmarshals an instance of GroupScalingCPU from the specified map of raw messages.

func UnmarshalGroupScalingDisk added in v0.2.0 

func UnmarshalGroupScalingDisk(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGroupScalingDisk unmarshals an instance of GroupScalingDisk from the specified map of raw messages.

func UnmarshalGroupScalingHostFlavor added in v0.5.0 

func UnmarshalGroupScalingHostFlavor(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGroupScalingHostFlavor unmarshals an instance of GroupScalingHostFlavor from the specified map of raw messages.

func UnmarshalGroupScalingMembers added in v0.2.0 

func UnmarshalGroupScalingMembers(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGroupScalingMembers unmarshals an instance of GroupScalingMembers from the specified map of raw messages.

func UnmarshalGroupScalingMemory added in v0.2.0 

func UnmarshalGroupScalingMemory(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalGroupScalingMemory unmarshals an instance of GroupScalingMemory from the specified map of raw messages.

func UnmarshalKillConnectionsResponse 

func UnmarshalKillConnectionsResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalKillConnectionsResponse unmarshals an instance of KillConnectionsResponse from the specified map of raw messages.

func UnmarshalListDeployablesResponse 

func UnmarshalListDeployablesResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalListDeployablesResponse unmarshals an instance of ListDeployablesResponse from the specified map of raw messages.

func UnmarshalListDeploymentScalingGroupsResponse added in v0.2.0 

func UnmarshalListDeploymentScalingGroupsResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalListDeploymentScalingGroupsResponse unmarshals an instance of ListDeploymentScalingGroupsResponse from the specified map of raw messages.

func UnmarshalListRegionsResponse 

func UnmarshalListRegionsResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalListRegionsResponse unmarshals an instance of ListRegionsResponse from the specified map of raw messages.

func UnmarshalListRemotesResponse 

func UnmarshalListRemotesResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalListRemotesResponse unmarshals an instance of ListRemotesResponse from the specified map of raw messages.

func UnmarshalLogicalReplicationSlot added in v0.3.0 

func UnmarshalLogicalReplicationSlot(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalLogicalReplicationSlot unmarshals an instance of LogicalReplicationSlot from the specified map of raw messages.

func UnmarshalMongoDbConnectionURI 

func UnmarshalMongoDbConnectionURI(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalMongoDbConnectionURI unmarshals an instance of MongoDbConnectionURI from the specified map of raw messages.

func UnmarshalMySQLConnectionURI added in v0.2.0 

func UnmarshalMySQLConnectionURI(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalMySQLConnectionURI unmarshals an instance of MySQLConnectionURI from the specified map of raw messages.

func UnmarshalPointInTimeRecoveryData 

func UnmarshalPointInTimeRecoveryData(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalPointInTimeRecoveryData unmarshals an instance of PointInTimeRecoveryData from the specified map of raw messages.

func UnmarshalPostgreSQLConnectionURI 

func UnmarshalPostgreSQLConnectionURI(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalPostgreSQLConnectionURI unmarshals an instance of PostgreSQLConnectionURI from the specified map of raw messages.

func UnmarshalPromoteReadOnlyReplicaResponse added in v0.2.0 

func UnmarshalPromoteReadOnlyReplicaResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalPromoteReadOnlyReplicaResponse unmarshals an instance of PromoteReadOnlyReplicaResponse from the specified map of raw messages.

func UnmarshalRedisConnectionURI 

func UnmarshalRedisConnectionURI(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalRedisConnectionURI unmarshals an instance of RedisConnectionURI from the specified map of raw messages.

func UnmarshalRemotes 

func UnmarshalRemotes(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalRemotes unmarshals an instance of Remotes from the specified map of raw messages.

func UnmarshalResyncReplicaResponse 

func UnmarshalResyncReplicaResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalResyncReplicaResponse unmarshals an instance of ResyncReplicaResponse from the specified map of raw messages.

func UnmarshalSetAllowlistResponse 

func UnmarshalSetAllowlistResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSetAllowlistResponse unmarshals an instance of SetAllowlistResponse from the specified map of raw messages.

func UnmarshalSetAutoscalingConditionsResponse 

func UnmarshalSetAutoscalingConditionsResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSetAutoscalingConditionsResponse unmarshals an instance of SetAutoscalingConditionsResponse from the specified map of raw messages.

func UnmarshalSetDeploymentScalingGroupResponse 

func UnmarshalSetDeploymentScalingGroupResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSetDeploymentScalingGroupResponse unmarshals an instance of SetDeploymentScalingGroupResponse from the specified map of raw messages.

func UnmarshalStartOndemandBackupResponse 

func UnmarshalStartOndemandBackupResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalStartOndemandBackupResponse unmarshals an instance of StartOndemandBackupResponse from the specified map of raw messages.

func UnmarshalTask 

func UnmarshalTask(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalTask unmarshals an instance of Task from the specified map of raw messages.

func UnmarshalTasks 

func UnmarshalTasks(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalTasks unmarshals an instance of Tasks from the specified map of raw messages.

func UnmarshalUpdateDatabaseConfigurationResponse 

func UnmarshalUpdateDatabaseConfigurationResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalUpdateDatabaseConfigurationResponse unmarshals an instance of UpdateDatabaseConfigurationResponse from the specified map of raw messages.

func UnmarshalUpdateUserResponse added in v0.4.0 

func UnmarshalUpdateUserResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalUpdateUserResponse unmarshals an instance of UpdateUserResponse from the specified map of raw messages.

func UnmarshalUser added in v0.2.0 

func UnmarshalUser(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalUser unmarshals an instance of User from the specified map of raw messages.

func UnmarshalUserDatabaseUser added in v0.4.0 

func UnmarshalUserDatabaseUser(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalUserDatabaseUser unmarshals an instance of UserDatabaseUser from the specified map of raw messages.

func UnmarshalUserOpsManagerUser added in v0.4.0 

func UnmarshalUserOpsManagerUser(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalUserOpsManagerUser unmarshals an instance of UserOpsManagerUser from the specified map of raw messages.

func UnmarshalUserRedisDatabaseUser added in v0.4.0 

func UnmarshalUserRedisDatabaseUser(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalUserRedisDatabaseUser unmarshals an instance of UserRedisDatabaseUser from the specified map of raw messages.

func UnmarshalUserUpdate added in v0.4.0 

func UnmarshalUserUpdate(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalUserUpdate unmarshals an instance of UserUpdate from the specified map of raw messages.

func UnmarshalUserUpdatePasswordSetting added in v0.4.0 

func UnmarshalUserUpdatePasswordSetting(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalUserUpdatePasswordSetting unmarshals an instance of UserUpdatePasswordSetting from the specified map of raw messages.

func UnmarshalUserUpdateRedisRoleSetting added in v0.4.0 

func UnmarshalUserUpdateRedisRoleSetting(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalUserUpdateRedisRoleSetting unmarshals an instance of UserUpdateRedisRoleSetting from the specified map of raw messages.

Types

type AddAllowlistEntryOptions 

type AddAllowlistEntryOptions struct {
	// Deployment ID.
	ID *string `json:"id" validate:"required,ne="`

	IPAddress *AllowlistEntry `json:"ip_address,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

AddAllowlistEntryOptions : The AddAllowlistEntry options.

func (*AddAllowlistEntryOptions) SetHeaders 

func (options *AddAllowlistEntryOptions) SetHeaders(param map[string]string) *AddAllowlistEntryOptions

SetHeaders : Allow user to set Headers

func (*AddAllowlistEntryOptions) SetID 

func (_options *AddAllowlistEntryOptions) SetID(id string) *AddAllowlistEntryOptions

SetID : Allow user to set ID

func (*AddAllowlistEntryOptions) SetIPAddress 

func (_options *AddAllowlistEntryOptions) SetIPAddress(ipAddress *AllowlistEntry) *AddAllowlistEntryOptions

SetIPAddress : Allow user to set IPAddress

type AddAllowlistEntryResponse 

type AddAllowlistEntryResponse struct {
	Task *Task `json:"task,omitempty"`
}

AddAllowlistEntryResponse : AddAllowlistEntryResponse struct

type AllowlistEntry 

type AllowlistEntry struct {
	// An IPv4 address or a CIDR range (netmasked IPv4 address).
	Address *string `json:"address,omitempty"`

	// A human readable description of the address or range for identification purposes.
	Description *string `json:"description,omitempty"`
}

AllowlistEntry : AllowlistEntry struct

type AutoscalingCPUGroupCPU 

type AutoscalingCPUGroupCPU struct {
	Scalers map[string]interface{} `json:"scalers,omitempty"`

	Rate *AutoscalingCPUGroupCPURate `json:"rate,omitempty"`
}

AutoscalingCPUGroupCPU : AutoscalingCPUGroupCPU struct

type AutoscalingCPUGroupCPURate 

type AutoscalingCPUGroupCPURate struct {
	IncreasePercent *float64 `json:"increase_percent,omitempty"`

	PeriodSeconds *int64 `json:"period_seconds,omitempty"`

	LimitCountPerMember *int64 `json:"limit_count_per_member,omitempty"`

	Units *string `json:"units,omitempty"`
}

AutoscalingCPUGroupCPURate : AutoscalingCPUGroupCPURate struct

type AutoscalingDiskGroupDisk 

type AutoscalingDiskGroupDisk struct {
	Scalers *AutoscalingDiskGroupDiskScalers `json:"scalers,omitempty"`

	Rate *AutoscalingDiskGroupDiskRate `json:"rate,omitempty"`
}

AutoscalingDiskGroupDisk : AutoscalingDiskGroupDisk struct

type AutoscalingDiskGroupDiskRate 

type AutoscalingDiskGroupDiskRate struct {
	IncreasePercent *float64 `json:"increase_percent,omitempty"`

	PeriodSeconds *int64 `json:"period_seconds,omitempty"`

	LimitMbPerMember *float64 `json:"limit_mb_per_member,omitempty"`

	Units *string `json:"units,omitempty"`
}

AutoscalingDiskGroupDiskRate : AutoscalingDiskGroupDiskRate struct

type AutoscalingDiskGroupDiskScalers 

type AutoscalingDiskGroupDiskScalers struct {
	Capacity *AutoscalingDiskGroupDiskScalersCapacity `json:"capacity,omitempty"`

	IoUtilization *AutoscalingDiskGroupDiskScalersIoUtilization `json:"io_utilization,omitempty"`
}

AutoscalingDiskGroupDiskScalers : AutoscalingDiskGroupDiskScalers struct

type AutoscalingDiskGroupDiskScalersCapacity 

type AutoscalingDiskGroupDiskScalersCapacity struct {
	Enabled *bool `json:"enabled,omitempty"`

	FreeSpaceLessThanPercent *int64 `json:"free_space_less_than_percent,omitempty"`
}

AutoscalingDiskGroupDiskScalersCapacity : AutoscalingDiskGroupDiskScalersCapacity struct

type AutoscalingDiskGroupDiskScalersIoUtilization 

type AutoscalingDiskGroupDiskScalersIoUtilization struct {
	Enabled *bool `json:"enabled,omitempty"`

	OverPeriod *string `json:"over_period,omitempty"`

	AbovePercent *int64 `json:"above_percent,omitempty"`
}

AutoscalingDiskGroupDiskScalersIoUtilization : AutoscalingDiskGroupDiskScalersIoUtilization struct

type AutoscalingGroup 

type AutoscalingGroup struct {
	Autoscaling *AutoscalingGroupAutoscaling `json:"autoscaling" validate:"required"`
}

AutoscalingGroup : AutoscalingGroup struct

type AutoscalingGroupAutoscaling 

type AutoscalingGroupAutoscaling struct {
	Disk *AutoscalingDiskGroupDisk `json:"disk,omitempty"`

	Memory *AutoscalingMemoryGroupMemory `json:"memory,omitempty"`

	CPU *AutoscalingCPUGroupCPU `json:"cpu,omitempty"`
}

AutoscalingGroupAutoscaling : AutoscalingGroupAutoscaling struct

type AutoscalingMemoryGroupMemory 

type AutoscalingMemoryGroupMemory struct {
	Scalers *AutoscalingMemoryGroupMemoryScalers `json:"scalers,omitempty"`

	Rate *AutoscalingMemoryGroupMemoryRate `json:"rate,omitempty"`
}

AutoscalingMemoryGroupMemory : AutoscalingMemoryGroupMemory struct

type AutoscalingMemoryGroupMemoryRate 

type AutoscalingMemoryGroupMemoryRate struct {
	IncreasePercent *float64 `json:"increase_percent,omitempty"`

	PeriodSeconds *int64 `json:"period_seconds,omitempty"`

	LimitMbPerMember *float64 `json:"limit_mb_per_member,omitempty"`

	Units *string `json:"units,omitempty"`
}

AutoscalingMemoryGroupMemoryRate : AutoscalingMemoryGroupMemoryRate struct

type AutoscalingMemoryGroupMemoryScalers 

type AutoscalingMemoryGroupMemoryScalers struct {
	IoUtilization *AutoscalingMemoryGroupMemoryScalersIoUtilization `json:"io_utilization,omitempty"`
}

AutoscalingMemoryGroupMemoryScalers : AutoscalingMemoryGroupMemoryScalers struct

type AutoscalingMemoryGroupMemoryScalersIoUtilization 

type AutoscalingMemoryGroupMemoryScalersIoUtilization struct {
	Enabled *bool `json:"enabled,omitempty"`

	OverPeriod *string `json:"over_period,omitempty"`

	AbovePercent *int64 `json:"above_percent,omitempty"`
}

AutoscalingMemoryGroupMemoryScalersIoUtilization : AutoscalingMemoryGroupMemoryScalersIoUtilization struct

type AutoscalingSetGroupAutoscaling 

type AutoscalingSetGroupAutoscaling struct {
	Disk *AutoscalingDiskGroupDisk `json:"disk,omitempty"`

	Memory *AutoscalingMemoryGroupMemory `json:"memory,omitempty"`

	CPU *AutoscalingCPUGroupCPU `json:"cpu,omitempty"`
}

AutoscalingSetGroupAutoscaling : AutoscalingSetGroupAutoscaling struct Models which "extend" this model: - AutoscalingSetGroupAutoscalingAutoscalingDiskGroup - AutoscalingSetGroupAutoscalingAutoscalingMemoryGroup - AutoscalingSetGroupAutoscalingAutoscalingCPUGroup

type AutoscalingSetGroupAutoscalingAutoscalingCPUGroup 

type AutoscalingSetGroupAutoscalingAutoscalingCPUGroup struct {
	CPU *AutoscalingCPUGroupCPU `json:"cpu,omitempty"`
}

AutoscalingSetGroupAutoscalingAutoscalingCPUGroup : AutoscalingSetGroupAutoscalingAutoscalingCPUGroup struct This model "extends" AutoscalingSetGroupAutoscaling

type AutoscalingSetGroupAutoscalingAutoscalingDiskGroup 

type AutoscalingSetGroupAutoscalingAutoscalingDiskGroup struct {
	Disk *AutoscalingDiskGroupDisk `json:"disk,omitempty"`
}

AutoscalingSetGroupAutoscalingAutoscalingDiskGroup : AutoscalingSetGroupAutoscalingAutoscalingDiskGroup struct This model "extends" AutoscalingSetGroupAutoscaling

type AutoscalingSetGroupAutoscalingAutoscalingMemoryGroup 

type AutoscalingSetGroupAutoscalingAutoscalingMemoryGroup struct {
	Memory *AutoscalingMemoryGroupMemory `json:"memory,omitempty"`
}

AutoscalingSetGroupAutoscalingAutoscalingMemoryGroup : AutoscalingSetGroupAutoscalingAutoscalingMemoryGroup struct This model "extends" AutoscalingSetGroupAutoscaling

type AutoscalingSetGroupAutoscalingIntf 

type AutoscalingSetGroupAutoscalingIntf interface {
	// contains filtered or unexported methods
}

type Backup 

type Backup struct {
	// ID of this backup.
	ID *string `json:"id,omitempty"`

	// ID of the deployment this backup relates to.
	DeploymentID *string `json:"deployment_id,omitempty"`

	// The type of backup.
	Type *string `json:"type,omitempty"`

	// The status of this backup.
	Status *string `json:"status,omitempty"`

	// Is this backup available to download?.
	IsDownloadable *bool `json:"is_downloadable,omitempty"`

	// Can this backup be used to restore an instance?.
	IsRestorable *bool `json:"is_restorable,omitempty"`

	// URI which is currently available for file downloading.
	DownloadLink *string `json:"download_link,omitempty"`

	// Date and time when this backup was created.
	CreatedAt *strfmt.DateTime `json:"created_at,omitempty"`
}

Backup : Backup struct

type Backups 

type Backups struct {
	// An array of backups.
	Backups []Backup `json:"backups,omitempty"`
}

Backups : Backups struct

type CloudDatabasesV5 

type CloudDatabasesV5 struct {
	Service *core.BaseService
}

CloudDatabasesV5 : The IBM Cloud Databases API enables interaction between applications and Cloud Databases database deployments.

Access to the API requires an IAM Bearer Token or an IAM API Key to be presented through bearer authentication.

Deployment IDs are CRNs on the IBM Cloud Databases v5 API platform. No lookup or translation the Compose style UUIDs is needed. The Deployment ID is a traditional UUID on the Compose v5 API platform.

When you use CRNs, remember to URL escape the CRN value as they can include the forward-slash (/) character.

API Version: 5.0.0

func NewCloudDatabasesV5 

func NewCloudDatabasesV5(options *CloudDatabasesV5Options) (service *CloudDatabasesV5, err error)

NewCloudDatabasesV5 : constructs an instance of CloudDatabasesV5 with passed in options.

func NewCloudDatabasesV5UsingExternalConfig 

func NewCloudDatabasesV5UsingExternalConfig(options *CloudDatabasesV5Options) (cloudDatabases *CloudDatabasesV5, err error)

NewCloudDatabasesV5UsingExternalConfig : constructs an instance of CloudDatabasesV5 with passed in options and external configuration.

func (*CloudDatabasesV5) AddAllowlistEntry 

func (cloudDatabases *CloudDatabasesV5) AddAllowlistEntry(addAllowlistEntryOptions *AddAllowlistEntryOptions) (result *AddAllowlistEntryResponse, response *core.DetailedResponse, err error)

AddAllowlistEntry : Add an address or range to the allowlist for a deployment Add an address or range to the allowlist for a deployment.

func (*CloudDatabasesV5) AddAllowlistEntryWithContext 

func (cloudDatabases *CloudDatabasesV5) AddAllowlistEntryWithContext(ctx context.Context, addAllowlistEntryOptions *AddAllowlistEntryOptions) (result *AddAllowlistEntryResponse, response *core.DetailedResponse, err error)

AddAllowlistEntryWithContext is an alternate form of the AddAllowlistEntry method which supports a Context parameter

func (*CloudDatabasesV5) Clone 

func (cloudDatabases *CloudDatabasesV5) Clone() *CloudDatabasesV5

Clone makes a copy of "cloudDatabases" suitable for processing requests.

func (*CloudDatabasesV5) CompleteConnection 

func (cloudDatabases *CloudDatabasesV5) CompleteConnection(completeConnectionOptions *CompleteConnectionOptions) (result *CompleteConnectionResponse, response *core.DetailedResponse, err error)

CompleteConnection : Discover connection information for a deployment for a user with substitutions and an endpoint type Discover connection information for a deployment for a user. Behaves the same as the GET method but substitutes the provided password parameter into the returned connection information.

func (*CloudDatabasesV5) CompleteConnectionWithContext 

func (cloudDatabases *CloudDatabasesV5) CompleteConnectionWithContext(ctx context.Context, completeConnectionOptions *CompleteConnectionOptions) (result *CompleteConnectionResponse, response *core.DetailedResponse, err error)

CompleteConnectionWithContext is an alternate form of the CompleteConnection method which supports a Context parameter

func (*CloudDatabasesV5) CreateDatabaseUser 

func (cloudDatabases *CloudDatabasesV5) CreateDatabaseUser(createDatabaseUserOptions *CreateDatabaseUserOptions) (result *CreateDatabaseUserResponse, response *core.DetailedResponse, err error)

CreateDatabaseUser : Creates a user based on user type Creates a user in the database that can access the database through a connection.

func (*CloudDatabasesV5) CreateDatabaseUserWithContext 

func (cloudDatabases *CloudDatabasesV5) CreateDatabaseUserWithContext(ctx context.Context, createDatabaseUserOptions *CreateDatabaseUserOptions) (result *CreateDatabaseUserResponse, response *core.DetailedResponse, err error)

CreateDatabaseUserWithContext is an alternate form of the CreateDatabaseUser method which supports a Context parameter

func (*CloudDatabasesV5) CreateLogicalReplicationSlot added in v0.3.0 

func (cloudDatabases *CloudDatabasesV5) CreateLogicalReplicationSlot(createLogicalReplicationSlotOptions *CreateLogicalReplicationSlotOptions) (result *CreateLogicalReplicationSlotResponse, response *core.DetailedResponse, err error)

CreateLogicalReplicationSlot : Create a new logical replication slot Creates a new logical replication slot on the specified database. For use with PostgreSQL and wal2json only.

func (*CloudDatabasesV5) CreateLogicalReplicationSlotWithContext added in v0.3.0 

func (cloudDatabases *CloudDatabasesV5) CreateLogicalReplicationSlotWithContext(ctx context.Context, createLogicalReplicationSlotOptions *CreateLogicalReplicationSlotOptions) (result *CreateLogicalReplicationSlotResponse, response *core.DetailedResponse, err error)

CreateLogicalReplicationSlotWithContext is an alternate form of the CreateLogicalReplicationSlot method which supports a Context parameter

func (*CloudDatabasesV5) DeleteAllowlistEntry 

func (cloudDatabases *CloudDatabasesV5) DeleteAllowlistEntry(deleteAllowlistEntryOptions *DeleteAllowlistEntryOptions) (result *DeleteAllowlistEntryResponse, response *core.DetailedResponse, err error)

DeleteAllowlistEntry : Delete an address or range from the allowlist of a deployment Delete an address or range from the allowlist of a deployment.

func (*CloudDatabasesV5) DeleteAllowlistEntryWithContext 

func (cloudDatabases *CloudDatabasesV5) DeleteAllowlistEntryWithContext(ctx context.Context, deleteAllowlistEntryOptions *DeleteAllowlistEntryOptions) (result *DeleteAllowlistEntryResponse, response *core.DetailedResponse, err error)

DeleteAllowlistEntryWithContext is an alternate form of the DeleteAllowlistEntry method which supports a Context parameter

func (*CloudDatabasesV5) DeleteDatabaseUser 

func (cloudDatabases *CloudDatabasesV5) DeleteDatabaseUser(deleteDatabaseUserOptions *DeleteDatabaseUserOptions) (result *DeleteDatabaseUserResponse, response *core.DetailedResponse, err error)

DeleteDatabaseUser : Deletes a user based on user type Removes a user from the deployment.

func (*CloudDatabasesV5) DeleteDatabaseUserWithContext 

func (cloudDatabases *CloudDatabasesV5) DeleteDatabaseUserWithContext(ctx context.Context, deleteDatabaseUserOptions *DeleteDatabaseUserOptions) (result *DeleteDatabaseUserResponse, response *core.DetailedResponse, err error)

DeleteDatabaseUserWithContext is an alternate form of the DeleteDatabaseUser method which supports a Context parameter

func (*CloudDatabasesV5) DeleteLogicalReplicationSlot added in v0.3.0 

func (cloudDatabases *CloudDatabasesV5) DeleteLogicalReplicationSlot(deleteLogicalReplicationSlotOptions *DeleteLogicalReplicationSlotOptions) (result *DeleteLogicalReplicationSlotResponse, response *core.DetailedResponse, err error)

DeleteLogicalReplicationSlot : Delete a logical replication slot Deletes a logical replication slot from a database. For use with PostgreSQL, EnterpriseDB, and wal2json only.

func (*CloudDatabasesV5) DeleteLogicalReplicationSlotWithContext added in v0.3.0 

func (cloudDatabases *CloudDatabasesV5) DeleteLogicalReplicationSlotWithContext(ctx context.Context, deleteLogicalReplicationSlotOptions *DeleteLogicalReplicationSlotOptions) (result *DeleteLogicalReplicationSlotResponse, response *core.DetailedResponse, err error)

DeleteLogicalReplicationSlotWithContext is an alternate form of the DeleteLogicalReplicationSlot method which supports a Context parameter

func (*CloudDatabasesV5) DisableRetries 

func (cloudDatabases *CloudDatabasesV5) DisableRetries()

DisableRetries disables automatic retries for requests invoked for this service instance.

func (*CloudDatabasesV5) EnableRetries 

func (cloudDatabases *CloudDatabasesV5) EnableRetries(maxRetries int, maxRetryInterval time.Duration)

EnableRetries enables automatic retries for requests invoked for this service instance. If either parameter is specified as 0, then a default value is used instead.

func (*CloudDatabasesV5) GetAllowlist 

func (cloudDatabases *CloudDatabasesV5) GetAllowlist(getAllowlistOptions *GetAllowlistOptions) (result *GetAllowlistResponse, response *core.DetailedResponse, err error)

GetAllowlist : Retrieve the allowlisted addresses and ranges for a deployment Retrieve the allowlisted addresses and ranges for a deployment.

func (*CloudDatabasesV5) GetAllowlistWithContext 

func (cloudDatabases *CloudDatabasesV5) GetAllowlistWithContext(ctx context.Context, getAllowlistOptions *GetAllowlistOptions) (result *GetAllowlistResponse, response *core.DetailedResponse, err error)

GetAllowlistWithContext is an alternate form of the GetAllowlist method which supports a Context parameter

func (*CloudDatabasesV5) GetAutoscalingConditions 

func (cloudDatabases *CloudDatabasesV5) GetAutoscalingConditions(getAutoscalingConditionsOptions *GetAutoscalingConditionsOptions) (result *AutoscalingGroup, response *core.DetailedResponse, err error)

GetAutoscalingConditions : Get the autoscaling configuration from a deployment The Autoscaling configuration represents the various conditions that control autoscaling for a deployment. This command allows for the retrieval of all autoscaling conditions for a particular deployment.

func (*CloudDatabasesV5) GetAutoscalingConditionsWithContext 

func (cloudDatabases *CloudDatabasesV5) GetAutoscalingConditionsWithContext(ctx context.Context, getAutoscalingConditionsOptions *GetAutoscalingConditionsOptions) (result *AutoscalingGroup, response *core.DetailedResponse, err error)

GetAutoscalingConditionsWithContext is an alternate form of the GetAutoscalingConditions method which supports a Context parameter

func (*CloudDatabasesV5) GetBackupInfo 

func (cloudDatabases *CloudDatabasesV5) GetBackupInfo(getBackupInfoOptions *GetBackupInfoOptions) (result *GetBackupInfoResponse, response *core.DetailedResponse, err error)

GetBackupInfo : Get information about a backup Get information about a backup, such as creation date.

func (*CloudDatabasesV5) GetBackupInfoWithContext 

func (cloudDatabases *CloudDatabasesV5) GetBackupInfoWithContext(ctx context.Context, getBackupInfoOptions *GetBackupInfoOptions) (result *GetBackupInfoResponse, response *core.DetailedResponse, err error)

GetBackupInfoWithContext is an alternate form of the GetBackupInfo method which supports a Context parameter

func (*CloudDatabasesV5) GetConnection 

func (cloudDatabases *CloudDatabasesV5) GetConnection(getConnectionOptions *GetConnectionOptions) (result *GetConnectionResponse, response *core.DetailedResponse, err error)

GetConnection : Discover connection information for a deployment for a user with an endpoint type Discover connection information for a deployment for a user with an endpoint type.

func (*CloudDatabasesV5) GetConnectionWithContext 

func (cloudDatabases *CloudDatabasesV5) GetConnectionWithContext(ctx context.Context, getConnectionOptions *GetConnectionOptions) (result *GetConnectionResponse, response *core.DetailedResponse, err error)

GetConnectionWithContext is an alternate form of the GetConnection method which supports a Context parameter

func (*CloudDatabasesV5) GetDefaultScalingGroups 

func (cloudDatabases *CloudDatabasesV5) GetDefaultScalingGroups(getDefaultScalingGroupsOptions *GetDefaultScalingGroupsOptions) (result *GetDefaultScalingGroupsResponse, response *core.DetailedResponse, err error)

GetDefaultScalingGroups : Get default scaling groups for a new deployment Scaling groups represent the various resources allocated to a deployment. When a new deployment is created, there are a set of defaults for each database type. This endpoint returns them for a particular database.

func (*CloudDatabasesV5) GetDefaultScalingGroupsWithContext 

func (cloudDatabases *CloudDatabasesV5) GetDefaultScalingGroupsWithContext(ctx context.Context, getDefaultScalingGroupsOptions *GetDefaultScalingGroupsOptions) (result *GetDefaultScalingGroupsResponse, response *core.DetailedResponse, err error)

GetDefaultScalingGroupsWithContext is an alternate form of the GetDefaultScalingGroups method which supports a Context parameter

func (*CloudDatabasesV5) GetDeploymentInfo 

func (cloudDatabases *CloudDatabasesV5) GetDeploymentInfo(getDeploymentInfoOptions *GetDeploymentInfoOptions) (result *GetDeploymentInfoResponse, response *core.DetailedResponse, err error)

GetDeploymentInfo : Get deployment information Gets the full data that is associated with a deployment. This data includes the ID, name, database type, and version.

func (*CloudDatabasesV5) GetDeploymentInfoWithContext 

func (cloudDatabases *CloudDatabasesV5) GetDeploymentInfoWithContext(ctx context.Context, getDeploymentInfoOptions *GetDeploymentInfoOptions) (result *GetDeploymentInfoResponse, response *core.DetailedResponse, err error)

GetDeploymentInfoWithContext is an alternate form of the GetDeploymentInfo method which supports a Context parameter

func (*CloudDatabasesV5) GetEnableGzipCompression 

func (cloudDatabases *CloudDatabasesV5) GetEnableGzipCompression() bool

GetEnableGzipCompression returns the service's EnableGzipCompression field

func (*CloudDatabasesV5) GetPitrData added in v0.2.0 

func (cloudDatabases *CloudDatabasesV5) GetPitrData(getPitrDataOptions *GetPitrDataOptions) (result *GetPitrDataResponse, response *core.DetailedResponse, err error)

GetPitrData : Get earliest point-in-time-recovery timestamp Returns the earliest available time for point-in-time-recovery in ISO8601 UTC format. PostgreSQL and EnterpriseDB only.

func (*CloudDatabasesV5) GetPitrDataWithContext added in v0.2.0 

func (cloudDatabases *CloudDatabasesV5) GetPitrDataWithContext(ctx context.Context, getPitrDataOptions *GetPitrDataOptions) (result *GetPitrDataResponse, response *core.DetailedResponse, err error)

GetPitrDataWithContext is an alternate form of the GetPitrData method which supports a Context parameter

func (*CloudDatabasesV5) GetServiceURL 

func (cloudDatabases *CloudDatabasesV5) GetServiceURL() string

GetServiceURL returns the service URL

func (*CloudDatabasesV5) GetTask 

func (cloudDatabases *CloudDatabasesV5) GetTask(getTaskOptions *GetTaskOptions) (result *GetTaskResponse, response *core.DetailedResponse, err error)

GetTask : Get information about a task Get information about a task and its status. Tasks themselves are persistent so old tasks can be consulted as well as running tasks.

func (*CloudDatabasesV5) GetTaskWithContext 

func (cloudDatabases *CloudDatabasesV5) GetTaskWithContext(ctx context.Context, getTaskOptions *GetTaskOptions) (result *GetTaskResponse, response *core.DetailedResponse, err error)

GetTaskWithContext is an alternate form of the GetTask method which supports a Context parameter

func (*CloudDatabasesV5) KillConnections 

func (cloudDatabases *CloudDatabasesV5) KillConnections(killConnectionsOptions *KillConnectionsOptions) (result *KillConnectionsResponse, response *core.DetailedResponse, err error)

KillConnections : Kill connections to a PostgreSQL or EnterpriseDB deployment Closes all the connections on a deployment. Available for PostgreSQL and EnterpriseDB ONLY.

func (*CloudDatabasesV5) KillConnectionsWithContext 

func (cloudDatabases *CloudDatabasesV5) KillConnectionsWithContext(ctx context.Context, killConnectionsOptions *KillConnectionsOptions) (result *KillConnectionsResponse, response *core.DetailedResponse, err error)

KillConnectionsWithContext is an alternate form of the KillConnections method which supports a Context parameter

func (*CloudDatabasesV5) ListDeployables 

func (cloudDatabases *CloudDatabasesV5) ListDeployables(listDeployablesOptions *ListDeployablesOptions) (result *ListDeployablesResponse, response *core.DetailedResponse, err error)

ListDeployables : List all deployable databases Returns a list of all the types and associated major versions of database deployments that can be provisioned.

func (*CloudDatabasesV5) ListDeployablesWithContext 

func (cloudDatabases *CloudDatabasesV5) ListDeployablesWithContext(ctx context.Context, listDeployablesOptions *ListDeployablesOptions) (result *ListDeployablesResponse, response *core.DetailedResponse, err error)

ListDeployablesWithContext is an alternate form of the ListDeployables method which supports a Context parameter

func (*CloudDatabasesV5) ListDeploymentBackups 

func (cloudDatabases *CloudDatabasesV5) ListDeploymentBackups(listDeploymentBackupsOptions *ListDeploymentBackupsOptions) (result *Backups, response *core.DetailedResponse, err error)

ListDeploymentBackups : List currently available backups from a deployment Get details of all currently available backups from a deployment.

func (*CloudDatabasesV5) ListDeploymentBackupsWithContext 

func (cloudDatabases *CloudDatabasesV5) ListDeploymentBackupsWithContext(ctx context.Context, listDeploymentBackupsOptions *ListDeploymentBackupsOptions) (result *Backups, response *core.DetailedResponse, err error)

ListDeploymentBackupsWithContext is an alternate form of the ListDeploymentBackups method which supports a Context parameter

func (*CloudDatabasesV5) ListDeploymentScalingGroups 

func (cloudDatabases *CloudDatabasesV5) ListDeploymentScalingGroups(listDeploymentScalingGroupsOptions *ListDeploymentScalingGroupsOptions) (result *ListDeploymentScalingGroupsResponse, response *core.DetailedResponse, err error)

ListDeploymentScalingGroups : List currently available scaling groups from a deployment Scaling groups represent the various resources that are allocated to a deployment. This command allows for the retrieval of all of the groups for a particular deployment.

func (*CloudDatabasesV5) ListDeploymentScalingGroupsWithContext 

func (cloudDatabases *CloudDatabasesV5) ListDeploymentScalingGroupsWithContext(ctx context.Context, listDeploymentScalingGroupsOptions *ListDeploymentScalingGroupsOptions) (result *ListDeploymentScalingGroupsResponse, response *core.DetailedResponse, err error)

ListDeploymentScalingGroupsWithContext is an alternate form of the ListDeploymentScalingGroups method which supports a Context parameter

func (*CloudDatabasesV5) ListDeploymentTasks 

func (cloudDatabases *CloudDatabasesV5) ListDeploymentTasks(listDeploymentTasksOptions *ListDeploymentTasksOptions) (result *Tasks, response *core.DetailedResponse, err error)

ListDeploymentTasks : List currently running tasks on a deployment Obtain a list of tasks currently running or recently run on a deployment. Tasks are ephemeral. Records of successful tasks are shown for 24-48 hours, and unsuccessful tasks are shown for 7-8 days.

func (*CloudDatabasesV5) ListDeploymentTasksWithContext 

func (cloudDatabases *CloudDatabasesV5) ListDeploymentTasksWithContext(ctx context.Context, listDeploymentTasksOptions *ListDeploymentTasksOptions) (result *Tasks, response *core.DetailedResponse, err error)

ListDeploymentTasksWithContext is an alternate form of the ListDeploymentTasks method which supports a Context parameter

func (*CloudDatabasesV5) ListRegions 

func (cloudDatabases *CloudDatabasesV5) ListRegions(listRegionsOptions *ListRegionsOptions) (result *ListRegionsResponse, response *core.DetailedResponse, err error)

ListRegions : List all deployable regions Returns a list of all the regions that deployments can be provisioned into from the current region. Used to determine region availability for read-only replicas.

func (*CloudDatabasesV5) ListRegionsWithContext 

func (cloudDatabases *CloudDatabasesV5) ListRegionsWithContext(ctx context.Context, listRegionsOptions *ListRegionsOptions) (result *ListRegionsResponse, response *core.DetailedResponse, err error)

ListRegionsWithContext is an alternate form of the ListRegions method which supports a Context parameter

func (*CloudDatabasesV5) ListRemotes 

func (cloudDatabases *CloudDatabasesV5) ListRemotes(listRemotesOptions *ListRemotesOptions) (result *ListRemotesResponse, response *core.DetailedResponse, err error)

ListRemotes : List read-only replica information Get the read-only replicas associated with a deployment. Available for PostgreSQL and EnterpriseDB ONLY.

func (*CloudDatabasesV5) ListRemotesWithContext 

func (cloudDatabases *CloudDatabasesV5) ListRemotesWithContext(ctx context.Context, listRemotesOptions *ListRemotesOptions) (result *ListRemotesResponse, response *core.DetailedResponse, err error)

ListRemotesWithContext is an alternate form of the ListRemotes method which supports a Context parameter

func (*CloudDatabasesV5) NewAddAllowlistEntryOptions 

func (*CloudDatabasesV5) NewAddAllowlistEntryOptions(id string) *AddAllowlistEntryOptions

NewAddAllowlistEntryOptions : Instantiate AddAllowlistEntryOptions

func (*CloudDatabasesV5) NewCompleteConnectionOptions 

func (*CloudDatabasesV5) NewCompleteConnectionOptions(id string, userType string, userID string, endpointType string) *CompleteConnectionOptions

NewCompleteConnectionOptions : Instantiate CompleteConnectionOptions

func (*CloudDatabasesV5) NewCreateDatabaseUserOptions 

func (*CloudDatabasesV5) NewCreateDatabaseUserOptions(id string, userType string) *CreateDatabaseUserOptions

NewCreateDatabaseUserOptions : Instantiate CreateDatabaseUserOptions

func (*CloudDatabasesV5) NewCreateLogicalReplicationSlotOptions added in v0.3.0 

func (*CloudDatabasesV5) NewCreateLogicalReplicationSlotOptions(id string) *CreateLogicalReplicationSlotOptions

NewCreateLogicalReplicationSlotOptions : Instantiate CreateLogicalReplicationSlotOptions

func (*CloudDatabasesV5) NewDeleteAllowlistEntryOptions 

func (*CloudDatabasesV5) NewDeleteAllowlistEntryOptions(id string, ipaddress string) *DeleteAllowlistEntryOptions

NewDeleteAllowlistEntryOptions : Instantiate DeleteAllowlistEntryOptions

func (*CloudDatabasesV5) NewDeleteDatabaseUserOptions 

func (*CloudDatabasesV5) NewDeleteDatabaseUserOptions(id string, userType string, username string) *DeleteDatabaseUserOptions

NewDeleteDatabaseUserOptions : Instantiate DeleteDatabaseUserOptions

func (*CloudDatabasesV5) NewDeleteLogicalReplicationSlotOptions added in v0.3.0 

func (*CloudDatabasesV5) NewDeleteLogicalReplicationSlotOptions(id string, name string) *DeleteLogicalReplicationSlotOptions

NewDeleteLogicalReplicationSlotOptions : Instantiate DeleteLogicalReplicationSlotOptions

func (*CloudDatabasesV5) NewGetAllowlistOptions 

func (*CloudDatabasesV5) NewGetAllowlistOptions(id string) *GetAllowlistOptions

NewGetAllowlistOptions : Instantiate GetAllowlistOptions

func (*CloudDatabasesV5) NewGetAutoscalingConditionsOptions 

func (*CloudDatabasesV5) NewGetAutoscalingConditionsOptions(id string, groupID string) *GetAutoscalingConditionsOptions

NewGetAutoscalingConditionsOptions : Instantiate GetAutoscalingConditionsOptions

func (*CloudDatabasesV5) NewGetBackupInfoOptions 

func (*CloudDatabasesV5) NewGetBackupInfoOptions(backupID string) *GetBackupInfoOptions

NewGetBackupInfoOptions : Instantiate GetBackupInfoOptions

func (*CloudDatabasesV5) NewGetConnectionOptions 

func (*CloudDatabasesV5) NewGetConnectionOptions(id string, userType string, userID string, endpointType string) *GetConnectionOptions

NewGetConnectionOptions : Instantiate GetConnectionOptions

func (*CloudDatabasesV5) NewGetDefaultScalingGroupsOptions 

func (*CloudDatabasesV5) NewGetDefaultScalingGroupsOptions(typeVar string) *GetDefaultScalingGroupsOptions

NewGetDefaultScalingGroupsOptions : Instantiate GetDefaultScalingGroupsOptions

func (*CloudDatabasesV5) NewGetDeploymentInfoOptions 

func (*CloudDatabasesV5) NewGetDeploymentInfoOptions(id string) *GetDeploymentInfoOptions

NewGetDeploymentInfoOptions : Instantiate GetDeploymentInfoOptions

func (*CloudDatabasesV5) NewGetPitrDataOptions added in v0.2.0 

func (*CloudDatabasesV5) NewGetPitrDataOptions(id string) *GetPitrDataOptions

NewGetPitrDataOptions : Instantiate GetPitrDataOptions

func (*CloudDatabasesV5) NewGetTaskOptions 

func (*CloudDatabasesV5) NewGetTaskOptions(id string) *GetTaskOptions

NewGetTaskOptions : Instantiate GetTaskOptions

func (*CloudDatabasesV5) NewKillConnectionsOptions 

func (*CloudDatabasesV5) NewKillConnectionsOptions(id string) *KillConnectionsOptions

NewKillConnectionsOptions : Instantiate KillConnectionsOptions

func (*CloudDatabasesV5) NewListDeployablesOptions 

func (*CloudDatabasesV5) NewListDeployablesOptions() *ListDeployablesOptions

NewListDeployablesOptions : Instantiate ListDeployablesOptions

func (*CloudDatabasesV5) NewListDeploymentBackupsOptions 

func (*CloudDatabasesV5) NewListDeploymentBackupsOptions(id string) *ListDeploymentBackupsOptions

NewListDeploymentBackupsOptions : Instantiate ListDeploymentBackupsOptions

func (*CloudDatabasesV5) NewListDeploymentScalingGroupsOptions 

func (*CloudDatabasesV5) NewListDeploymentScalingGroupsOptions(id string) *ListDeploymentScalingGroupsOptions

NewListDeploymentScalingGroupsOptions : Instantiate ListDeploymentScalingGroupsOptions

func (*CloudDatabasesV5) NewListDeploymentTasksOptions 

func (*CloudDatabasesV5) NewListDeploymentTasksOptions(id string) *ListDeploymentTasksOptions

NewListDeploymentTasksOptions : Instantiate ListDeploymentTasksOptions

func (*CloudDatabasesV5) NewListRegionsOptions 

func (*CloudDatabasesV5) NewListRegionsOptions() *ListRegionsOptions

NewListRegionsOptions : Instantiate ListRegionsOptions

func (*CloudDatabasesV5) NewListRemotesOptions 

func (*CloudDatabasesV5) NewListRemotesOptions(id string) *ListRemotesOptions

NewListRemotesOptions : Instantiate ListRemotesOptions

func (*CloudDatabasesV5) NewLogicalReplicationSlot added in v0.3.0 

func (*CloudDatabasesV5) NewLogicalReplicationSlot(name string, databaseName string, pluginType string) (_model *LogicalReplicationSlot, err error)

NewLogicalReplicationSlot : Instantiate LogicalReplicationSlot (Generic Model Constructor)

func (*CloudDatabasesV5) NewPromoteReadOnlyReplicaOptions added in v0.2.0 

func (*CloudDatabasesV5) NewPromoteReadOnlyReplicaOptions(id string) *PromoteReadOnlyReplicaOptions

NewPromoteReadOnlyReplicaOptions : Instantiate PromoteReadOnlyReplicaOptions

func (*CloudDatabasesV5) NewResyncReplicaOptions 

func (*CloudDatabasesV5) NewResyncReplicaOptions(id string) *ResyncReplicaOptions

NewResyncReplicaOptions : Instantiate ResyncReplicaOptions

func (*CloudDatabasesV5) NewSetAllowlistOptions 

func (*CloudDatabasesV5) NewSetAllowlistOptions(id string) *SetAllowlistOptions

NewSetAllowlistOptions : Instantiate SetAllowlistOptions

func (*CloudDatabasesV5) NewSetAutoscalingConditionsOptions 

func (*CloudDatabasesV5) NewSetAutoscalingConditionsOptions(id string, groupID string, autoscaling AutoscalingSetGroupAutoscalingIntf) *SetAutoscalingConditionsOptions

NewSetAutoscalingConditionsOptions : Instantiate SetAutoscalingConditionsOptions

func (*CloudDatabasesV5) NewSetDeploymentScalingGroupOptions 

func (*CloudDatabasesV5) NewSetDeploymentScalingGroupOptions(id string, groupID string) *SetDeploymentScalingGroupOptions

NewSetDeploymentScalingGroupOptions : Instantiate SetDeploymentScalingGroupOptions

func (*CloudDatabasesV5) NewStartOndemandBackupOptions 

func (*CloudDatabasesV5) NewStartOndemandBackupOptions(id string) *StartOndemandBackupOptions

NewStartOndemandBackupOptions : Instantiate StartOndemandBackupOptions

func (*CloudDatabasesV5) NewUpdateDatabaseConfigurationOptions 

func (*CloudDatabasesV5) NewUpdateDatabaseConfigurationOptions(id string) *UpdateDatabaseConfigurationOptions

NewUpdateDatabaseConfigurationOptions : Instantiate UpdateDatabaseConfigurationOptions

func (*CloudDatabasesV5) NewUpdateUserOptions added in v0.4.0 

func (*CloudDatabasesV5) NewUpdateUserOptions(id string, userType string, username string) *UpdateUserOptions

NewUpdateUserOptions : Instantiate UpdateUserOptions

func (*CloudDatabasesV5) NewUserDatabaseUser added in v0.4.0 

func (*CloudDatabasesV5) NewUserDatabaseUser(username string, password string) (_model *UserDatabaseUser, err error)

NewUserDatabaseUser : Instantiate UserDatabaseUser (Generic Model Constructor)

func (*CloudDatabasesV5) NewUserOpsManagerUser added in v0.4.0 

func (*CloudDatabasesV5) NewUserOpsManagerUser(username string, password string) (_model *UserOpsManagerUser, err error)

NewUserOpsManagerUser : Instantiate UserOpsManagerUser (Generic Model Constructor)

func (*CloudDatabasesV5) NewUserRedisDatabaseUser added in v0.4.0 

func (*CloudDatabasesV5) NewUserRedisDatabaseUser(username string, password string) (_model *UserRedisDatabaseUser, err error)

NewUserRedisDatabaseUser : Instantiate UserRedisDatabaseUser (Generic Model Constructor)

func (*CloudDatabasesV5) NewUserUpdatePasswordSetting added in v0.4.0 

func (*CloudDatabasesV5) NewUserUpdatePasswordSetting(password string) (_model *UserUpdatePasswordSetting, err error)

NewUserUpdatePasswordSetting : Instantiate UserUpdatePasswordSetting (Generic Model Constructor)

func (*CloudDatabasesV5) NewUserUpdateRedisRoleSetting added in v0.4.0 

func (*CloudDatabasesV5) NewUserUpdateRedisRoleSetting(role string) (_model *UserUpdateRedisRoleSetting, err error)

NewUserUpdateRedisRoleSetting : Instantiate UserUpdateRedisRoleSetting (Generic Model Constructor)

func (*CloudDatabasesV5) PromoteReadOnlyReplica added in v0.2.0 

func (cloudDatabases *CloudDatabasesV5) PromoteReadOnlyReplica(promoteReadOnlyReplicaOptions *PromoteReadOnlyReplicaOptions) (result *PromoteReadOnlyReplicaResponse, response *core.DetailedResponse, err error)

PromoteReadOnlyReplica : Promote read-only replica to a full deployment Promote a read-only replica or upgrade and promote a read-only replica. Available for PostgreSQL and EnterpriseDB ONLY.

func (*CloudDatabasesV5) PromoteReadOnlyReplicaWithContext added in v0.2.0 

func (cloudDatabases *CloudDatabasesV5) PromoteReadOnlyReplicaWithContext(ctx context.Context, promoteReadOnlyReplicaOptions *PromoteReadOnlyReplicaOptions) (result *PromoteReadOnlyReplicaResponse, response *core.DetailedResponse, err error)

PromoteReadOnlyReplicaWithContext is an alternate form of the PromoteReadOnlyReplica method which supports a Context parameter

func (*CloudDatabasesV5) ResyncReplica 

func (cloudDatabases *CloudDatabasesV5) ResyncReplica(resyncReplicaOptions *ResyncReplicaOptions) (result *ResyncReplicaResponse, response *core.DetailedResponse, err error)

ResyncReplica : Resync read-only replica Reinitialize a read-only replica. Available for PostgreSQL and EnterpriseDB ONLY.

func (*CloudDatabasesV5) ResyncReplicaWithContext 

func (cloudDatabases *CloudDatabasesV5) ResyncReplicaWithContext(ctx context.Context, resyncReplicaOptions *ResyncReplicaOptions) (result *ResyncReplicaResponse, response *core.DetailedResponse, err error)

ResyncReplicaWithContext is an alternate form of the ResyncReplica method which supports a Context parameter

func (*CloudDatabasesV5) SetAllowlist 

func (cloudDatabases *CloudDatabasesV5) SetAllowlist(setAllowlistOptions *SetAllowlistOptions) (result *SetAllowlistResponse, response *core.DetailedResponse, err error)

SetAllowlist : Set the allowlist for a deployment Set the allowlist for a deployment. This action overwrites all existing entries, so when you modify the allowlist via a GET/update/PUT, provide the GET response's ETag header value in this endpoint's If-Match header to ensure that changes that are made by other clients are not accidentally overwritten.

func (*CloudDatabasesV5) SetAllowlistWithContext 

func (cloudDatabases *CloudDatabasesV5) SetAllowlistWithContext(ctx context.Context, setAllowlistOptions *SetAllowlistOptions) (result *SetAllowlistResponse, response *core.DetailedResponse, err error)

SetAllowlistWithContext is an alternate form of the SetAllowlist method which supports a Context parameter

func (*CloudDatabasesV5) SetAutoscalingConditions 

func (cloudDatabases *CloudDatabasesV5) SetAutoscalingConditions(setAutoscalingConditionsOptions *SetAutoscalingConditionsOptions) (result *SetAutoscalingConditionsResponse, response *core.DetailedResponse, err error)

SetAutoscalingConditions : Set the autoscaling configuration from a deployment Enable, disable, or set the conditions for autoscaling on your deployment. Memory, disk, and CPU (if available) can be set separately and are not all required.

func (*CloudDatabasesV5) SetAutoscalingConditionsWithContext 

func (cloudDatabases *CloudDatabasesV5) SetAutoscalingConditionsWithContext(ctx context.Context, setAutoscalingConditionsOptions *SetAutoscalingConditionsOptions) (result *SetAutoscalingConditionsResponse, response *core.DetailedResponse, err error)

SetAutoscalingConditionsWithContext is an alternate form of the SetAutoscalingConditions method which supports a Context parameter

func (*CloudDatabasesV5) SetDefaultHeaders 

func (cloudDatabases *CloudDatabasesV5) SetDefaultHeaders(headers http.Header)

SetDefaultHeaders sets HTTP headers to be sent in every request

func (*CloudDatabasesV5) SetDeploymentScalingGroup 

func (cloudDatabases *CloudDatabasesV5) SetDeploymentScalingGroup(setDeploymentScalingGroupOptions *SetDeploymentScalingGroupOptions) (result *SetDeploymentScalingGroupResponse, response *core.DetailedResponse, err error)

SetDeploymentScalingGroup : Set scaling values on a specified group Set scaling value on a specified group. Can only be performed on is_adjustable=true groups. Values set are for the group as a whole and resources are distributed amongst the group. Values must be greater than or equal to the minimum size and must be a multiple of the step size.

func (*CloudDatabasesV5) SetDeploymentScalingGroupWithContext 

func (cloudDatabases *CloudDatabasesV5) SetDeploymentScalingGroupWithContext(ctx context.Context, setDeploymentScalingGroupOptions *SetDeploymentScalingGroupOptions) (result *SetDeploymentScalingGroupResponse, response *core.DetailedResponse, err error)

SetDeploymentScalingGroupWithContext is an alternate form of the SetDeploymentScalingGroup method which supports a Context parameter

func (*CloudDatabasesV5) SetEnableGzipCompression 

func (cloudDatabases *CloudDatabasesV5) SetEnableGzipCompression(enableGzip bool)

SetEnableGzipCompression sets the service's EnableGzipCompression field

func (*CloudDatabasesV5) SetServiceURL 

func (cloudDatabases *CloudDatabasesV5) SetServiceURL(url string) error

SetServiceURL sets the service URL

func (*CloudDatabasesV5) StartOndemandBackup 

func (cloudDatabases *CloudDatabasesV5) StartOndemandBackup(startOndemandBackupOptions *StartOndemandBackupOptions) (result *StartOndemandBackupResponse, response *core.DetailedResponse, err error)

StartOndemandBackup : Initiate an on-demand backup Signal the platform to create an on-demand backup for the specified deployment. The returned task can be polled to track progress of the backup as it takes place.

func (*CloudDatabasesV5) StartOndemandBackupWithContext 

func (cloudDatabases *CloudDatabasesV5) StartOndemandBackupWithContext(ctx context.Context, startOndemandBackupOptions *StartOndemandBackupOptions) (result *StartOndemandBackupResponse, response *core.DetailedResponse, err error)

StartOndemandBackupWithContext is an alternate form of the StartOndemandBackup method which supports a Context parameter

func (*CloudDatabasesV5) UpdateDatabaseConfiguration 

func (cloudDatabases *CloudDatabasesV5) UpdateDatabaseConfiguration(updateDatabaseConfigurationOptions *UpdateDatabaseConfigurationOptions) (result *UpdateDatabaseConfigurationResponse, response *core.DetailedResponse, err error)

UpdateDatabaseConfiguration : Change your database configuration Change your database configuration. Available for PostgreSQL, EnterpriseDB, MySQL, RabbitMQ and Redis ONLY.

func (*CloudDatabasesV5) UpdateDatabaseConfigurationWithContext 

func (cloudDatabases *CloudDatabasesV5) UpdateDatabaseConfigurationWithContext(ctx context.Context, updateDatabaseConfigurationOptions *UpdateDatabaseConfigurationOptions) (result *UpdateDatabaseConfigurationResponse, response *core.DetailedResponse, err error)

UpdateDatabaseConfigurationWithContext is an alternate form of the UpdateDatabaseConfiguration method which supports a Context parameter

func (*CloudDatabasesV5) UpdateUser added in v0.4.0 

func (cloudDatabases *CloudDatabasesV5) UpdateUser(updateUserOptions *UpdateUserOptions) (result *UpdateUserResponse, response *core.DetailedResponse, err error)

UpdateUser : Update a user's password or role Sets the password or role of a specified user. Updating roles is only supported for Redis 6.0 or greater.

func (*CloudDatabasesV5) UpdateUserWithContext added in v0.4.0 

func (cloudDatabases *CloudDatabasesV5) UpdateUserWithContext(ctx context.Context, updateUserOptions *UpdateUserOptions) (result *UpdateUserResponse, response *core.DetailedResponse, err error)

UpdateUserWithContext is an alternate form of the UpdateUser method which supports a Context parameter

type CloudDatabasesV5Options 

type CloudDatabasesV5Options struct {
	ServiceName   string
	URL           string
	Authenticator core.Authenticator
}

CloudDatabasesV5Options : Service options

type CompleteConnectionOptions 

type CompleteConnectionOptions struct {
	// Deployment ID.
	ID *string `json:"id" validate:"required,ne="`

	// User type of `database` is the only currently supported value.
	UserType *string `json:"user_type" validate:"required,ne="`

	// User ID.
	UserID *string `json:"user_id" validate:"required,ne="`

	// Endpoint Type. The select endpoint must be enabled on the deployment before its connection information can be
	// fetched.
	EndpointType *string `json:"endpoint_type" validate:"required,ne="`

	// Password to be substituted into the response.
	Password *string `json:"password,omitempty"`

	// Optional certificate root path to prepend certificate names. Certificates would be stored in this directory for use
	// by other commands.
	CertificateRoot *string `json:"certificate_root,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

CompleteConnectionOptions : The CompleteConnection options.

func (*CompleteConnectionOptions) SetCertificateRoot 

func (_options *CompleteConnectionOptions) SetCertificateRoot(certificateRoot string) *CompleteConnectionOptions

SetCertificateRoot : Allow user to set CertificateRoot

func (*CompleteConnectionOptions) SetEndpointType 

func (_options *CompleteConnectionOptions) SetEndpointType(endpointType string) *CompleteConnectionOptions

SetEndpointType : Allow user to set EndpointType

func (*CompleteConnectionOptions) SetHeaders 

func (options *CompleteConnectionOptions) SetHeaders(param map[string]string) *CompleteConnectionOptions

SetHeaders : Allow user to set Headers

func (*CompleteConnectionOptions) SetID 

func (_options *CompleteConnectionOptions) SetID(id string) *CompleteConnectionOptions

SetID : Allow user to set ID

func (*CompleteConnectionOptions) SetPassword 

func (_options *CompleteConnectionOptions) SetPassword(password string) *CompleteConnectionOptions

SetPassword : Allow user to set Password

func (*CompleteConnectionOptions) SetUserID 

func (_options *CompleteConnectionOptions) SetUserID(userID string) *CompleteConnectionOptions

SetUserID : Allow user to set UserID

func (*CompleteConnectionOptions) SetUserType 

func (_options *CompleteConnectionOptions) SetUserType(userType string) *CompleteConnectionOptions

SetUserType : Allow user to set UserType

type CompleteConnectionResponse added in v0.2.0 

type CompleteConnectionResponse struct {
	Connection ConnectionIntf `json:"connection,omitempty"`
}

CompleteConnectionResponse : CompleteConnectionResponse struct

type Configuration added in v0.2.0 

type Configuration struct {
	// The number of seconds to wait before forces a switch to the next WAL file if a new file has not been started.
	ArchiveTimeout *int64 `json:"archive_timeout,omitempty"`

	// Deadlock timeout in ms. The time to wait on a lock before checking for deadlock.  Also the duration where lock waits
	// will be logged.
	DeadlockTimeout *int64 `json:"deadlock_timeout,omitempty"`

	// Number of simultaneous requests that can be handled efficiently by the disk subsystem.
	EffectiveIoConcurrency *int64 `json:"effective_io_concurrency,omitempty"`

	// Causes each attempted connection to the server to be logged, as well as successful completion of client
	// authentication.
	LogConnections *string `json:"log_connections,omitempty"`

	// Causes session terminations to be logged. The log output provides information similar to log_connections, plus the
	// duration of the session.
	LogDisconnections *string `json:"log_disconnections,omitempty"`

	// The minimum number of milliseconds for execution time above which statements will be logged.
	LogMinDurationStatement *int64 `json:"log_min_duration_statement,omitempty"`

	// Maximum connections allowed.
	MaxConnections *int64 `json:"max_connections,omitempty"`

	// This parameter limits the average number of object locks used by each transaction.
	MaxLocksPerTransaction *int64 `json:"max_locks_per_transaction,omitempty"`

	// Max number of transactions that can be in the "prepared" state simultaneously.
	MaxPreparedTransactions *int64 `json:"max_prepared_transactions,omitempty"`

	// Maximum number of simultaneously defined replication slots.
	MaxReplicationSlots *int64 `json:"max_replication_slots,omitempty"`

	// Maximum number of simultaneously running WAL sender processes.
	MaxWalSenders *int64 `json:"max_wal_senders,omitempty"`

	// The number of 8kB shared memory buffers used by the server.  Set to 1/4 of memory.  Setting too high will cause
	// crashes or prevent the database from starting.
	SharedBuffers *int64 `json:"shared_buffers,omitempty"`

	// Sets the current transaction's synchronization level.  Off can result in data loss.  remote_write with enable
	// synchronous replication which will impact performance and availabilty.
	SynchronousCommit *string `json:"synchronous_commit,omitempty"`

	// The number of TCP keepalives that can be lost before the server's connection to the client is considered dead.
	TCPKeepalivesCount *int64 `json:"tcp_keepalives_count,omitempty"`

	// The number of seconds of inactivity after which TCP should send a keepalive message to the client.
	TCPKeepalivesIdle *int64 `json:"tcp_keepalives_idle,omitempty"`

	// The number of seconds after which a TCP keepalive message that is not acknowledged by the client should be
	// retransmitted.
	TCPKeepalivesInterval *int64 `json:"tcp_keepalives_interval,omitempty"`

	// Controls WAL level. Allowed values are replica or logical. Set to logical to use logical decoding. If you are not
	// using logical decoding, using logical increases the WAL size, which has several disadvantages and no real advantage.
	WalLevel *string `json:"wal_level,omitempty"`

	// The maximum memory Redis should use, as bytes.
	Maxmemory *int64 `json:"maxmemory,omitempty"`

	// The policy with which Redis evicts keys when maximum memory is reached.
	MaxmemoryPolicy *string `json:"maxmemory-policy,omitempty"`

	// If set to yes this will enable AOF persistence.
	Appendonly *string `json:"appendonly,omitempty"`

	// The maximum memory Redis should use, as bytes.
	MaxmemorySamples *int64 `json:"maxmemory-samples,omitempty"`

	// Whether or not to stop accepting writes when background persistence actions fail.
	StopWritesOnBgsaveError *string `json:"stop-writes-on-bgsave-error,omitempty"`

	// Automatically delete undefined queues.
	DeleteUndefinedQueues *bool `json:"delete_undefined_queues,omitempty"`

	// Determines which authentication plugin the server assigns to new accounts created by CREATE USER and GRANT
	// statements that do not explicitly specify an authentication plugin.
	DefaultAuthenticationPlugin *string `json:"default_authentication_plugin,omitempty"`

	// Percentage of memory to use for innodb_buffer_pool_size.
	InnodbBufferPoolSizePercentage *int64 `json:"innodb_buffer_pool_size_percentage,omitempty"`

	// Controls the balance between strict ACID compliance for commit operations and higher performance. See official MySQL
	// documentation for more details.
	InnodbFlushLogAtTrxCommit *int64 `json:"innodb_flush_log_at_trx_commit,omitempty"`

	// InnoDB log buffer size in bytes.
	InnodbLogBufferSize *int64 `json:"innodb_log_buffer_size,omitempty"`

	// InnoDB log file size in bytes.
	InnodbLogFileSize *int64 `json:"innodb_log_file_size,omitempty"`

	// An InnoDB MySQL option that may affect performance. Check official MySQL documentation for a detailed description of
	// this option's use cases.
	InnodbLruScanDepth *int64 `json:"innodb_lru_scan_depth,omitempty"`

	// The number of I/O Threads for read operations in InnoDB.
	InnodbReadIoThreads *int64 `json:"innodb_read_io_threads,omitempty"`

	// The number of I/O Threads for write operations in InnoDB.
	InnodbWriteIoThreads *int64 `json:"innodb_write_io_threads,omitempty"`

	// The maximum size of a packet message buffer in bytes.
	MaxAllowedPacket *int64 `json:"max_allowed_packet,omitempty"`

	// Maximum age for a binlog in seconds. If a binlog is older, it's archived.
	MysqlMaxBinlogAgeSec *int64 `json:"mysql_max_binlog_age_sec,omitempty"`

	// The number of seconds to wait for more data from a connection before aborting the read.
	NetReadTimeout *int64 `json:"net_read_timeout,omitempty"`

	// The number of seconds to wait for a block to be written to a connection before aborting the write.
	NetWriteTimeout *int64 `json:"net_write_timeout,omitempty"`

	// The comma-separated list of SQL modes applied on this server globally.
	SQLMode *string `json:"sql_mode,omitempty"`

	// The number of seconds the server waits for activity on a noninteractive connection before closing it.
	WaitTimeout *int64 `json:"wait_timeout,omitempty"`

	// This variable limits the total number of prepared statements in the server.
	MaxPreparedStmtCount *int64 `json:"max_prepared_stmt_count,omitempty"`
}

Configuration : Configuration struct Models which "extend" this model: - ConfigurationPgConfiguration - ConfigurationRedisConfiguration - ConfigurationRabbitMqConfiguration - ConfigurationMySQLConfiguration

type ConfigurationIntf added in v0.2.0 

type ConfigurationIntf interface {
	// contains filtered or unexported methods
}

type ConfigurationMySQLConfiguration added in v0.2.0 

type ConfigurationMySQLConfiguration struct {
	// Determines which authentication plugin the server assigns to new accounts created by CREATE USER and GRANT
	// statements that do not explicitly specify an authentication plugin.
	DefaultAuthenticationPlugin *string `json:"default_authentication_plugin,omitempty"`

	// Percentage of memory to use for innodb_buffer_pool_size.
	InnodbBufferPoolSizePercentage *int64 `json:"innodb_buffer_pool_size_percentage,omitempty"`

	// Controls the balance between strict ACID compliance for commit operations and higher performance. See official MySQL
	// documentation for more details.
	InnodbFlushLogAtTrxCommit *int64 `json:"innodb_flush_log_at_trx_commit,omitempty"`

	// InnoDB log buffer size in bytes.
	InnodbLogBufferSize *int64 `json:"innodb_log_buffer_size,omitempty"`

	// InnoDB log file size in bytes.
	InnodbLogFileSize *int64 `json:"innodb_log_file_size,omitempty"`

	// An InnoDB MySQL option that may affect performance. Check official MySQL documentation for a detailed description of
	// this option's use cases.
	InnodbLruScanDepth *int64 `json:"innodb_lru_scan_depth,omitempty"`

	// The number of I/O Threads for read operations in InnoDB.
	InnodbReadIoThreads *int64 `json:"innodb_read_io_threads,omitempty"`

	// The number of I/O Threads for write operations in InnoDB.
	InnodbWriteIoThreads *int64 `json:"innodb_write_io_threads,omitempty"`

	// The maximum size of a packet message buffer in bytes.
	MaxAllowedPacket *int64 `json:"max_allowed_packet,omitempty"`

	// Maximum number of allowed MySQL connections.
	MaxConnections *int64 `json:"max_connections,omitempty"`

	// Maximum age for a binlog in seconds. If a binlog is older, it's archived.
	MysqlMaxBinlogAgeSec *int64 `json:"mysql_max_binlog_age_sec,omitempty"`

	// The number of seconds to wait for more data from a connection before aborting the read.
	NetReadTimeout *int64 `json:"net_read_timeout,omitempty"`

	// The number of seconds to wait for a block to be written to a connection before aborting the write.
	NetWriteTimeout *int64 `json:"net_write_timeout,omitempty"`

	// The comma-separated list of SQL modes applied on this server globally.
	SQLMode *string `json:"sql_mode,omitempty"`

	// The number of seconds the server waits for activity on a noninteractive connection before closing it.
	WaitTimeout *int64 `json:"wait_timeout,omitempty"`

	// This variable limits the total number of prepared statements in the server.
	MaxPreparedStmtCount *int64 `json:"max_prepared_stmt_count,omitempty"`
}

ConfigurationMySQLConfiguration : MySQL Configuration. This model "extends" Configuration

type ConfigurationPgConfiguration added in v0.2.0 

type ConfigurationPgConfiguration struct {
	// The number of seconds to wait before forces a switch to the next WAL file if a new file has not been started.
	ArchiveTimeout *int64 `json:"archive_timeout,omitempty"`

	// Deadlock timeout in ms. The time to wait on a lock before checking for deadlock.  Also the duration where lock waits
	// will be logged.
	DeadlockTimeout *int64 `json:"deadlock_timeout,omitempty"`

	// Number of simultaneous requests that can be handled efficiently by the disk subsystem.
	EffectiveIoConcurrency *int64 `json:"effective_io_concurrency,omitempty"`

	// Causes each attempted connection to the server to be logged, as well as successful completion of client
	// authentication.
	LogConnections *string `json:"log_connections,omitempty"`

	// Causes session terminations to be logged. The log output provides information similar to log_connections, plus the
	// duration of the session.
	LogDisconnections *string `json:"log_disconnections,omitempty"`

	// The minimum number of milliseconds for execution time above which statements will be logged.
	LogMinDurationStatement *int64 `json:"log_min_duration_statement,omitempty"`

	// Maximum connections allowed.
	MaxConnections *int64 `json:"max_connections,omitempty"`

	// This parameter limits the average number of object locks used by each transaction.
	MaxLocksPerTransaction *int64 `json:"max_locks_per_transaction,omitempty"`

	// Max number of transactions that can be in the "prepared" state simultaneously.
	MaxPreparedTransactions *int64 `json:"max_prepared_transactions,omitempty"`

	// Maximum number of simultaneously defined replication slots.
	MaxReplicationSlots *int64 `json:"max_replication_slots,omitempty"`

	// Maximum number of simultaneously running WAL sender processes.
	MaxWalSenders *int64 `json:"max_wal_senders,omitempty"`

	// The number of 8kB shared memory buffers used by the server.  Set to 1/4 of memory.  Setting too high will cause
	// crashes or prevent the database from starting.
	SharedBuffers *int64 `json:"shared_buffers,omitempty"`

	// Sets the current transaction's synchronization level.  Off can result in data loss.  remote_write with enable
	// synchronous replication which will impact performance and availabilty.
	SynchronousCommit *string `json:"synchronous_commit,omitempty"`

	// The number of TCP keepalives that can be lost before the server's connection to the client is considered dead.
	TCPKeepalivesCount *int64 `json:"tcp_keepalives_count,omitempty"`

	// The number of seconds of inactivity after which TCP should send a keepalive message to the client.
	TCPKeepalivesIdle *int64 `json:"tcp_keepalives_idle,omitempty"`

	// The number of seconds after which a TCP keepalive message that is not acknowledged by the client should be
	// retransmitted.
	TCPKeepalivesInterval *int64 `json:"tcp_keepalives_interval,omitempty"`

	// Controls WAL level. Allowed values are replica or logical. Set to logical to use logical decoding. If you are not
	// using logical decoding, using logical increases the WAL size, which has several disadvantages and no real advantage.
	WalLevel *string `json:"wal_level,omitempty"`
}

ConfigurationPgConfiguration : PostgreSQL and EnterpriseDB Configuration. This model "extends" Configuration

type ConfigurationRabbitMqConfiguration added in v0.3.1 

type ConfigurationRabbitMqConfiguration struct {
	// Automatically delete undefined queues.
	DeleteUndefinedQueues *bool `json:"delete_undefined_queues,omitempty"`
}

ConfigurationRabbitMqConfiguration : MySQL Configuration. This model "extends" Configuration

type ConfigurationRedisConfiguration added in v0.2.0 

type ConfigurationRedisConfiguration struct {
	// The maximum memory Redis should use, as bytes.
	Maxmemory *int64 `json:"maxmemory,omitempty"`

	// The policy with which Redis evicts keys when maximum memory is reached.
	MaxmemoryPolicy *string `json:"maxmemory-policy,omitempty"`

	// If set to yes this will enable AOF persistence.
	Appendonly *string `json:"appendonly,omitempty"`

	// The maximum memory Redis should use, as bytes.
	MaxmemorySamples *int64 `json:"maxmemory-samples,omitempty"`

	// Whether or not to stop accepting writes when background persistence actions fail.
	StopWritesOnBgsaveError *string `json:"stop-writes-on-bgsave-error,omitempty"`
}

ConfigurationRedisConfiguration : Redis Configuration. This model "extends" Configuration

type Connection 

type Connection struct {
	Postgres *PostgreSQLConnectionURI `json:"postgres,omitempty"`

	// CLI Connection.
	Cli *ConnectionCli `json:"cli,omitempty"`

	Rediss *RedisConnectionURI `json:"rediss,omitempty"`

	HTTPS *ConnectionURI `json:"https,omitempty"`

	Amqps *ConnectionURI `json:"amqps,omitempty"`

	Mqtts *ConnectionURI `json:"mqtts,omitempty"`

	StompSsl *ConnectionURI `json:"stomp_ssl,omitempty"`

	Grpc *ConnectionURI `json:"grpc,omitempty"`

	Mongodb *MongoDbConnectionURI `json:"mongodb,omitempty"`

	BiConnector *ConnectionURI `json:"bi_connector,omitempty"`

	Analytics *ConnectionURI `json:"analytics,omitempty"`

	OpsManager *ConnectionURI `json:"ops_manager,omitempty"`

	Mysql *MySQLConnectionURI `json:"mysql,omitempty"`

	Emp *ConnectionURI `json:"emp,omitempty"`
}

Connection : Connection struct Models which "extend" this model: - ConnectionPostgreSQLConnection - ConnectionRedisConnection - ConnectionElasticsearchConnection - ConnectionRabbitMqConnection - ConnectionEtcdConnection - ConnectionMongoDbConnection - ConnectionMongoDbeeConnection - ConnectionMongoDbeeOpsManagerConnection - ConnectionMySQLConnection - ConnectionEnterpriseDbConnection

type ConnectionAuthentication added in v0.2.0 

type ConnectionAuthentication struct {
	// Authentication method for this credential.
	Method *string `json:"method,omitempty"`

	// Username part of credential.
	Username *string `json:"username,omitempty"`

	// Password part of credential.
	Password *string `json:"password,omitempty"`
}

ConnectionAuthentication : Authentication data for Connection String.

type ConnectionCertificate added in v0.2.0 

type ConnectionCertificate struct {
	// Name associated with the certificate.
	Name *string `json:"name,omitempty"`

	// Base64 encoded version of the certificate.
	CertificateBase64 *string `json:"certificate_base64,omitempty"`
}

ConnectionCertificate : ConnectionCertificate struct

type ConnectionCli 

type ConnectionCli struct {
	// Type of connection being described.
	Type *string `json:"type,omitempty"`

	Composed []string `json:"composed,omitempty"`

	// A map of environment variables for a CLI connection.
	Environment map[string]interface{} `json:"environment,omitempty"`

	// The name of the executable the CLI should run.
	Bin *string `json:"bin,omitempty"`

	// Sets of arguments to call the executable with. The outer array corresponds to a possible way to call the CLI; the
	// inner array is the set of arguments to use with that call.
	Arguments [][]string `json:"arguments,omitempty"`

	Certificate *ConnectionCertificate `json:"certificate,omitempty"`
}

ConnectionCli : CLI Connection.

type ConnectionElasticsearchConnection added in v0.2.0 

type ConnectionElasticsearchConnection struct {
	HTTPS *ConnectionURI `json:"https" validate:"required"`

	// CLI Connection.
	Cli *ConnectionCli `json:"cli" validate:"required"`
}

ConnectionElasticsearchConnection : Elasticsearch Connection Strings. This model "extends" Connection

type ConnectionEnterpriseDbConnection added in v0.2.0 

type ConnectionEnterpriseDbConnection struct {
	Postgres *PostgreSQLConnectionURI `json:"postgres" validate:"required"`

	Emp *ConnectionURI `json:"emp" validate:"required"`

	// CLI Connection.
	Cli *ConnectionCli `json:"cli" validate:"required"`
}

ConnectionEnterpriseDbConnection : PostgreSQL and EnterpriseDB Connection Strings. This model "extends" Connection

type ConnectionEtcdConnection added in v0.2.0 

type ConnectionEtcdConnection struct {
	Grpc *ConnectionURI `json:"grpc" validate:"required"`

	// CLI Connection.
	Cli *ConnectionCli `json:"cli" validate:"required"`
}

ConnectionEtcdConnection : etcd3 Connection Strings. This model "extends" Connection

type ConnectionHost added in v0.2.0 

type ConnectionHost struct {
	// Hostname for connection.
	Hostname *string `json:"hostname,omitempty"`

	// Port number for connection.
	Port *int64 `json:"port,omitempty"`
}

ConnectionHost : Connection hostname and port.

type ConnectionIntf added in v0.2.0 

type ConnectionIntf interface {
	// contains filtered or unexported methods
}

type ConnectionMongoDbConnection added in v0.2.0 

type ConnectionMongoDbConnection struct {
	Mongodb *MongoDbConnectionURI `json:"mongodb" validate:"required"`

	// CLI Connection.
	Cli *ConnectionCli `json:"cli" validate:"required"`
}

ConnectionMongoDbConnection : MongoDB Connection Strings. This model "extends" Connection

type ConnectionMongoDbeeConnection added in v0.2.0 

type ConnectionMongoDbeeConnection struct {
	Mongodb *MongoDbConnectionURI `json:"mongodb" validate:"required"`

	// CLI Connection.
	Cli *ConnectionCli `json:"cli" validate:"required"`

	BiConnector *ConnectionURI `json:"bi_connector,omitempty"`

	Analytics *ConnectionURI `json:"analytics,omitempty"`
}

ConnectionMongoDbeeConnection : MongoDB Connection Strings. This model "extends" Connection

type ConnectionMongoDbeeOpsManagerConnection added in v0.2.0 

type ConnectionMongoDbeeOpsManagerConnection struct {
	OpsManager *ConnectionURI `json:"ops_manager,omitempty"`
}

ConnectionMongoDbeeOpsManagerConnection : MongoDB Connection Strings. This model "extends" Connection

type ConnectionMySQLConnection added in v0.2.0 

type ConnectionMySQLConnection struct {
	Mysql *MySQLConnectionURI `json:"mysql" validate:"required"`

	// CLI Connection.
	Cli *ConnectionCli `json:"cli" validate:"required"`
}

ConnectionMySQLConnection : MySQL Connection Strings. This model "extends" Connection

type ConnectionPostgreSQLConnection added in v0.2.0 

type ConnectionPostgreSQLConnection struct {
	Postgres *PostgreSQLConnectionURI `json:"postgres" validate:"required"`

	// CLI Connection.
	Cli *ConnectionCli `json:"cli" validate:"required"`
}

ConnectionPostgreSQLConnection : PostgreSQL and EnterpriseDB Connection Strings. This model "extends" Connection

type ConnectionRabbitMqConnection added in v0.2.0 

type ConnectionRabbitMqConnection struct {
	Amqps *ConnectionURI `json:"amqps" validate:"required"`

	Mqtts *ConnectionURI `json:"mqtts" validate:"required"`

	StompSsl *ConnectionURI `json:"stomp_ssl" validate:"required"`

	HTTPS *ConnectionURI `json:"https" validate:"required"`

	// CLI Connection.
	Cli *ConnectionCli `json:"cli" validate:"required"`
}

ConnectionRabbitMqConnection : RabbitMQ Connection Strings. This model "extends" Connection

type ConnectionRedisConnection added in v0.2.0 

type ConnectionRedisConnection struct {
	Rediss *RedisConnectionURI `json:"rediss" validate:"required"`

	// CLI Connection.
	Cli *ConnectionCli `json:"cli" validate:"required"`
}

ConnectionRedisConnection : Redis Connection Strings. This model "extends" Connection

type ConnectionURI added in v0.2.0 

type ConnectionURI struct {
	// Type of connection being described.
	Type *string `json:"type,omitempty"`

	Composed []string `json:"composed,omitempty"`

	// Scheme/protocol for URI connection.
	Scheme *string `json:"scheme,omitempty"`

	Hosts []ConnectionHost `json:"hosts,omitempty"`

	// Path for URI connection.
	Path *string `json:"path,omitempty"`

	// Query options to add to the URI connection.
	QueryOptions map[string]interface{} `json:"query_options,omitempty"`

	// Authentication data for Connection String.
	Authentication *ConnectionAuthentication `json:"authentication,omitempty"`

	Certificate *ConnectionCertificate `json:"certificate,omitempty"`

	// Indicates ssl is required for the connection.
	Ssl *bool `json:"ssl,omitempty"`

	// Indicates the address is accessible by browser.
	BrowserAccessible *bool `json:"browser_accessible,omitempty"`
}

ConnectionURI : ConnectionURI struct

type CreateDatabaseUserOptions 

type CreateDatabaseUserOptions struct {
	// Deployment ID.
	ID *string `json:"id" validate:"required,ne="`

	// User type.
	UserType *string `json:"user_type" validate:"required,ne="`

	User UserIntf `json:"user,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

CreateDatabaseUserOptions : The CreateDatabaseUser options.

func (*CreateDatabaseUserOptions) SetHeaders 

func (options *CreateDatabaseUserOptions) SetHeaders(param map[string]string) *CreateDatabaseUserOptions

SetHeaders : Allow user to set Headers

func (*CreateDatabaseUserOptions) SetID 

func (_options *CreateDatabaseUserOptions) SetID(id string) *CreateDatabaseUserOptions

SetID : Allow user to set ID

func (*CreateDatabaseUserOptions) SetUser 

func (_options *CreateDatabaseUserOptions) SetUser(user UserIntf) *CreateDatabaseUserOptions

SetUser : Allow user to set User

func (*CreateDatabaseUserOptions) SetUserType 

func (_options *CreateDatabaseUserOptions) SetUserType(userType string) *CreateDatabaseUserOptions

SetUserType : Allow user to set UserType

type CreateDatabaseUserResponse 

type CreateDatabaseUserResponse struct {
	Task *Task `json:"task,omitempty"`
}

CreateDatabaseUserResponse : CreateDatabaseUserResponse struct

type CreateLogicalReplicationSlotOptions added in v0.3.0 

type CreateLogicalReplicationSlotOptions struct {
	// Deployment ID.
	ID *string `json:"id" validate:"required,ne="`

	LogicalReplicationSlot *LogicalReplicationSlot `json:"logical_replication_slot,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

CreateLogicalReplicationSlotOptions : The CreateLogicalReplicationSlot options.

func (*CreateLogicalReplicationSlotOptions) SetHeaders added in v0.3.0 

func (options *CreateLogicalReplicationSlotOptions) SetHeaders(param map[string]string) *CreateLogicalReplicationSlotOptions

SetHeaders : Allow user to set Headers

func (*CreateLogicalReplicationSlotOptions) SetID added in v0.3.0 

func (_options *CreateLogicalReplicationSlotOptions) SetID(id string) *CreateLogicalReplicationSlotOptions

SetID : Allow user to set ID

func (*CreateLogicalReplicationSlotOptions) SetLogicalReplicationSlot added in v0.3.0 

func (_options *CreateLogicalReplicationSlotOptions) SetLogicalReplicationSlot(logicalReplicationSlot *LogicalReplicationSlot) *CreateLogicalReplicationSlotOptions

SetLogicalReplicationSlot : Allow user to set LogicalReplicationSlot

type CreateLogicalReplicationSlotResponse added in v0.3.0 

type CreateLogicalReplicationSlotResponse struct {
	Task *Task `json:"task,omitempty"`
}

CreateLogicalReplicationSlotResponse : CreateLogicalReplicationSlotResponse struct

type DeleteAllowlistEntryOptions 

type DeleteAllowlistEntryOptions struct {
	// Deployment ID.
	ID *string `json:"id" validate:"required,ne="`

	// An IPv4 address or a CIDR range (netmasked IPv4 address).
	Ipaddress *string `json:"ipaddress" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

DeleteAllowlistEntryOptions : The DeleteAllowlistEntry options.

func (*DeleteAllowlistEntryOptions) SetHeaders 

func (options *DeleteAllowlistEntryOptions) SetHeaders(param map[string]string) *DeleteAllowlistEntryOptions

SetHeaders : Allow user to set Headers

func (*DeleteAllowlistEntryOptions) SetID 

func (_options *DeleteAllowlistEntryOptions) SetID(id string) *DeleteAllowlistEntryOptions

SetID : Allow user to set ID

func (*DeleteAllowlistEntryOptions) SetIpaddress 

func (_options *DeleteAllowlistEntryOptions) SetIpaddress(ipaddress string) *DeleteAllowlistEntryOptions

SetIpaddress : Allow user to set Ipaddress

type DeleteAllowlistEntryResponse 

type DeleteAllowlistEntryResponse struct {
	Task *Task `json:"task,omitempty"`
}

DeleteAllowlistEntryResponse : DeleteAllowlistEntryResponse struct

type DeleteDatabaseUserOptions 

type DeleteDatabaseUserOptions struct {
	// Deployment ID.
	ID *string `json:"id" validate:"required,ne="`

	// User type.
	UserType *string `json:"user_type" validate:"required,ne="`

	// Username.
	Username *string `json:"username" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

DeleteDatabaseUserOptions : The DeleteDatabaseUser options.

func (*DeleteDatabaseUserOptions) SetHeaders 

func (options *DeleteDatabaseUserOptions) SetHeaders(param map[string]string) *DeleteDatabaseUserOptions

SetHeaders : Allow user to set Headers

func (*DeleteDatabaseUserOptions) SetID 

func (_options *DeleteDatabaseUserOptions) SetID(id string) *DeleteDatabaseUserOptions

SetID : Allow user to set ID

func (*DeleteDatabaseUserOptions) SetUserType 

func (_options *DeleteDatabaseUserOptions) SetUserType(userType string) *DeleteDatabaseUserOptions

SetUserType : Allow user to set UserType

func (*DeleteDatabaseUserOptions) SetUsername 

func (_options *DeleteDatabaseUserOptions) SetUsername(username string) *DeleteDatabaseUserOptions

SetUsername : Allow user to set Username

type DeleteDatabaseUserResponse 

type DeleteDatabaseUserResponse struct {
	Task *Task `json:"task,omitempty"`
}

DeleteDatabaseUserResponse : DeleteDatabaseUserResponse struct

type DeleteLogicalReplicationSlotOptions added in v0.3.0 

type DeleteLogicalReplicationSlotOptions struct {
	// Deployment ID.
	ID *string `json:"id" validate:"required,ne="`

	// Name of the logical replication slot.
	Name *string `json:"name" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

DeleteLogicalReplicationSlotOptions : The DeleteLogicalReplicationSlot options.

func (*DeleteLogicalReplicationSlotOptions) SetHeaders added in v0.3.0 

func (options *DeleteLogicalReplicationSlotOptions) SetHeaders(param map[string]string) *DeleteLogicalReplicationSlotOptions

SetHeaders : Allow user to set Headers

func (*DeleteLogicalReplicationSlotOptions) SetID added in v0.3.0 

func (_options *DeleteLogicalReplicationSlotOptions) SetID(id string) *DeleteLogicalReplicationSlotOptions

SetID : Allow user to set ID

func (*DeleteLogicalReplicationSlotOptions) SetName added in v0.3.0 

func (_options *DeleteLogicalReplicationSlotOptions) SetName(name string) *DeleteLogicalReplicationSlotOptions

SetName : Allow user to set Name

type DeleteLogicalReplicationSlotResponse added in v0.3.0 

type DeleteLogicalReplicationSlotResponse struct {
	Task *Task `json:"task,omitempty"`
}

DeleteLogicalReplicationSlotResponse : DeleteLogicalReplicationSlotResponse struct

type Deployables 

type Deployables struct {
	// Deployment type - typically the name of the database.
	Type *string `json:"type,omitempty"`

	// An array of versions of the database, their status, preferedness, and transitions.
	Versions []DeployablesVersionsItem `json:"versions,omitempty"`
}

Deployables : Deployable databases with their version information.

type DeployablesVersionsItem 

type DeployablesVersionsItem struct {
	// The version number.
	Version *string `json:"version,omitempty"`

	// The status of this version: To be finalized.
	Status *string `json:"status,omitempty"`

	// Should this version be preferred over others?.
	IsPreferred *bool `json:"is_preferred,omitempty"`

	// versions that this version can be upgraded to.
	Transitions []DeployablesVersionsItemTransitionsItem `json:"transitions,omitempty"`
}

DeployablesVersionsItem : DeployablesVersionsItem struct

type DeployablesVersionsItemTransitionsItem 

type DeployablesVersionsItemTransitionsItem struct {
	// The database type.
	Application *string `json:"application,omitempty"`

	// method of going from from_version to to_version.
	Method *string `json:"method,omitempty"`

	// The version the transition in from.
	FromVersion *string `json:"from_version,omitempty"`

	// The version the transition is to.
	ToVersion *string `json:"to_version,omitempty"`
}

DeployablesVersionsItemTransitionsItem : DeployablesVersionsItemTransitionsItem struct

type Deployment 

type Deployment struct {
	// ID of this deployment.
	ID *string `json:"id,omitempty"`

	// Readable name of this deployment.
	Name *string `json:"name,omitempty"`

	// Database type within this deployment.
	Type *string `json:"type,omitempty"`

	// Platform for this deployment.
	Platform *string `json:"platform,omitempty"`

	// Platform-specific options for this deployment.
	PlatformOptions map[string]interface{} `json:"platform_options,omitempty"`

	// Version number of the database.
	Version *string `json:"version,omitempty"`

	// Login name of administration level user.
	AdminUsernames map[string]string `json:"admin_usernames,omitempty"`

	// Whether access to this deployment is enabled from the public internet. This property can be modified by updating
	// this service instance through the Resource Controller API.
	EnablePublicEndpoints *bool `json:"enable_public_endpoints,omitempty"`

	// Whether access to this deployment is enabled from IBM Cloud via the IBM Cloud backbone network. This property can be
	// modified by updating this service instance through the Resource Controller API.
	EnablePrivateEndpoints *bool `json:"enable_private_endpoints,omitempty"`
}

Deployment : Deployment struct

type GetAllowlistOptions 

type GetAllowlistOptions struct {
	// Deployment ID.
	ID *string `json:"id" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetAllowlistOptions : The GetAllowlist options.

func (*GetAllowlistOptions) SetHeaders 

func (options *GetAllowlistOptions) SetHeaders(param map[string]string) *GetAllowlistOptions

SetHeaders : Allow user to set Headers

func (*GetAllowlistOptions) SetID 

func (_options *GetAllowlistOptions) SetID(id string) *GetAllowlistOptions

SetID : Allow user to set ID

type GetAllowlistResponse added in v0.2.0 

type GetAllowlistResponse struct {
	IPAddresses []AllowlistEntry `json:"ip_addresses,omitempty"`
}

GetAllowlistResponse : GetAllowlistResponse struct

type GetAutoscalingConditionsOptions 

type GetAutoscalingConditionsOptions struct {
	// Deployment ID.
	ID *string `json:"id" validate:"required,ne="`

	// Group ID.
	GroupID *string `json:"group_id" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetAutoscalingConditionsOptions : The GetAutoscalingConditions options.

func (*GetAutoscalingConditionsOptions) SetGroupID 

func (_options *GetAutoscalingConditionsOptions) SetGroupID(groupID string) *GetAutoscalingConditionsOptions

SetGroupID : Allow user to set GroupID

func (*GetAutoscalingConditionsOptions) SetHeaders 

func (options *GetAutoscalingConditionsOptions) SetHeaders(param map[string]string) *GetAutoscalingConditionsOptions

SetHeaders : Allow user to set Headers

func (*GetAutoscalingConditionsOptions) SetID 

func (_options *GetAutoscalingConditionsOptions) SetID(id string) *GetAutoscalingConditionsOptions

SetID : Allow user to set ID

type GetBackupInfoOptions 

type GetBackupInfoOptions struct {
	// Backup ID.
	BackupID *string `json:"backup_id" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetBackupInfoOptions : The GetBackupInfo options.

func (*GetBackupInfoOptions) SetBackupID 

func (_options *GetBackupInfoOptions) SetBackupID(backupID string) *GetBackupInfoOptions

SetBackupID : Allow user to set BackupID

func (*GetBackupInfoOptions) SetHeaders 

func (options *GetBackupInfoOptions) SetHeaders(param map[string]string) *GetBackupInfoOptions

SetHeaders : Allow user to set Headers

type GetBackupInfoResponse 

type GetBackupInfoResponse struct {
	Backup *Backup `json:"backup,omitempty"`
}

GetBackupInfoResponse : GetBackupInfoResponse struct

type GetConnectionOptions 

type GetConnectionOptions struct {
	// Deployment ID.
	ID *string `json:"id" validate:"required,ne="`

	// User type.
	UserType *string `json:"user_type" validate:"required,ne="`

	// User ID.
	UserID *string `json:"user_id" validate:"required,ne="`

	// Endpoint Type. The endpoint must be enabled on the deployment before its connection information can be fetched.
	EndpointType *string `json:"endpoint_type" validate:"required,ne="`

	// Optional certificate root path to prepend certificate names. Certificates would be stored in this directory for use
	// by other commands.
	CertificateRoot *string `json:"certificate_root,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetConnectionOptions : The GetConnection options.

func (*GetConnectionOptions) SetCertificateRoot 

func (_options *GetConnectionOptions) SetCertificateRoot(certificateRoot string) *GetConnectionOptions

SetCertificateRoot : Allow user to set CertificateRoot

func (*GetConnectionOptions) SetEndpointType 

func (_options *GetConnectionOptions) SetEndpointType(endpointType string) *GetConnectionOptions

SetEndpointType : Allow user to set EndpointType

func (*GetConnectionOptions) SetHeaders 

func (options *GetConnectionOptions) SetHeaders(param map[string]string) *GetConnectionOptions

SetHeaders : Allow user to set Headers

func (*GetConnectionOptions) SetID 

func (_options *GetConnectionOptions) SetID(id string) *GetConnectionOptions

SetID : Allow user to set ID

func (*GetConnectionOptions) SetUserID 

func (_options *GetConnectionOptions) SetUserID(userID string) *GetConnectionOptions

SetUserID : Allow user to set UserID

func (*GetConnectionOptions) SetUserType 

func (_options *GetConnectionOptions) SetUserType(userType string) *GetConnectionOptions

SetUserType : Allow user to set UserType

type GetConnectionResponse added in v0.2.0 

type GetConnectionResponse struct {
	Connection ConnectionIntf `json:"connection,omitempty"`
}

GetConnectionResponse : GetConnectionResponse struct

type GetDefaultScalingGroupsOptions 

type GetDefaultScalingGroupsOptions struct {
	// Database type name.
	Type *string `json:"type" validate:"required,ne="`

	// When a host_flavor of 'multitenant' is included with the request, IBM Cloud Database's new shared compute default
	// groups will be returned.
	HostFlavor *string `json:"host_flavor,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetDefaultScalingGroupsOptions : The GetDefaultScalingGroups options.

func (*GetDefaultScalingGroupsOptions) SetHeaders 

func (options *GetDefaultScalingGroupsOptions) SetHeaders(param map[string]string) *GetDefaultScalingGroupsOptions

SetHeaders : Allow user to set Headers

func (*GetDefaultScalingGroupsOptions) SetHostFlavor added in v0.6.0 

func (_options *GetDefaultScalingGroupsOptions) SetHostFlavor(hostFlavor string) *GetDefaultScalingGroupsOptions

SetHostFlavor : Allow user to set HostFlavor

func (*GetDefaultScalingGroupsOptions) SetType 

func (_options *GetDefaultScalingGroupsOptions) SetType(typeVar string) *GetDefaultScalingGroupsOptions

SetType : Allow user to set Type

type GetDefaultScalingGroupsResponse added in v0.2.0 

type GetDefaultScalingGroupsResponse struct {
	Groups []Group `json:"groups,omitempty"`
}

GetDefaultScalingGroupsResponse : GetDefaultScalingGroupsResponse struct

type GetDeploymentInfoOptions 

type GetDeploymentInfoOptions struct {
	// Deployment ID.
	ID *string `json:"id" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetDeploymentInfoOptions : The GetDeploymentInfo options.

func (*GetDeploymentInfoOptions) SetHeaders 

func (options *GetDeploymentInfoOptions) SetHeaders(param map[string]string) *GetDeploymentInfoOptions

SetHeaders : Allow user to set Headers

func (*GetDeploymentInfoOptions) SetID 

func (_options *GetDeploymentInfoOptions) SetID(id string) *GetDeploymentInfoOptions

SetID : Allow user to set ID

type GetDeploymentInfoResponse 

type GetDeploymentInfoResponse struct {
	Deployment *Deployment `json:"deployment,omitempty"`
}

GetDeploymentInfoResponse : GetDeploymentInfoResponse struct

type GetPitrDataOptions added in v0.2.0 

type GetPitrDataOptions struct {
	// Deployment ID.
	ID *string `json:"id" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetPitrDataOptions : The GetPitrData options.

func (*GetPitrDataOptions) SetHeaders added in v0.2.0 

func (options *GetPitrDataOptions) SetHeaders(param map[string]string) *GetPitrDataOptions

SetHeaders : Allow user to set Headers

func (*GetPitrDataOptions) SetID added in v0.2.0 

func (_options *GetPitrDataOptions) SetID(id string) *GetPitrDataOptions

SetID : Allow user to set ID

type GetPitrDataResponse added in v0.2.0 

type GetPitrDataResponse struct {
	PointInTimeRecoveryData *PointInTimeRecoveryData `json:"point_in_time_recovery_data,omitempty"`
}

GetPitrDataResponse : GetPitrDataResponse struct

type GetTaskOptions 

type GetTaskOptions struct {
	// Task ID.
	ID *string `json:"id" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetTaskOptions : The GetTask options.

func (*GetTaskOptions) SetHeaders 

func (options *GetTaskOptions) SetHeaders(param map[string]string) *GetTaskOptions

SetHeaders : Allow user to set Headers

func (*GetTaskOptions) SetID 

func (_options *GetTaskOptions) SetID(id string) *GetTaskOptions

SetID : Allow user to set ID

type GetTaskResponse 

type GetTaskResponse struct {
	Task *Task `json:"task,omitempty"`
}

GetTaskResponse : GetTaskResponse struct

type Group 

type Group struct {
	// Id/name for group.
	ID *string `json:"id,omitempty"`

	// Number of entities in the group.
	Count *int64 `json:"count,omitempty"`

	Members *GroupMembers `json:"members,omitempty"`

	Memory *GroupMemory `json:"memory,omitempty"`

	CPU *GroupCPU `json:"cpu,omitempty"`

	Disk *GroupDisk `json:"disk,omitempty"`

	HostFlavor *GroupHostFlavor `json:"host_flavor,omitempty"`
}

Group : Group struct

type GroupCPU 

type GroupCPU struct {
	// Units used for scaling cpu - count means the value is the number of the unit(s) available.
	Units *string `json:"units,omitempty"`

	// Number of allocated CPUs.
	AllocationCount *int64 `json:"allocation_count,omitempty"`

	// Minimum number of CPUs.
	MinimumCount *int64 `json:"minimum_count,omitempty"`

	// Maximum number of CPUs.
	MaximumCount *int64 `json:"maximum_count,omitempty"`

	// Step size CPUs can be adjusted.
	StepSizeCount *int64 `json:"step_size_count,omitempty"`

	// Is this group's CPU count adjustable.
	IsAdjustable *bool `json:"is_adjustable,omitempty"`

	// Is this group's CPU optional?.
	IsOptional *bool `json:"is_optional,omitempty"`

	// Can this group's CPU scale down?.
	CanScaleDown *bool `json:"can_scale_down,omitempty"`
}

GroupCPU : GroupCPU struct

type GroupDisk 

type GroupDisk struct {
	// Units used for scaling storage.
	Units *string `json:"units,omitempty"`

	// Allocated storage in MB.
	AllocationMb *int64 `json:"allocation_mb,omitempty"`

	// Minimum allocated storage.
	MinimumMb *int64 `json:"minimum_mb,omitempty"`

	// Maximum allocated storage.
	MaximumMb *int64 `json:"maximum_mb,omitempty"`

	// Step size storage can be adjusted.
	StepSizeMb *int64 `json:"step_size_mb,omitempty"`

	// Is this group's storage adjustable?.
	IsAdjustable *bool `json:"is_adjustable,omitempty"`

	// Is this group's storage optional?.
	IsOptional *bool `json:"is_optional,omitempty"`

	// Can this group's storage scale down?.
	CanScaleDown *bool `json:"can_scale_down,omitempty"`
}

GroupDisk : GroupDisk struct

type GroupHostFlavor added in v0.5.0 

type GroupHostFlavor struct {
	// Group's host flavor id.
	ID *string `json:"id,omitempty"`

	// Group's hostflavor name.
	Name *string `json:"name,omitempty"`

	// Group's host flavor size.
	HostingSize *string `json:"hosting_size,omitempty"`
}

GroupHostFlavor : GroupHostFlavor struct

type GroupMembers 

type GroupMembers struct {
	// Units used for scaling number of members.
	Units *string `json:"units,omitempty"`

	// Allocated number of members.
	AllocationCount *int64 `json:"allocation_count,omitempty"`

	// Minimum number of members.
	MinimumCount *int64 `json:"minimum_count,omitempty"`

	// Maximum number of members.
	MaximumCount *int64 `json:"maximum_count,omitempty"`

	// Step size for number of members.
	StepSizeCount *int64 `json:"step_size_count,omitempty"`

	// Is this deployment's number of members adjustable?.
	IsAdjustable *bool `json:"is_adjustable,omitempty"`

	// Is this deployments's number of members optional?.
	IsOptional *bool `json:"is_optional,omitempty"`

	// Can this deployment's number of members scale down?.
	CanScaleDown *bool `json:"can_scale_down,omitempty"`
}

GroupMembers : GroupMembers struct

type GroupMemory 

type GroupMemory struct {
	// Units used for scaling memory.
	Units *string `json:"units,omitempty"`

	// Allocated memory in MB.
	AllocationMb *int64 `json:"allocation_mb,omitempty"`

	// Minimum memory in MB.
	MinimumMb *int64 `json:"minimum_mb,omitempty"`

	// Maximum memory in MB.
	MaximumMb *int64 `json:"maximum_mb,omitempty"`

	// Step size memory can be adjusted by in MB.
	StepSizeMb *int64 `json:"step_size_mb,omitempty"`

	// Is this group's memory adjustable?.
	IsAdjustable *bool `json:"is_adjustable,omitempty"`

	// Is this group's memory optional?.
	IsOptional *bool `json:"is_optional,omitempty"`

	// Can this group's memory scale down?.
	CanScaleDown *bool `json:"can_scale_down,omitempty"`

	// The amount of memory required before the cpu/memory ratio is no longer enforced. (multitenant only).
	CPUEnforcementRatioCeilingMb *int64 `json:"cpu_enforcement_ratio_ceiling_mb,omitempty"`

	// The maximum memory allowed per CPU until the ratio ceiling is reached. (multitenant only).
	CPUEnforcementRatioMb *int64 `json:"cpu_enforcement_ratio_mb,omitempty"`
}

GroupMemory : GroupMemory struct

type GroupScaling added in v0.2.0 

type GroupScaling struct {
	Members *GroupScalingMembers `json:"members,omitempty"`

	Memory *GroupScalingMemory `json:"memory,omitempty"`

	CPU *GroupScalingCPU `json:"cpu,omitempty"`

	Disk *GroupScalingDisk `json:"disk,omitempty"`

	HostFlavor *GroupScalingHostFlavor `json:"host_flavor,omitempty"`
}

GroupScaling : GroupScaling struct

type GroupScalingCPU added in v0.2.0 

type GroupScalingCPU struct {
	// Number of allocated CPUs.
	AllocationCount *int64 `json:"allocation_count,omitempty"`
}

GroupScalingCPU : GroupScalingCPU struct

type GroupScalingDisk added in v0.2.0 

type GroupScalingDisk struct {
	// Allocated storage in MB.
	AllocationMb *int64 `json:"allocation_mb,omitempty"`
}

GroupScalingDisk : GroupScalingDisk struct

type GroupScalingHostFlavor added in v0.5.0 

type GroupScalingHostFlavor struct {
	// **Beta feature:** The hosting infrastructure identifier. Selecting `multitenant` places your database on a logically
	// separated, multi-tenant machine. With this identifier, minimum resource configurations apply. Alternatively, setting
	// the identifier to any of the following host sizes places your database on the specified host size with no other
	// tenants.
	// - `b3c.4x16.encrypted`
	// - `b3c.8x32.encrypted`
	// - `m3c.8x64.encrypted`
	// - `b3c.16x64.encrypted`
	// - `b3c.32x128.encrypted`
	// - `m3c.30x240.encrypted`.
	ID *string `json:"id,omitempty"`
}

GroupScalingHostFlavor : GroupScalingHostFlavor struct

type GroupScalingMembers added in v0.2.0 

type GroupScalingMembers struct {
	// Allocated number of members.
	AllocationCount *int64 `json:"allocation_count,omitempty"`
}

GroupScalingMembers : GroupScalingMembers struct

type GroupScalingMemory added in v0.2.0 

type GroupScalingMemory struct {
	// Allocated memory in MB.
	AllocationMb *int64 `json:"allocation_mb,omitempty"`
}

GroupScalingMemory : GroupScalingMemory struct

type KillConnectionsOptions 

type KillConnectionsOptions struct {
	// Deployment ID.
	ID *string `json:"id" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

KillConnectionsOptions : The KillConnections options.

func (*KillConnectionsOptions) SetHeaders 

func (options *KillConnectionsOptions) SetHeaders(param map[string]string) *KillConnectionsOptions

SetHeaders : Allow user to set Headers

func (*KillConnectionsOptions) SetID 

func (_options *KillConnectionsOptions) SetID(id string) *KillConnectionsOptions

SetID : Allow user to set ID

type KillConnectionsResponse 

type KillConnectionsResponse struct {
	Task *Task `json:"task,omitempty"`
}

KillConnectionsResponse : KillConnectionsResponse struct

type ListDeployablesOptions 

type ListDeployablesOptions struct {

	// Allows users to set headers on API requests
	Headers map[string]string
}

ListDeployablesOptions : The ListDeployables options.

func (*ListDeployablesOptions) SetHeaders 

func (options *ListDeployablesOptions) SetHeaders(param map[string]string) *ListDeployablesOptions

SetHeaders : Allow user to set Headers

type ListDeployablesResponse 

type ListDeployablesResponse struct {
	Deployables []Deployables `json:"deployables,omitempty"`
}

ListDeployablesResponse : ListDeployablesResponse struct

type ListDeploymentBackupsOptions 

type ListDeploymentBackupsOptions struct {
	// Deployment ID.
	ID *string `json:"id" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

ListDeploymentBackupsOptions : The ListDeploymentBackups options.

func (*ListDeploymentBackupsOptions) SetHeaders 

func (options *ListDeploymentBackupsOptions) SetHeaders(param map[string]string) *ListDeploymentBackupsOptions

SetHeaders : Allow user to set Headers

func (*ListDeploymentBackupsOptions) SetID 

func (_options *ListDeploymentBackupsOptions) SetID(id string) *ListDeploymentBackupsOptions

SetID : Allow user to set ID

type ListDeploymentScalingGroupsOptions 

type ListDeploymentScalingGroupsOptions struct {
	// Deployment ID.
	ID *string `json:"id" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

ListDeploymentScalingGroupsOptions : The ListDeploymentScalingGroups options.

func (*ListDeploymentScalingGroupsOptions) SetHeaders 

func (options *ListDeploymentScalingGroupsOptions) SetHeaders(param map[string]string) *ListDeploymentScalingGroupsOptions

SetHeaders : Allow user to set Headers

func (*ListDeploymentScalingGroupsOptions) SetID 

func (_options *ListDeploymentScalingGroupsOptions) SetID(id string) *ListDeploymentScalingGroupsOptions

SetID : Allow user to set ID

type ListDeploymentScalingGroupsResponse added in v0.2.0 

type ListDeploymentScalingGroupsResponse struct {
	Groups []Group `json:"groups,omitempty"`
}

ListDeploymentScalingGroupsResponse : ListDeploymentScalingGroupsResponse struct

type ListDeploymentTasksOptions 

type ListDeploymentTasksOptions struct {
	// Deployment ID.
	ID *string `json:"id" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

ListDeploymentTasksOptions : The ListDeploymentTasks options.

func (*ListDeploymentTasksOptions) SetHeaders 

func (options *ListDeploymentTasksOptions) SetHeaders(param map[string]string) *ListDeploymentTasksOptions

SetHeaders : Allow user to set Headers

func (*ListDeploymentTasksOptions) SetID 

func (_options *ListDeploymentTasksOptions) SetID(id string) *ListDeploymentTasksOptions

SetID : Allow user to set ID

type ListRegionsOptions 

type ListRegionsOptions struct {

	// Allows users to set headers on API requests
	Headers map[string]string
}

ListRegionsOptions : The ListRegions options.

func (*ListRegionsOptions) SetHeaders 

func (options *ListRegionsOptions) SetHeaders(param map[string]string) *ListRegionsOptions

SetHeaders : Allow user to set Headers

type ListRegionsResponse 

type ListRegionsResponse struct {
	// An array of region ids.
	Regions []string `json:"regions,omitempty"`
}

ListRegionsResponse : ListRegionsResponse struct

type ListRemotesOptions 

type ListRemotesOptions struct {
	// Deployment ID.
	ID *string `json:"id" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

ListRemotesOptions : The ListRemotes options.

func (*ListRemotesOptions) SetHeaders 

func (options *ListRemotesOptions) SetHeaders(param map[string]string) *ListRemotesOptions

SetHeaders : Allow user to set Headers

func (*ListRemotesOptions) SetID 

func (_options *ListRemotesOptions) SetID(id string) *ListRemotesOptions

SetID : Allow user to set ID

type ListRemotesResponse 

type ListRemotesResponse struct {
	// Remotes.
	Remotes *Remotes `json:"remotes,omitempty"`
}

ListRemotesResponse : ListRemotesResponse struct

type LogicalReplicationSlot added in v0.3.0 

type LogicalReplicationSlot struct {
	// name of the replication slot.
	Name *string `json:"name" validate:"required"`

	// name of the database the replication slot is created on.
	DatabaseName *string `json:"database_name" validate:"required"`

	// creating a replication slot is only supported for use with wal2json.
	PluginType *string `json:"plugin_type" validate:"required"`
}

LogicalReplicationSlot : LogicalReplicationSlot struct

type MongoDbConnectionURI 

type MongoDbConnectionURI struct {
	// Type of connection being described.
	Type *string `json:"type,omitempty"`

	Composed []string `json:"composed,omitempty"`

	// Scheme/protocol for URI connection.
	Scheme *string `json:"scheme,omitempty"`

	Hosts []ConnectionHost `json:"hosts,omitempty"`

	// Path for URI connection.
	Path *string `json:"path,omitempty"`

	// Query options to add to the URI connection.
	QueryOptions map[string]interface{} `json:"query_options,omitempty"`

	// Authentication data for Connection String.
	Authentication *ConnectionAuthentication `json:"authentication,omitempty"`

	Certificate *ConnectionCertificate `json:"certificate,omitempty"`

	// Indicates ssl is required for the connection.
	Ssl *bool `json:"ssl,omitempty"`

	// Indicates the address is accessible by browser.
	BrowserAccessible *bool `json:"browser_accessible,omitempty"`

	// Name of the database to use in the URI connection.
	Database *string `json:"database,omitempty"`

	// Name of the replica set to use in the URI connection.
	ReplicaSet *string `json:"replica_set,omitempty"`
}

MongoDbConnectionURI : MongoDbConnectionURI struct

type MySQLConnectionURI added in v0.2.0 

type MySQLConnectionURI struct {
	// Type of connection being described.
	Type *string `json:"type,omitempty"`

	Composed []string `json:"composed,omitempty"`

	// Scheme/protocol for URI connection.
	Scheme *string `json:"scheme,omitempty"`

	Hosts []ConnectionHost `json:"hosts,omitempty"`

	// Path for URI connection.
	Path *string `json:"path,omitempty"`

	// Query options to add to the URI connection.
	QueryOptions map[string]interface{} `json:"query_options,omitempty"`

	// Authentication data for Connection String.
	Authentication *ConnectionAuthentication `json:"authentication,omitempty"`

	Certificate *ConnectionCertificate `json:"certificate,omitempty"`

	// Indicates ssl is required for the connection.
	Ssl *bool `json:"ssl,omitempty"`

	// Indicates the address is accessible by browser.
	BrowserAccessible *bool `json:"browser_accessible,omitempty"`

	// Name of the database to use in the URI connection.
	Database *string `json:"database,omitempty"`
}

MySQLConnectionURI : MySQLConnectionURI struct

type PointInTimeRecoveryData 

type PointInTimeRecoveryData struct {
	EarliestPointInTimeRecoveryTime *string `json:"earliest_point_in_time_recovery_time,omitempty"`
}

PointInTimeRecoveryData : PointInTimeRecoveryData struct

type PostgreSQLConnectionURI 

type PostgreSQLConnectionURI struct {
	// Type of connection being described.
	Type *string `json:"type,omitempty"`

	Composed []string `json:"composed,omitempty"`

	// Scheme/protocol for URI connection.
	Scheme *string `json:"scheme,omitempty"`

	Hosts []ConnectionHost `json:"hosts,omitempty"`

	// Path for URI connection.
	Path *string `json:"path,omitempty"`

	// Query options to add to the URI connection.
	QueryOptions map[string]interface{} `json:"query_options,omitempty"`

	// Authentication data for Connection String.
	Authentication *ConnectionAuthentication `json:"authentication,omitempty"`

	Certificate *ConnectionCertificate `json:"certificate,omitempty"`

	// Indicates ssl is required for the connection.
	Ssl *bool `json:"ssl,omitempty"`

	// Indicates the address is accessible by browser.
	BrowserAccessible *bool `json:"browser_accessible,omitempty"`

	// Name of the database to use in the URI connection.
	Database *string `json:"database,omitempty"`
}

PostgreSQLConnectionURI : PostgreSQLConnectionURI struct

type PromoteReadOnlyReplicaOptions added in v0.2.0 

type PromoteReadOnlyReplicaOptions struct {
	// Deployment ID of the read-only replica to promote.
	ID *string `json:"id" validate:"required,ne="`

	// Promotion and Upgrade options.
	Promotion map[string]interface{} `json:"promotion,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

PromoteReadOnlyReplicaOptions : The PromoteReadOnlyReplica options.

func (*PromoteReadOnlyReplicaOptions) SetHeaders added in v0.2.0 

func (options *PromoteReadOnlyReplicaOptions) SetHeaders(param map[string]string) *PromoteReadOnlyReplicaOptions

SetHeaders : Allow user to set Headers

func (*PromoteReadOnlyReplicaOptions) SetID added in v0.2.0 

func (_options *PromoteReadOnlyReplicaOptions) SetID(id string) *PromoteReadOnlyReplicaOptions

SetID : Allow user to set ID

func (*PromoteReadOnlyReplicaOptions) SetPromotion added in v0.2.0 

func (_options *PromoteReadOnlyReplicaOptions) SetPromotion(promotion map[string]interface{}) *PromoteReadOnlyReplicaOptions

SetPromotion : Allow user to set Promotion

type PromoteReadOnlyReplicaResponse added in v0.2.0 

type PromoteReadOnlyReplicaResponse struct {
	Task *Task `json:"task,omitempty"`
}

PromoteReadOnlyReplicaResponse : PromoteReadOnlyReplicaResponse struct

type RedisConnectionURI 

type RedisConnectionURI struct {
	// Type of connection being described.
	Type *string `json:"type,omitempty"`

	Composed []string `json:"composed,omitempty"`

	// Scheme/protocol for URI connection.
	Scheme *string `json:"scheme,omitempty"`

	Hosts []ConnectionHost `json:"hosts,omitempty"`

	// Path for URI connection.
	Path *string `json:"path,omitempty"`

	// Query options to add to the URI connection.
	QueryOptions map[string]interface{} `json:"query_options,omitempty"`

	// Authentication data for Connection String.
	Authentication *ConnectionAuthentication `json:"authentication,omitempty"`

	Certificate *ConnectionCertificate `json:"certificate,omitempty"`

	// Indicates ssl is required for the connection.
	Ssl *bool `json:"ssl,omitempty"`

	// Indicates the address is accessible by browser.
	BrowserAccessible *bool `json:"browser_accessible,omitempty"`

	// Number of the database to use in the URI connection.
	Database *int64 `json:"database,omitempty"`
}

RedisConnectionURI : RedisConnectionURI struct

type Remotes 

type Remotes struct {
	// Leader ID, if applicable.
	Leader *string `json:"leader,omitempty"`

	// Replica IDs, if applicable.
	Replicas []string `json:"replicas,omitempty"`
}

Remotes : Remotes.

type ResyncReplicaOptions 

type ResyncReplicaOptions struct {
	// Deployment ID of the read-only replica.
	ID *string `json:"id" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

ResyncReplicaOptions : The ResyncReplica options.

func (*ResyncReplicaOptions) SetHeaders 

func (options *ResyncReplicaOptions) SetHeaders(param map[string]string) *ResyncReplicaOptions

SetHeaders : Allow user to set Headers

func (*ResyncReplicaOptions) SetID 

func (_options *ResyncReplicaOptions) SetID(id string) *ResyncReplicaOptions

SetID : Allow user to set ID

type ResyncReplicaResponse 

type ResyncReplicaResponse struct {
	Task *Task `json:"task,omitempty"`
}

ResyncReplicaResponse : ResyncReplicaResponse struct

type SetAllowlistOptions 

type SetAllowlistOptions struct {
	// Deployment ID.
	ID *string `json:"id" validate:"required,ne="`

	IPAddresses []AllowlistEntry `json:"ip_addresses,omitempty"`

	// Verify that the current allowlist matches a provided ETag value. Use in conjunction with the GET operation's ETag
	// header to ensure synchronicity between clients.
	IfMatch *string `json:"If-Match,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

SetAllowlistOptions : The SetAllowlist options.

func (*SetAllowlistOptions) SetHeaders 

func (options *SetAllowlistOptions) SetHeaders(param map[string]string) *SetAllowlistOptions

SetHeaders : Allow user to set Headers

func (*SetAllowlistOptions) SetID 

func (_options *SetAllowlistOptions) SetID(id string) *SetAllowlistOptions

SetID : Allow user to set ID

func (*SetAllowlistOptions) SetIPAddresses 

func (_options *SetAllowlistOptions) SetIPAddresses(ipAddresses []AllowlistEntry) *SetAllowlistOptions

SetIPAddresses : Allow user to set IPAddresses

func (*SetAllowlistOptions) SetIfMatch 

func (_options *SetAllowlistOptions) SetIfMatch(ifMatch string) *SetAllowlistOptions

SetIfMatch : Allow user to set IfMatch

type SetAllowlistResponse 

type SetAllowlistResponse struct {
	Task *Task `json:"task,omitempty"`
}

SetAllowlistResponse : SetAllowlistResponse struct

type SetAutoscalingConditionsOptions 

type SetAutoscalingConditionsOptions struct {
	// Deployment ID.
	ID *string `json:"id" validate:"required,ne="`

	// Group ID.
	GroupID *string `json:"group_id" validate:"required,ne="`

	Autoscaling AutoscalingSetGroupAutoscalingIntf `json:"autoscaling" validate:"required"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

SetAutoscalingConditionsOptions : The SetAutoscalingConditions options.

func (*SetAutoscalingConditionsOptions) SetAutoscaling 

func (_options *SetAutoscalingConditionsOptions) SetAutoscaling(autoscaling AutoscalingSetGroupAutoscalingIntf) *SetAutoscalingConditionsOptions

SetAutoscaling : Allow user to set Autoscaling

func (*SetAutoscalingConditionsOptions) SetGroupID 

func (_options *SetAutoscalingConditionsOptions) SetGroupID(groupID string) *SetAutoscalingConditionsOptions

SetGroupID : Allow user to set GroupID

func (*SetAutoscalingConditionsOptions) SetHeaders 

func (options *SetAutoscalingConditionsOptions) SetHeaders(param map[string]string) *SetAutoscalingConditionsOptions

SetHeaders : Allow user to set Headers

func (*SetAutoscalingConditionsOptions) SetID 

func (_options *SetAutoscalingConditionsOptions) SetID(id string) *SetAutoscalingConditionsOptions

SetID : Allow user to set ID

type SetAutoscalingConditionsResponse 

type SetAutoscalingConditionsResponse struct {
	Task *Task `json:"task,omitempty"`
}

SetAutoscalingConditionsResponse : SetAutoscalingConditionsResponse struct

type SetDeploymentScalingGroupOptions 

type SetDeploymentScalingGroupOptions struct {
	// Deployment ID.
	ID *string `json:"id" validate:"required,ne="`

	// Group Id.
	GroupID *string `json:"group_id" validate:"required,ne="`

	Group *GroupScaling `json:"group,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

SetDeploymentScalingGroupOptions : The SetDeploymentScalingGroup options.

func (*SetDeploymentScalingGroupOptions) SetGroup added in v0.2.0 

func (_options *SetDeploymentScalingGroupOptions) SetGroup(group *GroupScaling) *SetDeploymentScalingGroupOptions

SetGroup : Allow user to set Group

func (*SetDeploymentScalingGroupOptions) SetGroupID 

func (_options *SetDeploymentScalingGroupOptions) SetGroupID(groupID string) *SetDeploymentScalingGroupOptions

SetGroupID : Allow user to set GroupID

func (*SetDeploymentScalingGroupOptions) SetHeaders 

func (options *SetDeploymentScalingGroupOptions) SetHeaders(param map[string]string) *SetDeploymentScalingGroupOptions

SetHeaders : Allow user to set Headers

func (*SetDeploymentScalingGroupOptions) SetID 

func (_options *SetDeploymentScalingGroupOptions) SetID(id string) *SetDeploymentScalingGroupOptions

SetID : Allow user to set ID

type SetDeploymentScalingGroupResponse 

type SetDeploymentScalingGroupResponse struct {
	Task *Task `json:"task,omitempty"`
}

SetDeploymentScalingGroupResponse : SetDeploymentScalingGroupResponse struct

type StartOndemandBackupOptions 

type StartOndemandBackupOptions struct {
	// Deployment ID.
	ID *string `json:"id" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

StartOndemandBackupOptions : The StartOndemandBackup options.

func (*StartOndemandBackupOptions) SetHeaders 

func (options *StartOndemandBackupOptions) SetHeaders(param map[string]string) *StartOndemandBackupOptions

SetHeaders : Allow user to set Headers

func (*StartOndemandBackupOptions) SetID 

func (_options *StartOndemandBackupOptions) SetID(id string) *StartOndemandBackupOptions

SetID : Allow user to set ID

type StartOndemandBackupResponse 

type StartOndemandBackupResponse struct {
	Task *Task `json:"task,omitempty"`
}

StartOndemandBackupResponse : StartOndemandBackupResponse struct

type Task 

type Task struct {
	// ID of the task.
	ID *string `json:"id,omitempty"`

	// Human-readable description of the task.
	Description *string `json:"description,omitempty"`

	// The status of the task.
	Status *string `json:"status,omitempty"`

	// ID of the deployment the task is being performed on.
	DeploymentID *string `json:"deployment_id,omitempty"`

	// Indicator as percentage of progress of the task.
	ProgressPercent *int64 `json:"progress_percent,omitempty"`

	// Date and time when the task was created.
	CreatedAt *strfmt.DateTime `json:"created_at,omitempty"`
}

Task : Task struct

type Tasks 

type Tasks struct {
	Tasks []Task `json:"tasks,omitempty"`
}

Tasks : Tasks struct

type UpdateDatabaseConfigurationOptions 

type UpdateDatabaseConfigurationOptions struct {
	// Deployment ID.
	ID *string `json:"id" validate:"required,ne="`

	Configuration ConfigurationIntf `json:"configuration,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

UpdateDatabaseConfigurationOptions : The UpdateDatabaseConfiguration options.

func (*UpdateDatabaseConfigurationOptions) SetConfiguration 

func (_options *UpdateDatabaseConfigurationOptions) SetConfiguration(configuration ConfigurationIntf) *UpdateDatabaseConfigurationOptions

SetConfiguration : Allow user to set Configuration

func (*UpdateDatabaseConfigurationOptions) SetHeaders 

func (options *UpdateDatabaseConfigurationOptions) SetHeaders(param map[string]string) *UpdateDatabaseConfigurationOptions

SetHeaders : Allow user to set Headers

func (*UpdateDatabaseConfigurationOptions) SetID 

func (_options *UpdateDatabaseConfigurationOptions) SetID(id string) *UpdateDatabaseConfigurationOptions

SetID : Allow user to set ID

type UpdateDatabaseConfigurationResponse 

type UpdateDatabaseConfigurationResponse struct {
	Task *Task `json:"task,omitempty"`
}

UpdateDatabaseConfigurationResponse : UpdateDatabaseConfigurationResponse struct

type UpdateUserOptions added in v0.4.0 

type UpdateUserOptions struct {
	// Deployment ID.
	ID *string `json:"id" validate:"required,ne="`

	// User type.
	UserType *string `json:"user_type" validate:"required,ne="`

	// User ID.
	Username *string `json:"username" validate:"required,ne="`

	User UserUpdateIntf `json:"user,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

UpdateUserOptions : The UpdateUser options.

func (*UpdateUserOptions) SetHeaders added in v0.4.0 

func (options *UpdateUserOptions) SetHeaders(param map[string]string) *UpdateUserOptions

SetHeaders : Allow user to set Headers

func (*UpdateUserOptions) SetID added in v0.4.0 

func (_options *UpdateUserOptions) SetID(id string) *UpdateUserOptions

SetID : Allow user to set ID

func (*UpdateUserOptions) SetUser added in v0.4.0 

func (_options *UpdateUserOptions) SetUser(user UserUpdateIntf) *UpdateUserOptions

SetUser : Allow user to set User

func (*UpdateUserOptions) SetUserType added in v0.4.0 

func (_options *UpdateUserOptions) SetUserType(userType string) *UpdateUserOptions

SetUserType : Allow user to set UserType

func (*UpdateUserOptions) SetUsername added in v0.4.0 

func (_options *UpdateUserOptions) SetUsername(username string) *UpdateUserOptions

SetUsername : Allow user to set Username

type UpdateUserResponse added in v0.4.0 

type UpdateUserResponse struct {
	Task *Task `json:"task,omitempty"`
}

UpdateUserResponse : UpdateUserResponse struct

type User added in v0.2.0 

type User struct {
	// Username for new user.
	Username *string `json:"username,omitempty"`

	// Password for new user. Password must be at least 15 characters in length and contain a letter and number.
	Password *string `json:"password,omitempty"`

	// RBAC role for Redis database user types. Available for Redis 6.0 and newer. Must use Redis ACL syntax to add or
	// remove command categories. Allowed categories are `read`, `write`, `admin` and `all`.
	Role *string `json:"role,omitempty"`
}

User : User struct Models which "extend" this model: - UserDatabaseUser - UserRedisDatabaseUser - UserOpsManagerUser

type UserDatabaseUser added in v0.4.0 

type UserDatabaseUser struct {
	// Username for new user.
	Username *string `json:"username" validate:"required"`

	// Password for new user. Password must be at least 15 characters in length and contain a letter and number.
	Password *string `json:"password" validate:"required"`
}

UserDatabaseUser : UserDatabaseUser struct This model "extends" User

type UserIntf added in v0.4.0 

type UserIntf interface {
	// contains filtered or unexported methods
}

type UserOpsManagerUser added in v0.4.0 

type UserOpsManagerUser struct {
	// Username for new user.
	Username *string `json:"username" validate:"required"`

	// Password for new Ops Manager user. Password must be at least 15 characters in length and contain a letter, number
	// and a special character.
	Password *string `json:"password" validate:"required"`

	// Role for new user. Available for MongoDB Enterprise Ops Manager users.
	Role *string `json:"role,omitempty"`
}

UserOpsManagerUser : UserOpsManagerUser struct This model "extends" User

type UserRedisDatabaseUser added in v0.4.0 

type UserRedisDatabaseUser struct {
	// Username for new user.
	Username *string `json:"username" validate:"required"`

	// Password for new user. Password must be at least 15 characters in length and contain a letter and number.
	Password *string `json:"password" validate:"required"`

	// RBAC role for Redis database user types. Available for Redis 6.0 and newer. Must use Redis ACL syntax to add or
	// remove command categories. Allowed categories are `read`, `write`, `admin` and `all`.
	Role *string `json:"role,omitempty"`
}

UserRedisDatabaseUser : UserRedisDatabaseUser struct This model "extends" User

type UserUpdate added in v0.4.0 

type UserUpdate struct {
	// Password for user. Password must be at least 15 characters in length and contain a letter and number.
	Password *string `json:"password,omitempty"`

	// RBAC role for redis database user types. Available for Redis 6.0 and above. Must use Redis ACL syntax to add or
	// remove command categories. Allowed categories are `read`, `write`, `admin` and `all`.
	Role *string `json:"role,omitempty"`
}

UserUpdate : UserUpdate struct Models which "extend" this model: - UserUpdatePasswordSetting - UserUpdateRedisRoleSetting

type UserUpdateIntf added in v0.4.0 

type UserUpdateIntf interface {
	// contains filtered or unexported methods
}

type UserUpdatePasswordSetting added in v0.4.0 

type UserUpdatePasswordSetting struct {
	// Password for user. Password must be at least 15 characters in length and contain a letter and number.
	Password *string `json:"password" validate:"required"`
}

UserUpdatePasswordSetting : UserUpdatePasswordSetting struct This model "extends" UserUpdate

type UserUpdateRedisRoleSetting added in v0.4.0 

type UserUpdateRedisRoleSetting struct {
	// RBAC role for redis database user types. Available for Redis 6.0 and above. Must use Redis ACL syntax to add or
	// remove command categories. Allowed categories are `read`, `write`, `admin` and `all`.
	Role *string `json:"role" validate:"required"`
}

UserUpdateRedisRoleSetting : UserUpdateRedisRoleSetting struct This model "extends" UserUpdate

Source Files

View all Source files

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.