operationstatus

README

github.com/hashicorp/go-azure-sdk/resource-manager/storagesync/2020-03-01/operationstatus Documentation

The operationstatus SDK allows for interaction with the Azure Resource Manager Service storagesync (API Version 2020-03-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/storagesync/2020-03-01/operationstatus"

Client Initialization

client := operationstatus.NewOperationStatusClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: OperationStatusClient.LocationOperationStatus

ctx := context.TODO()
id := operationstatus.NewOperationID("12345678-1234-9876-4563-123456789012", "locationValue", "operationIdValue")

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

Documentation

Index

• func ValidateOperationID(input interface{}, key string) (warnings []string, errors []error)
• type LocationOperationStatus
  • func (o *LocationOperationStatus) GetEndTimeAsTime() (*time.Time, error)
  • func (o *LocationOperationStatus) GetStartTimeAsTime() (*time.Time, error)
  • func (o *LocationOperationStatus) SetEndTimeAsTime(input time.Time)
  • func (o *LocationOperationStatus) SetStartTimeAsTime(input time.Time)
• type LocationOperationStatusOperationResponse
• type OperationId
  • func NewOperationID(subscriptionId string, locationName string, operationId string) OperationId
  • func ParseOperationID(input string) (*OperationId, error)
  • func ParseOperationIDInsensitively(input string) (*OperationId, error)
  • func (id OperationId) ID() string
  • func (id OperationId) Segments() []resourceids.Segment
  • func (id OperationId) String() string
• type OperationStatusClient
  • func NewOperationStatusClientWithBaseURI(sdkApi sdkEnv.Api) (*OperationStatusClient, error)
  • func (c OperationStatusClient) LocationOperationStatus(ctx context.Context, id OperationId) (result LocationOperationStatusOperationResponse, err error)
• type StorageSyncApiError
• type StorageSyncErrorDetails
• type StorageSyncInnerErrorDetails

Functions

func ValidateOperationID

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

ValidateOperationID checks that 'input' can be parsed as a Operation ID

Types

type LocationOperationStatus

type LocationOperationStatus struct {
	EndTime         *string              `json:"endTime,omitempty"`
	Error           *StorageSyncApiError `json:"error,omitempty"`
	Id              *string              `json:"id,omitempty"`
	Name            *string              `json:"name,omitempty"`
	PercentComplete *int64               `json:"percentComplete,omitempty"`
	StartTime       *string              `json:"startTime,omitempty"`
	Status          *string              `json:"status,omitempty"`
}

func (*LocationOperationStatus) GetEndTimeAsTime

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

func (*LocationOperationStatus) GetStartTimeAsTime

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

func (*LocationOperationStatus) SetEndTimeAsTime

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

func (*LocationOperationStatus) SetStartTimeAsTime

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

type LocationOperationStatusOperationResponse

type LocationOperationStatusOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *LocationOperationStatus
}

type OperationId

type OperationId struct {
	SubscriptionId string
	LocationName   string
	OperationId    string
}

OperationId is a struct representing the Resource ID for a Operation

func NewOperationID

func NewOperationID(subscriptionId string, locationName string, operationId string) OperationId

NewOperationID returns a new OperationId struct

func ParseOperationID

func ParseOperationID(input string) (*OperationId, error)

ParseOperationID parses 'input' into a OperationId

func ParseOperationIDInsensitively

func ParseOperationIDInsensitively(input string) (*OperationId, error)

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

func (OperationId) ID

func (id OperationId) ID() string

ID returns the formatted Operation ID

func (OperationId) Segments

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

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

func (OperationId) String

func (id OperationId) String() string

String returns a human-readable description of this Operation ID

type OperationStatusClient

type OperationStatusClient struct {
	Client *resourcemanager.Client
}

func NewOperationStatusClientWithBaseURI

func NewOperationStatusClientWithBaseURI(sdkApi sdkEnv.Api) (*OperationStatusClient, error)

func (OperationStatusClient) LocationOperationStatus

func (c OperationStatusClient) LocationOperationStatus(ctx context.Context, id OperationId) (result LocationOperationStatusOperationResponse, err error)

LocationOperationStatus ...

type StorageSyncApiError

type StorageSyncApiError struct {
	Code       *string                       `json:"code,omitempty"`
	Details    *StorageSyncErrorDetails      `json:"details,omitempty"`
	Innererror *StorageSyncInnerErrorDetails `json:"innererror,omitempty"`
	Message    *string                       `json:"message,omitempty"`
	Target     *string                       `json:"target,omitempty"`
}

type StorageSyncErrorDetails

type StorageSyncErrorDetails struct {
	Code          *string `json:"code,omitempty"`
	ExceptionType *string `json:"exceptionType,omitempty"`
	HTTPErrorCode *string `json:"httpErrorCode,omitempty"`
	HTTPMethod    *string `json:"httpMethod,omitempty"`
	HashedMessage *string `json:"hashedMessage,omitempty"`
	Message       *string `json:"message,omitempty"`
	RequestUri    *string `json:"requestUri,omitempty"`
	Target        *string `json:"target,omitempty"`
}

type StorageSyncInnerErrorDetails

type StorageSyncInnerErrorDetails struct {
	CallStack               *string `json:"callStack,omitempty"`
	InnerException          *string `json:"innerException,omitempty"`
	InnerExceptionCallStack *string `json:"innerExceptionCallStack,omitempty"`
	Message                 *string `json:"message,omitempty"`
}