autoexportjobs

package
v0.20250224.1153124 Latest Latest
Warning

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

 Go to latest Published: Feb 24, 2025 License: MPL-2.0 Imports: 15 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/storagecache/2024-07-01/autoexportjobs Documentation

The autoexportjobs SDK allows for interaction with Azure Resource Manager storagecache (API Version 2024-07-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/storagecache/2024-07-01/autoexportjobs"

Client Initialization

client := autoexportjobs.NewAutoExportJobsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: AutoExportJobsClient.Delete

ctx := context.TODO()
id := autoexportjobs.NewAutoExportJobID("12345678-1234-9876-4563-123456789012", "example-resource-group", "amlFilesystemName", "autoExportJobName")

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

Example Usage: AutoExportJobsClient.Get

ctx := context.TODO()
id := autoexportjobs.NewAutoExportJobID("12345678-1234-9876-4563-123456789012", "example-resource-group", "amlFilesystemName", "autoExportJobName")

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
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForAutoExportJobAdminStatus 

func PossibleValuesForAutoExportJobAdminStatus() []string

func PossibleValuesForAutoExportJobProvisioningStateType 

func PossibleValuesForAutoExportJobProvisioningStateType() []string

func PossibleValuesForAutoExportStatusType 

func PossibleValuesForAutoExportStatusType() []string

func ValidateAutoExportJobID 

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

ValidateAutoExportJobID checks that 'input' can be parsed as a Auto Export Job ID

Types

type AutoExportJob 

type AutoExportJob struct {
	Id         *string                  `json:"id,omitempty"`
	Location   string                   `json:"location"`
	Name       *string                  `json:"name,omitempty"`
	Properties *AutoExportJobProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData   `json:"systemData,omitempty"`
	Tags       *map[string]string       `json:"tags,omitempty"`
	Type       *string                  `json:"type,omitempty"`
}

type AutoExportJobAdminStatus 

type AutoExportJobAdminStatus string
const (
	AutoExportJobAdminStatusActive AutoExportJobAdminStatus = "Active"
	AutoExportJobAdminStatusCancel AutoExportJobAdminStatus = "Cancel"
)

func (*AutoExportJobAdminStatus) UnmarshalJSON 

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

type AutoExportJobId 

type AutoExportJobId struct {
	SubscriptionId    string
	ResourceGroupName string
	AmlFilesystemName string
	AutoExportJobName string
}

AutoExportJobId is a struct representing the Resource ID for a Auto Export Job

func NewAutoExportJobID 

func NewAutoExportJobID(subscriptionId string, resourceGroupName string, amlFilesystemName string, autoExportJobName string) AutoExportJobId

NewAutoExportJobID returns a new AutoExportJobId struct

func ParseAutoExportJobID 

func ParseAutoExportJobID(input string) (*AutoExportJobId, error)

ParseAutoExportJobID parses 'input' into a AutoExportJobId

func ParseAutoExportJobIDInsensitively 

func ParseAutoExportJobIDInsensitively(input string) (*AutoExportJobId, error)

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

func (*AutoExportJobId) FromParseResult 

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

func (AutoExportJobId) ID 

func (id AutoExportJobId) ID() string

ID returns the formatted Auto Export Job ID

func (AutoExportJobId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Auto Export Job ID

func (AutoExportJobId) String 

func (id AutoExportJobId) String() string

String returns a human-readable description of this Auto Export Job ID

type AutoExportJobProperties 

type AutoExportJobProperties struct {
	AdminStatus        *AutoExportJobAdminStatus           `json:"adminStatus,omitempty"`
	AutoExportPrefixes *[]string                           `json:"autoExportPrefixes,omitempty"`
	ProvisioningState  *AutoExportJobProvisioningStateType `json:"provisioningState,omitempty"`
	Status             *AutoExportJobPropertiesStatus      `json:"status,omitempty"`
}

type AutoExportJobPropertiesStatus 

type AutoExportJobPropertiesStatus struct {
	CurrentIterationFilesDiscovered          *int64                `json:"currentIterationFilesDiscovered,omitempty"`
	CurrentIterationFilesExported            *int64                `json:"currentIterationFilesExported,omitempty"`
	CurrentIterationFilesFailed              *int64                `json:"currentIterationFilesFailed,omitempty"`
	CurrentIterationMiBDiscovered            *int64                `json:"currentIterationMiBDiscovered,omitempty"`
	CurrentIterationMiBExported              *int64                `json:"currentIterationMiBExported,omitempty"`
	ExportIterationCount                     *int64                `json:"exportIterationCount,omitempty"`
	LastCompletionTimeUTC                    *string               `json:"lastCompletionTimeUTC,omitempty"`
	LastStartedTimeUTC                       *string               `json:"lastStartedTimeUTC,omitempty"`
	LastSuccessfulIterationCompletionTimeUTC *string               `json:"lastSuccessfulIterationCompletionTimeUTC,omitempty"`
	State                                    *AutoExportStatusType `json:"state,omitempty"`
	StatusCode                               *string               `json:"statusCode,omitempty"`
	StatusMessage                            *string               `json:"statusMessage,omitempty"`
	TotalFilesExported                       *int64                `json:"totalFilesExported,omitempty"`
	TotalFilesFailed                         *int64                `json:"totalFilesFailed,omitempty"`
	TotalMiBExported                         *int64                `json:"totalMiBExported,omitempty"`
}

func (*AutoExportJobPropertiesStatus) GetLastCompletionTimeUTCAsTime 

func (o *AutoExportJobPropertiesStatus) GetLastCompletionTimeUTCAsTime() (*time.Time, error)

func (*AutoExportJobPropertiesStatus) GetLastStartedTimeUTCAsTime 

func (o *AutoExportJobPropertiesStatus) GetLastStartedTimeUTCAsTime() (*time.Time, error)

func (*AutoExportJobPropertiesStatus) GetLastSuccessfulIterationCompletionTimeUTCAsTime 

func (o *AutoExportJobPropertiesStatus) GetLastSuccessfulIterationCompletionTimeUTCAsTime() (*time.Time, error)

func (*AutoExportJobPropertiesStatus) SetLastCompletionTimeUTCAsTime 

func (o *AutoExportJobPropertiesStatus) SetLastCompletionTimeUTCAsTime(input time.Time)

func (*AutoExportJobPropertiesStatus) SetLastStartedTimeUTCAsTime 

func (o *AutoExportJobPropertiesStatus) SetLastStartedTimeUTCAsTime(input time.Time)

func (*AutoExportJobPropertiesStatus) SetLastSuccessfulIterationCompletionTimeUTCAsTime 

func (o *AutoExportJobPropertiesStatus) SetLastSuccessfulIterationCompletionTimeUTCAsTime(input time.Time)

type AutoExportJobProvisioningStateType 

type AutoExportJobProvisioningStateType string
const (
	AutoExportJobProvisioningStateTypeCanceled  AutoExportJobProvisioningStateType = "Canceled"
	AutoExportJobProvisioningStateTypeCreating  AutoExportJobProvisioningStateType = "Creating"
	AutoExportJobProvisioningStateTypeDeleting  AutoExportJobProvisioningStateType = "Deleting"
	AutoExportJobProvisioningStateTypeFailed    AutoExportJobProvisioningStateType = "Failed"
	AutoExportJobProvisioningStateTypeSucceeded AutoExportJobProvisioningStateType = "Succeeded"
	AutoExportJobProvisioningStateTypeUpdating  AutoExportJobProvisioningStateType = "Updating"
)

func (*AutoExportJobProvisioningStateType) UnmarshalJSON 

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

type AutoExportJobsClient 

type AutoExportJobsClient struct {
	Client *resourcemanager.Client
}

func NewAutoExportJobsClientWithBaseURI 

func NewAutoExportJobsClientWithBaseURI(sdkApi sdkEnv.Api) (*AutoExportJobsClient, error)

func (AutoExportJobsClient) Delete 

func (c AutoExportJobsClient) Delete(ctx context.Context, id AutoExportJobId) (result DeleteOperationResponse, err error)

Delete ...

func (AutoExportJobsClient) DeleteThenPoll 

func (c AutoExportJobsClient) DeleteThenPoll(ctx context.Context, id AutoExportJobId) error

DeleteThenPoll performs Delete then polls until it's completed

func (AutoExportJobsClient) Get 

func (c AutoExportJobsClient) Get(ctx context.Context, id AutoExportJobId) (result GetOperationResponse, err error)

Get ...

type AutoExportStatusType 

type AutoExportStatusType string
const (
	AutoExportStatusTypeDisableFailed AutoExportStatusType = "DisableFailed"
	AutoExportStatusTypeDisabled      AutoExportStatusType = "Disabled"
	AutoExportStatusTypeDisabling     AutoExportStatusType = "Disabling"
	AutoExportStatusTypeFailed        AutoExportStatusType = "Failed"
	AutoExportStatusTypeInProgress    AutoExportStatusType = "InProgress"
)

func (*AutoExportStatusType) UnmarshalJSON 

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

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        *AutoExportJob
}

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.