workflowresource

package
v0.20240404.1145457 Latest Latest
Warning

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

 Go to latest Published: Apr 4, 2024 License: MPL-2.0 Imports: 13 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/storagesync/2022-09-01/workflowresource Documentation

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

Client Initialization

client := workflowresource.NewWorkflowResourceClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: WorkflowResourceClient.WorkflowsAbort

ctx := context.TODO()
id := workflowresource.NewWorkflowID("12345678-1234-9876-4563-123456789012", "example-resource-group", "storageSyncServiceValue", "workflowIdValue")

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

Example Usage: WorkflowResourceClient.WorkflowsGet

ctx := context.TODO()
id := workflowresource.NewWorkflowID("12345678-1234-9876-4563-123456789012", "example-resource-group", "storageSyncServiceValue", "workflowIdValue")

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

Example Usage: WorkflowResourceClient.WorkflowsListByStorageSyncService

ctx := context.TODO()
id := workflowresource.NewStorageSyncServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "storageSyncServiceValue")

read, err := client.WorkflowsListByStorageSyncService(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 PossibleValuesForOperationDirection 

func PossibleValuesForOperationDirection() []string

func PossibleValuesForWorkflowStatus 

func PossibleValuesForWorkflowStatus() []string

func ValidateStorageSyncServiceID 

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

ValidateStorageSyncServiceID checks that 'input' can be parsed as a Storage Sync Service ID

func ValidateWorkflowID 

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

ValidateWorkflowID checks that 'input' can be parsed as a Workflow ID

Types

type OperationDirection 

type OperationDirection string
const (
	OperationDirectionCancel OperationDirection = "cancel"
	OperationDirectionDo     OperationDirection = "do"
	OperationDirectionUndo   OperationDirection = "undo"
)

func (*OperationDirection) UnmarshalJSON 

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

type StorageSyncServiceId 

type StorageSyncServiceId struct {
	SubscriptionId         string
	ResourceGroupName      string
	StorageSyncServiceName string
}

StorageSyncServiceId is a struct representing the Resource ID for a Storage Sync Service

func NewStorageSyncServiceID 

func NewStorageSyncServiceID(subscriptionId string, resourceGroupName string, storageSyncServiceName string) StorageSyncServiceId

NewStorageSyncServiceID returns a new StorageSyncServiceId struct

func ParseStorageSyncServiceID 

func ParseStorageSyncServiceID(input string) (*StorageSyncServiceId, error)

ParseStorageSyncServiceID parses 'input' into a StorageSyncServiceId

func ParseStorageSyncServiceIDInsensitively 

func ParseStorageSyncServiceIDInsensitively(input string) (*StorageSyncServiceId, error)

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

func (*StorageSyncServiceId) FromParseResult 

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

func (StorageSyncServiceId) ID 

func (id StorageSyncServiceId) ID() string

ID returns the formatted Storage Sync Service ID

func (StorageSyncServiceId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Storage Sync Service ID

func (StorageSyncServiceId) String 

func (id StorageSyncServiceId) String() string

String returns a human-readable description of this Storage Sync Service ID

type Workflow 

type Workflow struct {
	Id         *string                `json:"id,omitempty"`
	Name       *string                `json:"name,omitempty"`
	Properties *WorkflowProperties    `json:"properties,omitempty"`
	SystemData *systemdata.SystemData `json:"systemData,omitempty"`
	Type       *string                `json:"type,omitempty"`
}

type WorkflowArray 

type WorkflowArray struct {
	Value *[]Workflow `json:"value,omitempty"`
}

type WorkflowId 

type WorkflowId struct {
	SubscriptionId         string
	ResourceGroupName      string
	StorageSyncServiceName string
	WorkflowId             string
}

WorkflowId is a struct representing the Resource ID for a Workflow

func NewWorkflowID 

func NewWorkflowID(subscriptionId string, resourceGroupName string, storageSyncServiceName string, workflowId string) WorkflowId

NewWorkflowID returns a new WorkflowId struct

func ParseWorkflowID 

func ParseWorkflowID(input string) (*WorkflowId, error)

ParseWorkflowID parses 'input' into a WorkflowId

func ParseWorkflowIDInsensitively 

func ParseWorkflowIDInsensitively(input string) (*WorkflowId, error)

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

func (*WorkflowId) FromParseResult 

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

func (WorkflowId) ID 

func (id WorkflowId) ID() string

ID returns the formatted Workflow ID

func (WorkflowId) Segments 

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

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

func (WorkflowId) String 

func (id WorkflowId) String() string

String returns a human-readable description of this Workflow ID

type WorkflowProperties 

type WorkflowProperties struct {
	CommandName         *string             `json:"commandName,omitempty"`
	CreatedTimestamp    *string             `json:"createdTimestamp,omitempty"`
	LastOperationId     *string             `json:"lastOperationId,omitempty"`
	LastStatusTimestamp *string             `json:"lastStatusTimestamp,omitempty"`
	LastStepName        *string             `json:"lastStepName,omitempty"`
	Operation           *OperationDirection `json:"operation,omitempty"`
	Status              *WorkflowStatus     `json:"status,omitempty"`
	Steps               *string             `json:"steps,omitempty"`
}

func (*WorkflowProperties) GetCreatedTimestampAsTime 

func (o *WorkflowProperties) GetCreatedTimestampAsTime() (*time.Time, error)

func (*WorkflowProperties) GetLastStatusTimestampAsTime 

func (o *WorkflowProperties) GetLastStatusTimestampAsTime() (*time.Time, error)

func (*WorkflowProperties) SetCreatedTimestampAsTime 

func (o *WorkflowProperties) SetCreatedTimestampAsTime(input time.Time)

func (*WorkflowProperties) SetLastStatusTimestampAsTime 

func (o *WorkflowProperties) SetLastStatusTimestampAsTime(input time.Time)

type WorkflowResourceClient 

type WorkflowResourceClient struct {
	Client *resourcemanager.Client
}

func NewWorkflowResourceClientWithBaseURI 

func NewWorkflowResourceClientWithBaseURI(sdkApi sdkEnv.Api) (*WorkflowResourceClient, error)

func (WorkflowResourceClient) WorkflowsAbort 

func (c WorkflowResourceClient) WorkflowsAbort(ctx context.Context, id WorkflowId) (result WorkflowsAbortOperationResponse, err error)

WorkflowsAbort ...

func (WorkflowResourceClient) WorkflowsGet 

func (c WorkflowResourceClient) WorkflowsGet(ctx context.Context, id WorkflowId) (result WorkflowsGetOperationResponse, err error)

WorkflowsGet ...

func (WorkflowResourceClient) WorkflowsListByStorageSyncService 

func (c WorkflowResourceClient) WorkflowsListByStorageSyncService(ctx context.Context, id StorageSyncServiceId) (result WorkflowsListByStorageSyncServiceOperationResponse, err error)

WorkflowsListByStorageSyncService ...

type WorkflowStatus 

type WorkflowStatus string
const (
	WorkflowStatusAborted   WorkflowStatus = "aborted"
	WorkflowStatusActive    WorkflowStatus = "active"
	WorkflowStatusExpired   WorkflowStatus = "expired"
	WorkflowStatusFailed    WorkflowStatus = "failed"
	WorkflowStatusSucceeded WorkflowStatus = "succeeded"
)

func (*WorkflowStatus) UnmarshalJSON 

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

type WorkflowsAbortOperationResponse 

type WorkflowsAbortOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

type WorkflowsGetOperationResponse 

type WorkflowsGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Workflow
}

type WorkflowsListByStorageSyncServiceOperationResponse 

type WorkflowsListByStorageSyncServiceOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *WorkflowArray
}

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.