databases

package
v2.96.0 Latest Latest
Warning

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

Go to latest
Published: Feb 14, 2022 License: MPL-2.0 Imports: 9 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForAccessKeyType

func PossibleValuesForAccessKeyType() []string

func PossibleValuesForAofFrequency

func PossibleValuesForAofFrequency() []string

func PossibleValuesForClusteringPolicy

func PossibleValuesForClusteringPolicy() []string

func PossibleValuesForEvictionPolicy

func PossibleValuesForEvictionPolicy() []string

func PossibleValuesForProtocol

func PossibleValuesForProtocol() []string

func PossibleValuesForProvisioningState

func PossibleValuesForProvisioningState() []string

func PossibleValuesForRdbFrequency

func PossibleValuesForRdbFrequency() []string

func PossibleValuesForResourceState

func PossibleValuesForResourceState() []string

func ValidateDatabaseID

func ValidateDatabaseID(input interface{}, key string) (warnings []string, errors []error)

ValidateDatabaseID checks that 'input' can be parsed as a Database ID

func ValidateRedisEnterpriseID

func ValidateRedisEnterpriseID(input interface{}, key string) (warnings []string, errors []error)

ValidateRedisEnterpriseID checks that 'input' can be parsed as a Redis Enterprise ID

Types

type AccessKeyType

type AccessKeyType string
const (
	AccessKeyTypePrimary   AccessKeyType = "Primary"
	AccessKeyTypeSecondary AccessKeyType = "Secondary"
)

type AccessKeys

type AccessKeys struct {
	PrimaryKey   *string `json:"primaryKey,omitempty"`
	SecondaryKey *string `json:"secondaryKey,omitempty"`
}

type AofFrequency

type AofFrequency string
const (
	AofFrequencyAlways AofFrequency = "always"
	AofFrequencyOnes   AofFrequency = "1s"
)

type ClusteringPolicy

type ClusteringPolicy string
const (
	ClusteringPolicyEnterpriseCluster ClusteringPolicy = "EnterpriseCluster"
	ClusteringPolicyOSSCluster        ClusteringPolicy = "OSSCluster"
)

type CreateResponse

type CreateResponse struct {
	Poller       polling.LongRunningPoller
	HttpResponse *http.Response
}

type Database

type Database struct {
	Id         *string             `json:"id,omitempty"`
	Name       *string             `json:"name,omitempty"`
	Properties *DatabaseProperties `json:"properties,omitempty"`
	Type       *string             `json:"type,omitempty"`
}

type DatabaseId

type DatabaseId struct {
	SubscriptionId    string
	ResourceGroupName string
	ClusterName       string
	DatabaseName      string
}

DatabaseId is a struct representing the Resource ID for a Database

func NewDatabaseID

func NewDatabaseID(subscriptionId string, resourceGroupName string, clusterName string, databaseName string) DatabaseId

NewDatabaseID returns a new DatabaseId struct

func ParseDatabaseID

func ParseDatabaseID(input string) (*DatabaseId, error)

ParseDatabaseID parses 'input' into a DatabaseId

func ParseDatabaseIDInsensitively

func ParseDatabaseIDInsensitively(input string) (*DatabaseId, error)

ParseDatabaseIDInsensitively parses 'input' case-insensitively into a DatabaseId note: this method should only be used for API response data and not user input

func (DatabaseId) ID

func (id DatabaseId) ID() string

ID returns the formatted Database ID

func (DatabaseId) Segments

func (id DatabaseId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Database ID

func (DatabaseId) String

func (id DatabaseId) String() string

String returns a human-readable description of this Database ID

type DatabasePredicate

type DatabasePredicate struct {
	Id   *string
	Name *string
	Type *string
}

func (DatabasePredicate) Matches

func (p DatabasePredicate) Matches(input Database) bool

type DatabaseProperties

type DatabaseProperties struct {
	ClientProtocol    *Protocol          `json:"clientProtocol,omitempty"`
	ClusteringPolicy  *ClusteringPolicy  `json:"clusteringPolicy,omitempty"`
	EvictionPolicy    *EvictionPolicy    `json:"evictionPolicy,omitempty"`
	Modules           *[]Module          `json:"modules,omitempty"`
	Persistence       *Persistence       `json:"persistence,omitempty"`
	Port              *int64             `json:"port,omitempty"`
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty"`
	ResourceState     *ResourceState     `json:"resourceState,omitempty"`
}

type DatabaseUpdate

type DatabaseUpdate struct {
	Properties *DatabaseProperties `json:"properties,omitempty"`
}

type DatabasesClient

type DatabasesClient struct {
	Client autorest.Client
	// contains filtered or unexported fields
}

func NewDatabasesClientWithBaseURI

func NewDatabasesClientWithBaseURI(endpoint string) DatabasesClient

func (DatabasesClient) Create

func (c DatabasesClient) Create(ctx context.Context, id DatabaseId, input Database) (result CreateResponse, err error)

Create ...

func (DatabasesClient) CreateThenPoll

func (c DatabasesClient) CreateThenPoll(ctx context.Context, id DatabaseId, input Database) error

CreateThenPoll performs Create then polls until it's completed

func (DatabasesClient) Delete

func (c DatabasesClient) Delete(ctx context.Context, id DatabaseId) (result DeleteResponse, err error)

Delete ...

func (DatabasesClient) DeleteThenPoll

func (c DatabasesClient) DeleteThenPoll(ctx context.Context, id DatabaseId) error

DeleteThenPoll performs Delete then polls until it's completed

func (DatabasesClient) Export

func (c DatabasesClient) Export(ctx context.Context, id DatabaseId, input ExportClusterParameters) (result ExportResponse, err error)

Export ...

func (DatabasesClient) ExportThenPoll

func (c DatabasesClient) ExportThenPoll(ctx context.Context, id DatabaseId, input ExportClusterParameters) error

ExportThenPoll performs Export then polls until it's completed

func (DatabasesClient) Get

func (c DatabasesClient) Get(ctx context.Context, id DatabaseId) (result GetResponse, err error)

Get ...

func (DatabasesClient) Import

func (c DatabasesClient) Import(ctx context.Context, id DatabaseId, input ImportClusterParameters) (result ImportResponse, err error)

Import ...

func (DatabasesClient) ImportThenPoll

func (c DatabasesClient) ImportThenPoll(ctx context.Context, id DatabaseId, input ImportClusterParameters) error

ImportThenPoll performs Import then polls until it's completed

func (DatabasesClient) ListByCluster

func (c DatabasesClient) ListByCluster(ctx context.Context, id RedisEnterpriseId) (resp ListByClusterResponse, err error)

ListByCluster ...

func (DatabasesClient) ListByClusterComplete

ListByClusterComplete retrieves all of the results into a single object

func (DatabasesClient) ListByClusterCompleteMatchingPredicate

func (c DatabasesClient) ListByClusterCompleteMatchingPredicate(ctx context.Context, id RedisEnterpriseId, predicate DatabasePredicate) (resp ListByClusterCompleteResult, err error)

ListByClusterCompleteMatchingPredicate retrieves all of the results and then applied the predicate

func (DatabasesClient) ListKeys

func (c DatabasesClient) ListKeys(ctx context.Context, id DatabaseId) (result ListKeysResponse, err error)

ListKeys ...

func (DatabasesClient) RegenerateKey

func (c DatabasesClient) RegenerateKey(ctx context.Context, id DatabaseId, input RegenerateKeyParameters) (result RegenerateKeyResponse, err error)

RegenerateKey ...

func (DatabasesClient) RegenerateKeyThenPoll

func (c DatabasesClient) RegenerateKeyThenPoll(ctx context.Context, id DatabaseId, input RegenerateKeyParameters) error

RegenerateKeyThenPoll performs RegenerateKey then polls until it's completed

func (DatabasesClient) Update

func (c DatabasesClient) Update(ctx context.Context, id DatabaseId, input DatabaseUpdate) (result UpdateResponse, err error)

Update ...

func (DatabasesClient) UpdateThenPoll

func (c DatabasesClient) UpdateThenPoll(ctx context.Context, id DatabaseId, input DatabaseUpdate) error

UpdateThenPoll performs Update then polls until it's completed

type DeleteResponse

type DeleteResponse struct {
	Poller       polling.LongRunningPoller
	HttpResponse *http.Response
}

type EvictionPolicy

type EvictionPolicy string
const (
	EvictionPolicyAllKeysLFU     EvictionPolicy = "AllKeysLFU"
	EvictionPolicyAllKeysLRU     EvictionPolicy = "AllKeysLRU"
	EvictionPolicyAllKeysRandom  EvictionPolicy = "AllKeysRandom"
	EvictionPolicyNoEviction     EvictionPolicy = "NoEviction"
	EvictionPolicyVolatileLFU    EvictionPolicy = "VolatileLFU"
	EvictionPolicyVolatileLRU    EvictionPolicy = "VolatileLRU"
	EvictionPolicyVolatileRandom EvictionPolicy = "VolatileRandom"
	EvictionPolicyVolatileTTL    EvictionPolicy = "VolatileTTL"
)

type ExportClusterParameters

type ExportClusterParameters struct {
	SasUri string `json:"sasUri"`
}

type ExportResponse

type ExportResponse struct {
	Poller       polling.LongRunningPoller
	HttpResponse *http.Response
}

type GetResponse

type GetResponse struct {
	HttpResponse *http.Response
	Model        *Database
}

type ImportClusterParameters

type ImportClusterParameters struct {
	SasUris []string `json:"sasUris"`
}

type ImportResponse

type ImportResponse struct {
	Poller       polling.LongRunningPoller
	HttpResponse *http.Response
}

type ListByClusterCompleteResult

type ListByClusterCompleteResult struct {
	Items []Database
}

type ListByClusterResponse

type ListByClusterResponse struct {
	HttpResponse *http.Response
	Model        *[]Database
	// contains filtered or unexported fields
}

func (ListByClusterResponse) HasMore

func (r ListByClusterResponse) HasMore() bool

func (ListByClusterResponse) LoadMore

func (r ListByClusterResponse) LoadMore(ctx context.Context) (resp ListByClusterResponse, err error)

type ListKeysResponse

type ListKeysResponse struct {
	HttpResponse *http.Response
	Model        *AccessKeys
}

type Module

type Module struct {
	Args    *string `json:"args,omitempty"`
	Name    string  `json:"name"`
	Version *string `json:"version,omitempty"`
}

type Persistence

type Persistence struct {
	AofEnabled   *bool         `json:"aofEnabled,omitempty"`
	AofFrequency *AofFrequency `json:"aofFrequency,omitempty"`
	RdbEnabled   *bool         `json:"rdbEnabled,omitempty"`
	RdbFrequency *RdbFrequency `json:"rdbFrequency,omitempty"`
}

type Protocol

type Protocol string
const (
	ProtocolEncrypted Protocol = "Encrypted"
	ProtocolPlaintext Protocol = "Plaintext"
)

type ProvisioningState

type ProvisioningState string
const (
	ProvisioningStateCanceled  ProvisioningState = "Canceled"
	ProvisioningStateCreating  ProvisioningState = "Creating"
	ProvisioningStateDeleting  ProvisioningState = "Deleting"
	ProvisioningStateFailed    ProvisioningState = "Failed"
	ProvisioningStateSucceeded ProvisioningState = "Succeeded"
	ProvisioningStateUpdating  ProvisioningState = "Updating"
)

type RdbFrequency

type RdbFrequency string
const (
	RdbFrequencyOneTwoh RdbFrequency = "12h"
	RdbFrequencyOneh    RdbFrequency = "1h"
	RdbFrequencySixh    RdbFrequency = "6h"
)

type RedisEnterpriseId

type RedisEnterpriseId struct {
	SubscriptionId    string
	ResourceGroupName string
	ClusterName       string
}

RedisEnterpriseId is a struct representing the Resource ID for a Redis Enterprise

func NewRedisEnterpriseID

func NewRedisEnterpriseID(subscriptionId string, resourceGroupName string, clusterName string) RedisEnterpriseId

NewRedisEnterpriseID returns a new RedisEnterpriseId struct

func ParseRedisEnterpriseID

func ParseRedisEnterpriseID(input string) (*RedisEnterpriseId, error)

ParseRedisEnterpriseID parses 'input' into a RedisEnterpriseId

func ParseRedisEnterpriseIDInsensitively

func ParseRedisEnterpriseIDInsensitively(input string) (*RedisEnterpriseId, error)

ParseRedisEnterpriseIDInsensitively parses 'input' case-insensitively into a RedisEnterpriseId note: this method should only be used for API response data and not user input

func (RedisEnterpriseId) ID

func (id RedisEnterpriseId) ID() string

ID returns the formatted Redis Enterprise ID

func (RedisEnterpriseId) Segments

func (id RedisEnterpriseId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Redis Enterprise ID

func (RedisEnterpriseId) String

func (id RedisEnterpriseId) String() string

String returns a human-readable description of this Redis Enterprise ID

type RegenerateKeyParameters

type RegenerateKeyParameters struct {
	KeyType AccessKeyType `json:"keyType"`
}

type RegenerateKeyResponse

type RegenerateKeyResponse struct {
	Poller       polling.LongRunningPoller
	HttpResponse *http.Response
}

type ResourceState

type ResourceState string
const (
	ResourceStateCreateFailed  ResourceState = "CreateFailed"
	ResourceStateCreating      ResourceState = "Creating"
	ResourceStateDeleteFailed  ResourceState = "DeleteFailed"
	ResourceStateDeleting      ResourceState = "Deleting"
	ResourceStateDisableFailed ResourceState = "DisableFailed"
	ResourceStateDisabled      ResourceState = "Disabled"
	ResourceStateDisabling     ResourceState = "Disabling"
	ResourceStateEnableFailed  ResourceState = "EnableFailed"
	ResourceStateEnabling      ResourceState = "Enabling"
	ResourceStateRunning       ResourceState = "Running"
	ResourceStateUpdateFailed  ResourceState = "UpdateFailed"
	ResourceStateUpdating      ResourceState = "Updating"
)

type UpdateResponse

type UpdateResponse struct {
	Poller       polling.LongRunningPoller
	HttpResponse *http.Response
}

Jump to

Keyboard shortcuts

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