recoverypoint

package
v0.20230815.1165905 Latest Latest
Warning

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

Go to latest
Published: Aug 15, 2023 License: MPL-2.0 Imports: 13 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/dataprotection/2022-05-01/recoverypoint Documentation

The recoverypoint SDK allows for interaction with the Azure Resource Manager Service dataprotection (API Version 2022-05-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/dataprotection/2022-05-01/recoverypoint"

Client Initialization

client := recoverypoint.NewRecoveryPointClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: RecoveryPointClient.Get

ctx := context.TODO()
id := recoverypoint.NewRecoveryPointID("12345678-1234-9876-4563-123456789012", "example-resource-group", "backupVaultValue", "backupInstanceValue", "recoveryPointIdValue")

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: RecoveryPointClient.List

ctx := context.TODO()
id := recoverypoint.NewBackupInstanceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "backupVaultValue", "backupInstanceValue")

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForRehydrationStatus

func PossibleValuesForRehydrationStatus() []string

func ValidateBackupInstanceID

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

ValidateBackupInstanceID checks that 'input' can be parsed as a Backup Instance ID

func ValidateRecoveryPointID

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

ValidateRecoveryPointID checks that 'input' can be parsed as a Recovery Point ID

Types

type AzureBackupDiscreteRecoveryPoint

type AzureBackupDiscreteRecoveryPoint struct {
	FriendlyName                   *string                          `json:"friendlyName,omitempty"`
	PolicyName                     *string                          `json:"policyName,omitempty"`
	PolicyVersion                  *string                          `json:"policyVersion,omitempty"`
	RecoveryPointDataStoresDetails *[]RecoveryPointDataStoreDetails `json:"recoveryPointDataStoresDetails,omitempty"`
	RecoveryPointId                *string                          `json:"recoveryPointId,omitempty"`
	RecoveryPointTime              string                           `json:"recoveryPointTime"`
	RecoveryPointType              *string                          `json:"recoveryPointType,omitempty"`
	RetentionTagName               *string                          `json:"retentionTagName,omitempty"`
	RetentionTagVersion            *string                          `json:"retentionTagVersion,omitempty"`
}

func (AzureBackupDiscreteRecoveryPoint) MarshalJSON

func (s AzureBackupDiscreteRecoveryPoint) MarshalJSON() ([]byte, error)

type AzureBackupRecoveryPoint

type AzureBackupRecoveryPoint interface {
}

type AzureBackupRecoveryPointResource

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

func (*AzureBackupRecoveryPointResource) UnmarshalJSON

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

type AzureBackupRecoveryPointResourceOperationPredicate

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

func (AzureBackupRecoveryPointResourceOperationPredicate) Matches

type BackupInstanceId

type BackupInstanceId struct {
	SubscriptionId     string
	ResourceGroupName  string
	BackupVaultName    string
	BackupInstanceName string
}

BackupInstanceId is a struct representing the Resource ID for a Backup Instance

func NewBackupInstanceID

func NewBackupInstanceID(subscriptionId string, resourceGroupName string, backupVaultName string, backupInstanceName string) BackupInstanceId

NewBackupInstanceID returns a new BackupInstanceId struct

func ParseBackupInstanceID

func ParseBackupInstanceID(input string) (*BackupInstanceId, error)

ParseBackupInstanceID parses 'input' into a BackupInstanceId

func ParseBackupInstanceIDInsensitively

func ParseBackupInstanceIDInsensitively(input string) (*BackupInstanceId, error)

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

func (BackupInstanceId) ID

func (id BackupInstanceId) ID() string

ID returns the formatted Backup Instance ID

func (BackupInstanceId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Backup Instance ID

func (BackupInstanceId) String

func (id BackupInstanceId) String() string

String returns a human-readable description of this Backup Instance ID

type GetOperationResponse

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

type ListCompleteResult

type ListCompleteResult struct {
	Items []AzureBackupRecoveryPointResource
}

type ListOperationOptions

type ListOperationOptions struct {
	Filter *string
}

func DefaultListOperationOptions

func DefaultListOperationOptions() ListOperationOptions

func (ListOperationOptions) ToHeaders added in v0.20230420.1093529

func (o ListOperationOptions) ToHeaders() *client.Headers

func (ListOperationOptions) ToOData added in v0.20230420.1093529

func (o ListOperationOptions) ToOData() *odata.Query

func (ListOperationOptions) ToQuery added in v0.20230420.1093529

type ListOperationResponse

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]AzureBackupRecoveryPointResource
}

type RawAzureBackupRecoveryPointImpl added in v0.20230807.1063129

type RawAzureBackupRecoveryPointImpl struct {
	Type   string
	Values map[string]interface{}
}

RawModeOfTransitImpl is returned when the Discriminated Value doesn't match any of the defined types NOTE: this should only be used when a type isn't defined for this type of Object (as a workaround) and is used only for Deserialization (e.g. this cannot be used as a Request Payload).

type RecoveryPointClient

type RecoveryPointClient struct {
	Client *resourcemanager.Client
}

func NewRecoveryPointClientWithBaseURI

func NewRecoveryPointClientWithBaseURI(sdkApi sdkEnv.Api) (*RecoveryPointClient, error)

func (RecoveryPointClient) Get

Get ...

func (RecoveryPointClient) List

List ...

func (RecoveryPointClient) ListComplete

ListComplete retrieves all the results into a single object

func (RecoveryPointClient) ListCompleteMatchingPredicate

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type RecoveryPointDataStoreDetails

type RecoveryPointDataStoreDetails struct {
	CreationTime          *string            `json:"creationTime,omitempty"`
	ExpiryTime            *string            `json:"expiryTime,omitempty"`
	Id                    *string            `json:"id,omitempty"`
	MetaData              *string            `json:"metaData,omitempty"`
	RehydrationExpiryTime *string            `json:"rehydrationExpiryTime,omitempty"`
	RehydrationStatus     *RehydrationStatus `json:"rehydrationStatus,omitempty"`
	State                 *string            `json:"state,omitempty"`
	Type                  *string            `json:"type,omitempty"`
	Visible               *bool              `json:"visible,omitempty"`
}

func (*RecoveryPointDataStoreDetails) GetCreationTimeAsTime

func (o *RecoveryPointDataStoreDetails) GetCreationTimeAsTime() (*time.Time, error)

func (*RecoveryPointDataStoreDetails) GetExpiryTimeAsTime

func (o *RecoveryPointDataStoreDetails) GetExpiryTimeAsTime() (*time.Time, error)

func (*RecoveryPointDataStoreDetails) GetRehydrationExpiryTimeAsTime

func (o *RecoveryPointDataStoreDetails) GetRehydrationExpiryTimeAsTime() (*time.Time, error)

func (*RecoveryPointDataStoreDetails) SetCreationTimeAsTime

func (o *RecoveryPointDataStoreDetails) SetCreationTimeAsTime(input time.Time)

func (*RecoveryPointDataStoreDetails) SetExpiryTimeAsTime

func (o *RecoveryPointDataStoreDetails) SetExpiryTimeAsTime(input time.Time)

func (*RecoveryPointDataStoreDetails) SetRehydrationExpiryTimeAsTime

func (o *RecoveryPointDataStoreDetails) SetRehydrationExpiryTimeAsTime(input time.Time)

type RecoveryPointId

type RecoveryPointId struct {
	SubscriptionId     string
	ResourceGroupName  string
	BackupVaultName    string
	BackupInstanceName string
	RecoveryPointId    string
}

RecoveryPointId is a struct representing the Resource ID for a Recovery Point

func NewRecoveryPointID

func NewRecoveryPointID(subscriptionId string, resourceGroupName string, backupVaultName string, backupInstanceName string, recoveryPointId string) RecoveryPointId

NewRecoveryPointID returns a new RecoveryPointId struct

func ParseRecoveryPointID

func ParseRecoveryPointID(input string) (*RecoveryPointId, error)

ParseRecoveryPointID parses 'input' into a RecoveryPointId

func ParseRecoveryPointIDInsensitively

func ParseRecoveryPointIDInsensitively(input string) (*RecoveryPointId, error)

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

func (RecoveryPointId) ID

func (id RecoveryPointId) ID() string

ID returns the formatted Recovery Point ID

func (RecoveryPointId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Recovery Point ID

func (RecoveryPointId) String

func (id RecoveryPointId) String() string

String returns a human-readable description of this Recovery Point ID

type RehydrationStatus

type RehydrationStatus string
const (
	RehydrationStatusCOMPLETED        RehydrationStatus = "COMPLETED"
	RehydrationStatusCREATEINPROGRESS RehydrationStatus = "CREATE_IN_PROGRESS"
	RehydrationStatusDELETED          RehydrationStatus = "DELETED"
	RehydrationStatusDELETEINPROGRESS RehydrationStatus = "DELETE_IN_PROGRESS"
	RehydrationStatusFAILED           RehydrationStatus = "FAILED"
)

func (*RehydrationStatus) UnmarshalJSON added in v0.20230420.1093529

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

Jump to

Keyboard shortcuts

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