operationprogress

README

github.com/hashicorp/go-azure-sdk/resource-manager/mysql/2023-12-30/operationprogress Documentation

The operationprogress SDK allows for interaction with Azure Resource Manager mysql (API Version 2023-12-30).

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/mysql/2023-12-30/operationprogress"

Client Initialization

client := operationprogress.NewOperationProgressClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: OperationProgressClient.Get

ctx := context.TODO()
id := operationprogress.NewOperationProgressID("12345678-1234-9876-4563-123456789012", "locationName", "operationId")

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

• func PossibleValuesForObjectType() []string
• func ValidateOperationProgressID(input interface{}, key string) (warnings []string, errors []error)
• type ErrorAdditionalInfo
• type ErrorDetail
• type GetOperationResponse
• type ObjectType
  • func (s *ObjectType) UnmarshalJSON(bytes []byte) error
• type OperationProgressClient
  • func NewOperationProgressClientWithBaseURI(sdkApi sdkEnv.Api) (*OperationProgressClient, error)
  • func (c OperationProgressClient) Get(ctx context.Context, id OperationProgressId) (result GetOperationResponse, err error)
• type OperationProgressId
  • func NewOperationProgressID(subscriptionId string, locationName string, operationId string) OperationProgressId
  • func ParseOperationProgressID(input string) (*OperationProgressId, error)
  • func ParseOperationProgressIDInsensitively(input string) (*OperationProgressId, error)
  • func (id *OperationProgressId) FromParseResult(input resourceids.ParseResult) error
  • func (id OperationProgressId) ID() string
  • func (id OperationProgressId) Segments() []resourceids.Segment
  • func (id OperationProgressId) String() string
• type OperationProgressResponseType
• type OperationProgressResult
  • func (o *OperationProgressResult) GetEndTimeAsTime() (*time.Time, error)
  • func (o *OperationProgressResult) GetStartTimeAsTime() (*time.Time, error)
  • func (o *OperationProgressResult) SetEndTimeAsTime(input time.Time)
  • func (o *OperationProgressResult) SetStartTimeAsTime(input time.Time)
• type OperationStatusResult
  • func (o *OperationStatusResult) GetEndTimeAsTime() (*time.Time, error)
  • func (o *OperationStatusResult) GetStartTimeAsTime() (*time.Time, error)
  • func (o *OperationStatusResult) SetEndTimeAsTime(input time.Time)
  • func (o *OperationStatusResult) SetStartTimeAsTime(input time.Time)

Functions

func PossibleValuesForObjectType

func PossibleValuesForObjectType() []string

func ValidateOperationProgressID

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

ValidateOperationProgressID checks that 'input' can be parsed as a Operation Progress ID

Types

type ErrorAdditionalInfo

type ErrorAdditionalInfo struct {
	Info *interface{} `json:"info,omitempty"`
	Type *string      `json:"type,omitempty"`
}

type ErrorDetail

type ErrorDetail struct {
	AdditionalInfo *[]ErrorAdditionalInfo `json:"additionalInfo,omitempty"`
	Code           *string                `json:"code,omitempty"`
	Details        *[]ErrorDetail         `json:"details,omitempty"`
	Message        *string                `json:"message,omitempty"`
	Target         *string                `json:"target,omitempty"`
}

type GetOperationResponse

type GetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *OperationProgressResult
}

type ObjectType

type ObjectType string

const (
	ObjectTypeBackupAndExportResponse   ObjectType = "BackupAndExportResponse"
	ObjectTypeImportFromStorageResponse ObjectType = "ImportFromStorageResponse"
)

func (*ObjectType) UnmarshalJSON

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

type OperationProgressClient

type OperationProgressClient struct {
	Client *resourcemanager.Client
}

func NewOperationProgressClientWithBaseURI

func NewOperationProgressClientWithBaseURI(sdkApi sdkEnv.Api) (*OperationProgressClient, error)

func (OperationProgressClient) Get

func (c OperationProgressClient) Get(ctx context.Context, id OperationProgressId) (result GetOperationResponse, err error)

Get ...

type OperationProgressId

type OperationProgressId struct {
	SubscriptionId string
	LocationName   string
	OperationId    string
}

OperationProgressId is a struct representing the Resource ID for a Operation Progress

func NewOperationProgressID

func NewOperationProgressID(subscriptionId string, locationName string, operationId string) OperationProgressId

NewOperationProgressID returns a new OperationProgressId struct

func ParseOperationProgressID

func ParseOperationProgressID(input string) (*OperationProgressId, error)

ParseOperationProgressID parses 'input' into a OperationProgressId

func ParseOperationProgressIDInsensitively

func ParseOperationProgressIDInsensitively(input string) (*OperationProgressId, error)

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

func (*OperationProgressId) FromParseResult

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

func (OperationProgressId) ID

func (id OperationProgressId) ID() string

ID returns the formatted Operation Progress ID

func (OperationProgressId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Operation Progress ID

func (OperationProgressId) String

func (id OperationProgressId) String() string

String returns a human-readable description of this Operation Progress ID

type OperationProgressResponseType

type OperationProgressResponseType struct {
	ObjectType ObjectType `json:"objectType"`
}

type OperationProgressResult

type OperationProgressResult struct {
	EndTime         *string                        `json:"endTime,omitempty"`
	Error           *ErrorDetail                   `json:"error,omitempty"`
	Id              *string                        `json:"id,omitempty"`
	Name            *string                        `json:"name,omitempty"`
	Operations      *[]OperationStatusResult       `json:"operations,omitempty"`
	PercentComplete *float64                       `json:"percentComplete,omitempty"`
	Properties      *OperationProgressResponseType `json:"properties,omitempty"`
	ResourceId      *string                        `json:"resourceId,omitempty"`
	StartTime       *string                        `json:"startTime,omitempty"`
	Status          string                         `json:"status"`
}

func (*OperationProgressResult) GetEndTimeAsTime

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

func (*OperationProgressResult) GetStartTimeAsTime

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

func (*OperationProgressResult) SetEndTimeAsTime

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

func (*OperationProgressResult) SetStartTimeAsTime

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

type OperationStatusResult

type OperationStatusResult struct {
	EndTime         *string                  `json:"endTime,omitempty"`
	Error           *ErrorDetail             `json:"error,omitempty"`
	Id              *string                  `json:"id,omitempty"`
	Name            *string                  `json:"name,omitempty"`
	Operations      *[]OperationStatusResult `json:"operations,omitempty"`
	PercentComplete *float64                 `json:"percentComplete,omitempty"`
	ResourceId      *string                  `json:"resourceId,omitempty"`
	StartTime       *string                  `json:"startTime,omitempty"`
	Status          string                   `json:"status"`
}

func (*OperationStatusResult) GetEndTimeAsTime

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

func (*OperationStatusResult) GetStartTimeAsTime

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

func (*OperationStatusResult) SetEndTimeAsTime

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

func (*OperationStatusResult) SetStartTimeAsTime

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