fetchsecondaryrecoverypoints

package
v0.20240227.1165506 Latest Latest
Warning

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

 Go to latest Published: Feb 27, 2024 License: MPL-2.0 Imports: 13 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/dataprotection/2023-12-01/fetchsecondaryrecoverypoints Documentation

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

Client Initialization

client := fetchsecondaryrecoverypoints.NewFetchSecondaryRecoveryPointsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: FetchSecondaryRecoveryPointsClient.List

ctx := context.TODO()
id := fetchsecondaryrecoverypoints.NewProviderLocationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "locationValue")

payload := fetchsecondaryrecoverypoints.FetchSecondaryRPsRequestParameters{
	// ...
}


// alternatively `client.List(ctx, id, payload, fetchsecondaryrecoverypoints.DefaultListOperationOptions())` can be used to do batched pagination
items, err := client.ListComplete(ctx, id, payload, fetchsecondaryrecoverypoints.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 PossibleValuesForRecoveryPointCompletionState 

func PossibleValuesForRecoveryPointCompletionState() []string

func PossibleValuesForRehydrationStatus 

func PossibleValuesForRehydrationStatus() []string

func ValidateProviderLocationID 

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

ValidateProviderLocationID checks that 'input' can be parsed as a Provider Location ID

Types

type AzureBackupDiscreteRecoveryPoint 

type AzureBackupDiscreteRecoveryPoint struct {
	ExpiryTime                     *string                          `json:"expiryTime,omitempty"`
	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"`
	RecoveryPointState             *RecoveryPointCompletionState    `json:"recoveryPointState,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 AzureBackupRecoveryPointResourceList added in v0.20240226.1173038 

type AzureBackupRecoveryPointResourceList struct {
	NextLink *string                             `json:"nextLink,omitempty"`
	Value    *[]AzureBackupRecoveryPointResource `json:"value,omitempty"`
}

type AzureBackupRecoveryPointResourceListOperationPredicate added in v0.20240226.1173038 

type AzureBackupRecoveryPointResourceListOperationPredicate struct {
	NextLink *string
}

func (AzureBackupRecoveryPointResourceListOperationPredicate) Matches added in v0.20240226.1173038 

func (p AzureBackupRecoveryPointResourceListOperationPredicate) Matches(input AzureBackupRecoveryPointResourceList) bool

type FetchSecondaryRPsRequestParameters 

type FetchSecondaryRPsRequestParameters struct {
	SourceBackupInstanceId *string `json:"sourceBackupInstanceId,omitempty"`
	SourceRegion           *string `json:"sourceRegion,omitempty"`
}

type FetchSecondaryRecoveryPointsClient 

type FetchSecondaryRecoveryPointsClient struct {
	Client *resourcemanager.Client
}

func NewFetchSecondaryRecoveryPointsClientWithBaseURI 

func NewFetchSecondaryRecoveryPointsClientWithBaseURI(sdkApi sdkEnv.Api) (*FetchSecondaryRecoveryPointsClient, error)

func (FetchSecondaryRecoveryPointsClient) List 

func (c FetchSecondaryRecoveryPointsClient) List(ctx context.Context, id ProviderLocationId, input FetchSecondaryRPsRequestParameters, options ListOperationOptions) (result ListOperationResponse, err error)

List ...

func (FetchSecondaryRecoveryPointsClient) ListComplete 

func (c FetchSecondaryRecoveryPointsClient) ListComplete(ctx context.Context, id ProviderLocationId, input FetchSecondaryRPsRequestParameters, options ListOperationOptions) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (FetchSecondaryRecoveryPointsClient) ListCompleteMatchingPredicate 

func (c FetchSecondaryRecoveryPointsClient) ListCompleteMatchingPredicate(ctx context.Context, id ProviderLocationId, input FetchSecondaryRPsRequestParameters, options ListOperationOptions, predicate AzureBackupRecoveryPointResourceListOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type ListCompleteResult 

type ListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []AzureBackupRecoveryPointResourceList
}

type ListOperationOptions 

type ListOperationOptions struct {
	Filter *string
}

func DefaultListOperationOptions 

func DefaultListOperationOptions() ListOperationOptions

func (ListOperationOptions) ToHeaders 

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

func (ListOperationOptions) ToOData 

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

func (ListOperationOptions) ToQuery 

func (o ListOperationOptions) ToQuery() *client.QueryParams

type ListOperationResponse 

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

type ProviderLocationId 

type ProviderLocationId struct {
	SubscriptionId    string
	ResourceGroupName string
	LocationName      string
}

ProviderLocationId is a struct representing the Resource ID for a Provider Location

func NewProviderLocationID 

func NewProviderLocationID(subscriptionId string, resourceGroupName string, locationName string) ProviderLocationId

NewProviderLocationID returns a new ProviderLocationId struct

func ParseProviderLocationID 

func ParseProviderLocationID(input string) (*ProviderLocationId, error)

ParseProviderLocationID parses 'input' into a ProviderLocationId

func ParseProviderLocationIDInsensitively 

func ParseProviderLocationIDInsensitively(input string) (*ProviderLocationId, error)

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

func (*ProviderLocationId) FromParseResult 

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

func (ProviderLocationId) ID 

func (id ProviderLocationId) ID() string

ID returns the formatted Provider Location ID

func (ProviderLocationId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Provider Location ID

func (ProviderLocationId) String 

func (id ProviderLocationId) String() string

String returns a human-readable description of this Provider Location ID

type RawAzureBackupRecoveryPointImpl 

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

RawAzureBackupRecoveryPointImpl 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 RecoveryPointCompletionState 

type RecoveryPointCompletionState string
const (
	RecoveryPointCompletionStateCompleted RecoveryPointCompletionState = "Completed"
	RecoveryPointCompletionStatePartial   RecoveryPointCompletionState = "Partial"
)

func (*RecoveryPointCompletionState) UnmarshalJSON 

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

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)

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 

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

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.