azurebackupjobs

package
v0.20240923.1142107 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/dataprotection/2023-05-01/azurebackupjobs Documentation

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

Client Initialization

client := azurebackupjobs.NewAzureBackupJobsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: AzureBackupJobsClient.JobsList

ctx := context.TODO()
id := azurebackupjobs.NewBackupVaultID("12345678-1234-9876-4563-123456789012", "example-resource-group", "vaultName")

// alternatively `client.JobsList(ctx, id)` can be used to do batched pagination
items, err := client.JobsListComplete(ctx, id)
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 ValidateBackupVaultID 

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

ValidateBackupVaultID checks that 'input' can be parsed as a Backup Vault ID

Types

type AzureBackupJob 

type AzureBackupJob struct {
	ActivityID                 string             `json:"activityID"`
	BackupInstanceFriendlyName string             `json:"backupInstanceFriendlyName"`
	BackupInstanceId           *string            `json:"backupInstanceId,omitempty"`
	DataSourceId               string             `json:"dataSourceId"`
	DataSourceLocation         string             `json:"dataSourceLocation"`
	DataSourceName             string             `json:"dataSourceName"`
	DataSourceSetName          *string            `json:"dataSourceSetName,omitempty"`
	DataSourceType             string             `json:"dataSourceType"`
	DestinationDataStoreName   *string            `json:"destinationDataStoreName,omitempty"`
	Duration                   *string            `json:"duration,omitempty"`
	EndTime                    *string            `json:"endTime,omitempty"`
	ErrorDetails               *[]UserFacingError `json:"errorDetails,omitempty"`
	Etag                       *string            `json:"etag,omitempty"`
	ExtendedInfo               *JobExtendedInfo   `json:"extendedInfo,omitempty"`
	IsUserTriggered            bool               `json:"isUserTriggered"`
	Operation                  string             `json:"operation"`
	OperationCategory          string             `json:"operationCategory"`
	PolicyId                   *string            `json:"policyId,omitempty"`
	PolicyName                 *string            `json:"policyName,omitempty"`
	ProgressEnabled            bool               `json:"progressEnabled"`
	ProgressUrl                *string            `json:"progressUrl,omitempty"`
	RehydrationPriority        *string            `json:"rehydrationPriority,omitempty"`
	RestoreType                *string            `json:"restoreType,omitempty"`
	SourceDataStoreName        *string            `json:"sourceDataStoreName,omitempty"`
	SourceResourceGroup        string             `json:"sourceResourceGroup"`
	SourceSubscriptionID       string             `json:"sourceSubscriptionID"`
	StartTime                  string             `json:"startTime"`
	Status                     string             `json:"status"`
	SubscriptionId             string             `json:"subscriptionId"`
	SupportedActions           []string           `json:"supportedActions"`
	VaultName                  string             `json:"vaultName"`
}

func (*AzureBackupJob) GetEndTimeAsTime 

func (o *AzureBackupJob) GetEndTimeAsTime() (*time.Time, error)

func (*AzureBackupJob) GetStartTimeAsTime 

func (o *AzureBackupJob) GetStartTimeAsTime() (*time.Time, error)

func (*AzureBackupJob) SetEndTimeAsTime 

func (o *AzureBackupJob) SetEndTimeAsTime(input time.Time)

func (*AzureBackupJob) SetStartTimeAsTime 

func (o *AzureBackupJob) SetStartTimeAsTime(input time.Time)

type AzureBackupJobResource 

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

type AzureBackupJobResourceOperationPredicate 

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

func (AzureBackupJobResourceOperationPredicate) Matches 

func (p AzureBackupJobResourceOperationPredicate) Matches(input AzureBackupJobResource) bool

type AzureBackupJobsClient 

type AzureBackupJobsClient struct {
	Client *resourcemanager.Client
}

func NewAzureBackupJobsClientWithBaseURI 

func NewAzureBackupJobsClientWithBaseURI(sdkApi sdkEnv.Api) (*AzureBackupJobsClient, error)

func (AzureBackupJobsClient) JobsList 

func (c AzureBackupJobsClient) JobsList(ctx context.Context, id BackupVaultId) (result JobsListOperationResponse, err error)

JobsList ...

func (AzureBackupJobsClient) JobsListComplete 

func (c AzureBackupJobsClient) JobsListComplete(ctx context.Context, id BackupVaultId) (JobsListCompleteResult, error)

JobsListComplete retrieves all the results into a single object

func (AzureBackupJobsClient) JobsListCompleteMatchingPredicate 

func (c AzureBackupJobsClient) JobsListCompleteMatchingPredicate(ctx context.Context, id BackupVaultId, predicate AzureBackupJobResourceOperationPredicate) (result JobsListCompleteResult, err error)

JobsListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type BackupVaultId 

type BackupVaultId struct {
	SubscriptionId    string
	ResourceGroupName string
	BackupVaultName   string
}

BackupVaultId is a struct representing the Resource ID for a Backup Vault

func NewBackupVaultID 

func NewBackupVaultID(subscriptionId string, resourceGroupName string, backupVaultName string) BackupVaultId

NewBackupVaultID returns a new BackupVaultId struct

func ParseBackupVaultID 

func ParseBackupVaultID(input string) (*BackupVaultId, error)

ParseBackupVaultID parses 'input' into a BackupVaultId

func ParseBackupVaultIDInsensitively 

func ParseBackupVaultIDInsensitively(input string) (*BackupVaultId, error)

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

func (*BackupVaultId) FromParseResult 

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

func (BackupVaultId) ID 

func (id BackupVaultId) ID() string

ID returns the formatted Backup Vault ID

func (BackupVaultId) Segments 

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

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

func (BackupVaultId) String 

func (id BackupVaultId) String() string

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

type InnerError 

type InnerError struct {
	AdditionalInfo     *map[string]string `json:"additionalInfo,omitempty"`
	Code               *string            `json:"code,omitempty"`
	EmbeddedInnerError *InnerError        `json:"embeddedInnerError,omitempty"`
}

type JobExtendedInfo 

type JobExtendedInfo struct {
	AdditionalDetails      *map[string]string              `json:"additionalDetails,omitempty"`
	BackupInstanceState    *string                         `json:"backupInstanceState,omitempty"`
	DataTransferredInBytes *float64                        `json:"dataTransferredInBytes,omitempty"`
	RecoveryDestination    *string                         `json:"recoveryDestination,omitempty"`
	SourceRecoverPoint     *RestoreJobRecoveryPointDetails `json:"sourceRecoverPoint,omitempty"`
	SubTasks               *[]JobSubTask                   `json:"subTasks,omitempty"`
	TargetRecoverPoint     *RestoreJobRecoveryPointDetails `json:"targetRecoverPoint,omitempty"`
}

type JobSubTask 

type JobSubTask struct {
	AdditionalDetails *map[string]string `json:"additionalDetails,omitempty"`
	TaskId            int64              `json:"taskId"`
	TaskName          string             `json:"taskName"`
	TaskProgress      *string            `json:"taskProgress,omitempty"`
	TaskStatus        string             `json:"taskStatus"`
}

type JobsListCompleteResult 

type JobsListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []AzureBackupJobResource
}

type JobsListCustomPager added in v0.20240628.1153531 

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

type JobsListOperationResponse 

type JobsListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]AzureBackupJobResource
}

type RestoreJobRecoveryPointDetails 

type RestoreJobRecoveryPointDetails struct {
	RecoveryPointID   *string `json:"recoveryPointID,omitempty"`
	RecoveryPointTime *string `json:"recoveryPointTime,omitempty"`
}

func (*RestoreJobRecoveryPointDetails) GetRecoveryPointTimeAsTime 

func (o *RestoreJobRecoveryPointDetails) GetRecoveryPointTimeAsTime() (*time.Time, error)

func (*RestoreJobRecoveryPointDetails) SetRecoveryPointTimeAsTime 

func (o *RestoreJobRecoveryPointDetails) SetRecoveryPointTimeAsTime(input time.Time)

type UserFacingError 

type UserFacingError struct {
	Code              *string            `json:"code,omitempty"`
	Details           *[]UserFacingError `json:"details,omitempty"`
	InnerError        *InnerError        `json:"innerError,omitempty"`
	IsRetryable       *bool              `json:"isRetryable,omitempty"`
	IsUserError       *bool              `json:"isUserError,omitempty"`
	Message           *string            `json:"message,omitempty"`
	Properties        *map[string]string `json:"properties,omitempty"`
	RecommendedAction *[]string          `json:"recommendedAction,omitempty"`
	Target            *string            `json:"target,omitempty"`
}

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.