dppjob

package
v0.20240611.1085123 Latest Latest
Warning

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

Go to latest
Published: Jun 11, 2024 License: MPL-2.0 Imports: 13 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/dataprotection/2024-04-01/dppjob Documentation

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

Client Initialization

client := dppjob.NewDppJobClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: DppJobClient.FetchCrossRegionRestoreJobGet

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

payload := dppjob.CrossRegionRestoreJobRequest{
	// ...
}


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

Example Usage: DppJobClient.FetchCrossRegionRestoreJobsList

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

payload := dppjob.CrossRegionRestoreJobsRequest{
	// ...
}


// alternatively `client.FetchCrossRegionRestoreJobsList(ctx, id, payload, dppjob.DefaultFetchCrossRegionRestoreJobsListOperationOptions())` can be used to do batched pagination
items, err := client.FetchCrossRegionRestoreJobsListComplete(ctx, id, payload, dppjob.DefaultFetchCrossRegionRestoreJobsListOperationOptions())
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 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 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

type CrossRegionRestoreJobRequest

type CrossRegionRestoreJobRequest struct {
	JobId               string `json:"jobId"`
	SourceBackupVaultId string `json:"sourceBackupVaultId"`
	SourceRegion        string `json:"sourceRegion"`
}

type CrossRegionRestoreJobsRequest

type CrossRegionRestoreJobsRequest struct {
	SourceBackupVaultId string `json:"sourceBackupVaultId"`
	SourceRegion        string `json:"sourceRegion"`
}

type DppJobClient

type DppJobClient struct {
	Client *resourcemanager.Client
}

func NewDppJobClientWithBaseURI

func NewDppJobClientWithBaseURI(sdkApi sdkEnv.Api) (*DppJobClient, error)

func (DppJobClient) FetchCrossRegionRestoreJobGet

FetchCrossRegionRestoreJobGet ...

func (DppJobClient) FetchCrossRegionRestoreJobsList

FetchCrossRegionRestoreJobsList ...

func (DppJobClient) FetchCrossRegionRestoreJobsListComplete

FetchCrossRegionRestoreJobsListComplete retrieves all the results into a single object

func (DppJobClient) FetchCrossRegionRestoreJobsListCompleteMatchingPredicate

FetchCrossRegionRestoreJobsListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type FetchCrossRegionRestoreJobGetOperationResponse

type FetchCrossRegionRestoreJobGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *AzureBackupJobResource
}

type FetchCrossRegionRestoreJobsListCompleteResult

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

type FetchCrossRegionRestoreJobsListOperationOptions

type FetchCrossRegionRestoreJobsListOperationOptions struct {
	Filter *string
}

func DefaultFetchCrossRegionRestoreJobsListOperationOptions

func DefaultFetchCrossRegionRestoreJobsListOperationOptions() FetchCrossRegionRestoreJobsListOperationOptions

func (FetchCrossRegionRestoreJobsListOperationOptions) ToHeaders

func (FetchCrossRegionRestoreJobsListOperationOptions) ToOData

func (FetchCrossRegionRestoreJobsListOperationOptions) ToQuery

type FetchCrossRegionRestoreJobsListOperationResponse

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

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"`
	WarningDetails         *[]UserFacingWarningDetail      `json:"warningDetails,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 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 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"`
}

type UserFacingWarningDetail

type UserFacingWarningDetail struct {
	ResourceName *string         `json:"resourceName,omitempty"`
	Warning      UserFacingError `json:"warning"`
}

Jump to

Keyboard shortcuts

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