autoexportjob

package
v0.20250213.1092825 Latest Latest
Warning

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

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

README

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

The autoexportjob 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/autoexportjob"

Client Initialization

client := autoexportjob.NewAutoExportJobClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: AutoExportJobClient.CreateOrUpdate

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

payload := autoexportjob.AutoExportJob{
	// ...
}


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

Example Usage: AutoExportJobClient.ListByAmlFilesystem

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

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

Example Usage: AutoExportJobClient.Update

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

payload := autoexportjob.AutoExportJobUpdate{
	// ...
}


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

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 ValidateAmlFilesystemID 

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

ValidateAmlFilesystemID checks that 'input' can be parsed as a Aml Filesystem ID

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 AmlFilesystemId 

type AmlFilesystemId struct {
	SubscriptionId    string
	ResourceGroupName string
	AmlFilesystemName string
}

AmlFilesystemId is a struct representing the Resource ID for a Aml Filesystem

func NewAmlFilesystemID 

func NewAmlFilesystemID(subscriptionId string, resourceGroupName string, amlFilesystemName string) AmlFilesystemId

NewAmlFilesystemID returns a new AmlFilesystemId struct

func ParseAmlFilesystemID 

func ParseAmlFilesystemID(input string) (*AmlFilesystemId, error)

ParseAmlFilesystemID parses 'input' into a AmlFilesystemId

func ParseAmlFilesystemIDInsensitively 

func ParseAmlFilesystemIDInsensitively(input string) (*AmlFilesystemId, error)

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

func (*AmlFilesystemId) FromParseResult 

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

func (AmlFilesystemId) ID 

func (id AmlFilesystemId) ID() string

ID returns the formatted Aml Filesystem ID

func (AmlFilesystemId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Aml Filesystem ID

func (AmlFilesystemId) String 

func (id AmlFilesystemId) String() string

String returns a human-readable description of this Aml Filesystem ID

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 AutoExportJobClient 

type AutoExportJobClient struct {
	Client *resourcemanager.Client
}

func NewAutoExportJobClientWithBaseURI 

func NewAutoExportJobClientWithBaseURI(sdkApi sdkEnv.Api) (*AutoExportJobClient, error)

func (AutoExportJobClient) CreateOrUpdate 

func (c AutoExportJobClient) CreateOrUpdate(ctx context.Context, id AutoExportJobId, input AutoExportJob) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (AutoExportJobClient) CreateOrUpdateThenPoll 

func (c AutoExportJobClient) CreateOrUpdateThenPoll(ctx context.Context, id AutoExportJobId, input AutoExportJob) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (AutoExportJobClient) ListByAmlFilesystem 

func (c AutoExportJobClient) ListByAmlFilesystem(ctx context.Context, id AmlFilesystemId) (result ListByAmlFilesystemOperationResponse, err error)

ListByAmlFilesystem ...

func (AutoExportJobClient) ListByAmlFilesystemComplete 

func (c AutoExportJobClient) ListByAmlFilesystemComplete(ctx context.Context, id AmlFilesystemId) (ListByAmlFilesystemCompleteResult, error)

ListByAmlFilesystemComplete retrieves all the results into a single object

func (AutoExportJobClient) ListByAmlFilesystemCompleteMatchingPredicate 

func (c AutoExportJobClient) ListByAmlFilesystemCompleteMatchingPredicate(ctx context.Context, id AmlFilesystemId, predicate AutoExportJobOperationPredicate) (result ListByAmlFilesystemCompleteResult, err error)

ListByAmlFilesystemCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (AutoExportJobClient) Update 

func (c AutoExportJobClient) Update(ctx context.Context, id AutoExportJobId, input AutoExportJobUpdate) (result UpdateOperationResponse, err error)

Update ...

func (AutoExportJobClient) UpdateThenPoll 

func (c AutoExportJobClient) UpdateThenPoll(ctx context.Context, id AutoExportJobId, input AutoExportJobUpdate) error

UpdateThenPoll performs Update then polls until it's completed

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 AutoExportJobOperationPredicate 

type AutoExportJobOperationPredicate struct {
	Id       *string
	Location *string
	Name     *string
	Type     *string
}

func (AutoExportJobOperationPredicate) Matches 

func (p AutoExportJobOperationPredicate) Matches(input AutoExportJob) bool

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 AutoExportJobUpdate 

type AutoExportJobUpdate struct {
	Tags *map[string]string `json:"tags,omitempty"`
}

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 CreateOrUpdateOperationResponse 

type CreateOrUpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *AutoExportJob
}

type ListByAmlFilesystemCompleteResult 

type ListByAmlFilesystemCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []AutoExportJob
}

type ListByAmlFilesystemCustomPager 

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

type ListByAmlFilesystemOperationResponse 

type ListByAmlFilesystemOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]AutoExportJob
}

type UpdateOperationResponse 

type UpdateOperationResponse struct {
	Poller       pollers.Poller
	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.