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
}

Example Usage: OperationStatusClient.OperationStatusGet

ctx := context.TODO()
id := operationstatus.NewWorkflowOperationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "locationValue", "workflowIdValue", "operationIdValue")

read, err := client.OperationStatusGet(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)
• func ValidateWorkflowOperationID(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 OperationStatus
  • func (o *OperationStatus) GetEndTimeAsTime() (*time.Time, error)
  • func (o *OperationStatus) GetStartTimeAsTime() (*time.Time, error)
  • func (o *OperationStatus) SetEndTimeAsTime(input time.Time)
  • func (o *OperationStatus) SetStartTimeAsTime(input time.Time)
• type OperationStatusClient
  • func NewOperationStatusClientWithBaseURI(sdkApi sdkEnv.Api) (*OperationStatusClient, error)
  • func (c OperationStatusClient) LocationOperationStatus(ctx context.Context, id OperationId) (result LocationOperationStatusOperationResponse, err error)
  • func (c OperationStatusClient) OperationStatusGet(ctx context.Context, id WorkflowOperationId) (result OperationStatusGetOperationResponse, err error)
• type OperationStatusGetOperationResponse
• type StorageSyncApiError
• type StorageSyncErrorDetails
• type StorageSyncInnerErrorDetails
• type WorkflowOperationId
  • func NewWorkflowOperationID(subscriptionId string, resourceGroupName string, locationName string, ...) WorkflowOperationId
  • func ParseWorkflowOperationID(input string) (*WorkflowOperationId, error)
  • func ParseWorkflowOperationIDInsensitively(input string) (*WorkflowOperationId, error)
  • func (id WorkflowOperationId) ID() string
  • func (id WorkflowOperationId) Segments() []resourceids.Segment
  • func (id WorkflowOperationId) String() string

Functions

func ValidateOperationID

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

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

func ValidateWorkflowOperationID

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

ValidateWorkflowOperationID checks that 'input' can be parsed as a Workflow 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 OperationStatus

type OperationStatus struct {
	EndTime   *string              `json:"endTime,omitempty"`
	Error     *StorageSyncApiError `json:"error,omitempty"`
	Name      *string              `json:"name,omitempty"`
	StartTime *string              `json:"startTime,omitempty"`
	Status    *string              `json:"status,omitempty"`
}

func (*OperationStatus) GetEndTimeAsTime

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

func (*OperationStatus) GetStartTimeAsTime

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

func (*OperationStatus) SetEndTimeAsTime

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

func (*OperationStatus) SetStartTimeAsTime

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

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 ...

func (OperationStatusClient) OperationStatusGet

func (c OperationStatusClient) OperationStatusGet(ctx context.Context, id WorkflowOperationId) (result OperationStatusGetOperationResponse, err error)

OperationStatusGet ...

type OperationStatusGetOperationResponse

type OperationStatusGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *OperationStatus
}

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"`
}

type WorkflowOperationId

type WorkflowOperationId struct {
	SubscriptionId    string
	ResourceGroupName string
	LocationName      string
	WorkflowId        string
	OperationId       string
}

WorkflowOperationId is a struct representing the Resource ID for a Workflow Operation

func NewWorkflowOperationID

func NewWorkflowOperationID(subscriptionId string, resourceGroupName string, locationName string, workflowId string, operationId string) WorkflowOperationId

NewWorkflowOperationID returns a new WorkflowOperationId struct

func ParseWorkflowOperationID

func ParseWorkflowOperationID(input string) (*WorkflowOperationId, error)

ParseWorkflowOperationID parses 'input' into a WorkflowOperationId

func ParseWorkflowOperationIDInsensitively

func ParseWorkflowOperationIDInsensitively(input string) (*WorkflowOperationId, error)

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

func (WorkflowOperationId) ID

func (id WorkflowOperationId) ID() string

ID returns the formatted Workflow Operation ID

func (WorkflowOperationId) Segments

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

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

func (WorkflowOperationId) String

func (id WorkflowOperationId) String() string

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