autonomousdatabasebackups

package
v0.20241029.1112340 Latest Latest
Warning

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

 Go to latest Published: Oct 29, 2024 License: MPL-2.0 Imports: 15 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/oracledatabase/2024-06-01/autonomousdatabasebackups Documentation

The autonomousdatabasebackups SDK allows for interaction with Azure Resource Manager oracledatabase (API Version 2024-06-01).

This readme covers example usages, but further information on using this SDK can be found in the project root.

Import Path

import "github.com/hashicorp/go-azure-sdk/resource-manager/oracledatabase/2024-06-01/autonomousdatabasebackups"

Client Initialization

client := autonomousdatabasebackups.NewAutonomousDatabaseBackupsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: AutonomousDatabaseBackupsClient.CreateOrUpdate

ctx := context.TODO()
id := autonomousdatabasebackups.NewAutonomousDatabaseBackupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "autonomousDatabaseName", "autonomousDatabaseBackupName")

payload := autonomousdatabasebackups.AutonomousDatabaseBackup{
	// ...
}


if err := client.CreateOrUpdateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: AutonomousDatabaseBackupsClient.Delete

ctx := context.TODO()
id := autonomousdatabasebackups.NewAutonomousDatabaseBackupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "autonomousDatabaseName", "autonomousDatabaseBackupName")

if err := client.DeleteThenPoll(ctx, id); err != nil {
	// handle the error
}

Example Usage: AutonomousDatabaseBackupsClient.Get

ctx := context.TODO()
id := autonomousdatabasebackups.NewAutonomousDatabaseBackupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "autonomousDatabaseName", "autonomousDatabaseBackupName")

read, err := client.Get(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: AutonomousDatabaseBackupsClient.ListByAutonomousDatabase

ctx := context.TODO()
id := autonomousdatabasebackups.NewAutonomousDatabaseID("12345678-1234-9876-4563-123456789012", "example-resource-group", "autonomousDatabaseName")

// alternatively `client.ListByAutonomousDatabase(ctx, id)` can be used to do batched pagination
items, err := client.ListByAutonomousDatabaseComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: AutonomousDatabaseBackupsClient.Update

ctx := context.TODO()
id := autonomousdatabasebackups.NewAutonomousDatabaseBackupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "autonomousDatabaseName", "autonomousDatabaseBackupName")

payload := autonomousdatabasebackups.AutonomousDatabaseBackupUpdate{
	// ...
}


if err := client.UpdateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForAutonomousDatabaseBackupLifecycleState 

func PossibleValuesForAutonomousDatabaseBackupLifecycleState() []string

func PossibleValuesForAutonomousDatabaseBackupType 

func PossibleValuesForAutonomousDatabaseBackupType() []string

func PossibleValuesForAzureResourceProvisioningState 

func PossibleValuesForAzureResourceProvisioningState() []string

func ValidateAutonomousDatabaseBackupID 

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

ValidateAutonomousDatabaseBackupID checks that 'input' can be parsed as a Autonomous Database Backup ID

func ValidateAutonomousDatabaseID 

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

ValidateAutonomousDatabaseID checks that 'input' can be parsed as a Autonomous Database ID

Types

type AutonomousDatabaseBackup 

type AutonomousDatabaseBackup struct {
	Id         *string                             `json:"id,omitempty"`
	Name       *string                             `json:"name,omitempty"`
	Properties *AutonomousDatabaseBackupProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData              `json:"systemData,omitempty"`
	Type       *string                             `json:"type,omitempty"`
}

type AutonomousDatabaseBackupId 

type AutonomousDatabaseBackupId struct {
	SubscriptionId               string
	ResourceGroupName            string
	AutonomousDatabaseName       string
	AutonomousDatabaseBackupName string
}

AutonomousDatabaseBackupId is a struct representing the Resource ID for a Autonomous Database Backup

func NewAutonomousDatabaseBackupID 

func NewAutonomousDatabaseBackupID(subscriptionId string, resourceGroupName string, autonomousDatabaseName string, autonomousDatabaseBackupName string) AutonomousDatabaseBackupId

NewAutonomousDatabaseBackupID returns a new AutonomousDatabaseBackupId struct

func ParseAutonomousDatabaseBackupID 

func ParseAutonomousDatabaseBackupID(input string) (*AutonomousDatabaseBackupId, error)

ParseAutonomousDatabaseBackupID parses 'input' into a AutonomousDatabaseBackupId

func ParseAutonomousDatabaseBackupIDInsensitively 

func ParseAutonomousDatabaseBackupIDInsensitively(input string) (*AutonomousDatabaseBackupId, error)

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

func (*AutonomousDatabaseBackupId) FromParseResult 

func (id *AutonomousDatabaseBackupId) FromParseResult(input resourceids.ParseResult) error

func (AutonomousDatabaseBackupId) ID 

func (id AutonomousDatabaseBackupId) ID() string

ID returns the formatted Autonomous Database Backup ID

func (AutonomousDatabaseBackupId) Segments 

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

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

func (AutonomousDatabaseBackupId) String 

func (id AutonomousDatabaseBackupId) String() string

String returns a human-readable description of this Autonomous Database Backup ID

type AutonomousDatabaseBackupLifecycleState 

type AutonomousDatabaseBackupLifecycleState string
const (
	AutonomousDatabaseBackupLifecycleStateActive   AutonomousDatabaseBackupLifecycleState = "Active"
	AutonomousDatabaseBackupLifecycleStateCreating AutonomousDatabaseBackupLifecycleState = "Creating"
	AutonomousDatabaseBackupLifecycleStateDeleting AutonomousDatabaseBackupLifecycleState = "Deleting"
	AutonomousDatabaseBackupLifecycleStateFailed   AutonomousDatabaseBackupLifecycleState = "Failed"
	AutonomousDatabaseBackupLifecycleStateUpdating AutonomousDatabaseBackupLifecycleState = "Updating"
)

func (*AutonomousDatabaseBackupLifecycleState) UnmarshalJSON 

func (s *AutonomousDatabaseBackupLifecycleState) UnmarshalJSON(bytes []byte) error

type AutonomousDatabaseBackupOperationPredicate 

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

func (AutonomousDatabaseBackupOperationPredicate) Matches 

func (p AutonomousDatabaseBackupOperationPredicate) Matches(input AutonomousDatabaseBackup) bool

type AutonomousDatabaseBackupProperties 

type AutonomousDatabaseBackupProperties struct {
	AutonomousDatabaseOcid *string                                 `json:"autonomousDatabaseOcid,omitempty"`
	BackupType             *AutonomousDatabaseBackupType           `json:"backupType,omitempty"`
	DatabaseSizeInTbs      *float64                                `json:"databaseSizeInTbs,omitempty"`
	DbVersion              *string                                 `json:"dbVersion,omitempty"`
	DisplayName            *string                                 `json:"displayName,omitempty"`
	IsAutomatic            *bool                                   `json:"isAutomatic,omitempty"`
	IsRestorable           *bool                                   `json:"isRestorable,omitempty"`
	LifecycleDetails       *string                                 `json:"lifecycleDetails,omitempty"`
	LifecycleState         *AutonomousDatabaseBackupLifecycleState `json:"lifecycleState,omitempty"`
	Ocid                   *string                                 `json:"ocid,omitempty"`
	ProvisioningState      *AzureResourceProvisioningState         `json:"provisioningState,omitempty"`
	RetentionPeriodInDays  *int64                                  `json:"retentionPeriodInDays,omitempty"`
	SizeInTbs              *float64                                `json:"sizeInTbs,omitempty"`
	TimeAvailableTil       *string                                 `json:"timeAvailableTil,omitempty"`
	TimeEnded              *string                                 `json:"timeEnded,omitempty"`
	TimeStarted            *string                                 `json:"timeStarted,omitempty"`
}

func (*AutonomousDatabaseBackupProperties) GetTimeAvailableTilAsTime 

func (o *AutonomousDatabaseBackupProperties) GetTimeAvailableTilAsTime() (*time.Time, error)

func (*AutonomousDatabaseBackupProperties) SetTimeAvailableTilAsTime 

func (o *AutonomousDatabaseBackupProperties) SetTimeAvailableTilAsTime(input time.Time)

type AutonomousDatabaseBackupType 

type AutonomousDatabaseBackupType string
const (
	AutonomousDatabaseBackupTypeFull        AutonomousDatabaseBackupType = "Full"
	AutonomousDatabaseBackupTypeIncremental AutonomousDatabaseBackupType = "Incremental"
	AutonomousDatabaseBackupTypeLongTerm    AutonomousDatabaseBackupType = "LongTerm"
)

func (*AutonomousDatabaseBackupType) UnmarshalJSON 

func (s *AutonomousDatabaseBackupType) UnmarshalJSON(bytes []byte) error

type AutonomousDatabaseBackupUpdate 

type AutonomousDatabaseBackupUpdate struct {
	Properties *AutonomousDatabaseBackupUpdateProperties `json:"properties,omitempty"`
}

type AutonomousDatabaseBackupUpdateProperties 

type AutonomousDatabaseBackupUpdateProperties struct {
	RetentionPeriodInDays *int64 `json:"retentionPeriodInDays,omitempty"`
}

type AutonomousDatabaseBackupsClient 

type AutonomousDatabaseBackupsClient struct {
	Client *resourcemanager.Client
}

func NewAutonomousDatabaseBackupsClientWithBaseURI 

func NewAutonomousDatabaseBackupsClientWithBaseURI(sdkApi sdkEnv.Api) (*AutonomousDatabaseBackupsClient, error)

func (AutonomousDatabaseBackupsClient) CreateOrUpdate 

func (c AutonomousDatabaseBackupsClient) CreateOrUpdate(ctx context.Context, id AutonomousDatabaseBackupId, input AutonomousDatabaseBackup) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (AutonomousDatabaseBackupsClient) CreateOrUpdateThenPoll 

func (c AutonomousDatabaseBackupsClient) CreateOrUpdateThenPoll(ctx context.Context, id AutonomousDatabaseBackupId, input AutonomousDatabaseBackup) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (AutonomousDatabaseBackupsClient) Delete 

func (c AutonomousDatabaseBackupsClient) Delete(ctx context.Context, id AutonomousDatabaseBackupId) (result DeleteOperationResponse, err error)

Delete ...

func (AutonomousDatabaseBackupsClient) DeleteThenPoll 

func (c AutonomousDatabaseBackupsClient) DeleteThenPoll(ctx context.Context, id AutonomousDatabaseBackupId) error

DeleteThenPoll performs Delete then polls until it's completed

func (AutonomousDatabaseBackupsClient) Get 

func (c AutonomousDatabaseBackupsClient) Get(ctx context.Context, id AutonomousDatabaseBackupId) (result GetOperationResponse, err error)

Get ...

func (AutonomousDatabaseBackupsClient) ListByAutonomousDatabase 

func (c AutonomousDatabaseBackupsClient) ListByAutonomousDatabase(ctx context.Context, id AutonomousDatabaseId) (result ListByAutonomousDatabaseOperationResponse, err error)

ListByAutonomousDatabase ...

func (AutonomousDatabaseBackupsClient) ListByAutonomousDatabaseComplete 

func (c AutonomousDatabaseBackupsClient) ListByAutonomousDatabaseComplete(ctx context.Context, id AutonomousDatabaseId) (ListByAutonomousDatabaseCompleteResult, error)

ListByAutonomousDatabaseComplete retrieves all the results into a single object

func (AutonomousDatabaseBackupsClient) ListByAutonomousDatabaseCompleteMatchingPredicate 

func (c AutonomousDatabaseBackupsClient) ListByAutonomousDatabaseCompleteMatchingPredicate(ctx context.Context, id AutonomousDatabaseId, predicate AutonomousDatabaseBackupOperationPredicate) (result ListByAutonomousDatabaseCompleteResult, err error)

ListByAutonomousDatabaseCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (AutonomousDatabaseBackupsClient) Update 

func (c AutonomousDatabaseBackupsClient) Update(ctx context.Context, id AutonomousDatabaseBackupId, input AutonomousDatabaseBackupUpdate) (result UpdateOperationResponse, err error)

Update ...

func (AutonomousDatabaseBackupsClient) UpdateThenPoll 

func (c AutonomousDatabaseBackupsClient) UpdateThenPoll(ctx context.Context, id AutonomousDatabaseBackupId, input AutonomousDatabaseBackupUpdate) error

UpdateThenPoll performs Update then polls until it's completed

type AutonomousDatabaseId 

type AutonomousDatabaseId struct {
	SubscriptionId         string
	ResourceGroupName      string
	AutonomousDatabaseName string
}

AutonomousDatabaseId is a struct representing the Resource ID for a Autonomous Database

func NewAutonomousDatabaseID 

func NewAutonomousDatabaseID(subscriptionId string, resourceGroupName string, autonomousDatabaseName string) AutonomousDatabaseId

NewAutonomousDatabaseID returns a new AutonomousDatabaseId struct

func ParseAutonomousDatabaseID 

func ParseAutonomousDatabaseID(input string) (*AutonomousDatabaseId, error)

ParseAutonomousDatabaseID parses 'input' into a AutonomousDatabaseId

func ParseAutonomousDatabaseIDInsensitively 

func ParseAutonomousDatabaseIDInsensitively(input string) (*AutonomousDatabaseId, error)

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

func (*AutonomousDatabaseId) FromParseResult 

func (id *AutonomousDatabaseId) FromParseResult(input resourceids.ParseResult) error

func (AutonomousDatabaseId) ID 

func (id AutonomousDatabaseId) ID() string

ID returns the formatted Autonomous Database ID

func (AutonomousDatabaseId) Segments 

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

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

func (AutonomousDatabaseId) String 

func (id AutonomousDatabaseId) String() string

String returns a human-readable description of this Autonomous Database ID

type AzureResourceProvisioningState 

type AzureResourceProvisioningState string
const (
	AzureResourceProvisioningStateCanceled     AzureResourceProvisioningState = "Canceled"
	AzureResourceProvisioningStateFailed       AzureResourceProvisioningState = "Failed"
	AzureResourceProvisioningStateProvisioning AzureResourceProvisioningState = "Provisioning"
	AzureResourceProvisioningStateSucceeded    AzureResourceProvisioningState = "Succeeded"
)

func (*AzureResourceProvisioningState) UnmarshalJSON 

func (s *AzureResourceProvisioningState) UnmarshalJSON(bytes []byte) error

type CreateOrUpdateOperationResponse 

type CreateOrUpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *AutonomousDatabaseBackup
}

type DeleteOperationResponse 

type DeleteOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type GetOperationResponse 

type GetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *AutonomousDatabaseBackup
}

type ListByAutonomousDatabaseCompleteResult 

type ListByAutonomousDatabaseCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []AutonomousDatabaseBackup
}

type ListByAutonomousDatabaseCustomPager 

type ListByAutonomousDatabaseCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ListByAutonomousDatabaseCustomPager) NextPageLink() *odata.Link

type ListByAutonomousDatabaseOperationResponse 

type ListByAutonomousDatabaseOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]AutonomousDatabaseBackup
}

type UpdateOperationResponse 

type UpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *AutonomousDatabaseBackup
}

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.