workflowrunoperations

package
v0.20230911.1163300 Latest Latest
Warning

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

 Go to latest Published: Sep 11, 2023 License: MPL-2.0 Imports: 12 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/logic/2019-05-01/workflowrunoperations Documentation

The workflowrunoperations SDK allows for interaction with the Azure Resource Manager Service logic (API Version 2019-05-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/logic/2019-05-01/workflowrunoperations"

Client Initialization

client := workflowrunoperations.NewWorkflowRunOperationsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: WorkflowRunOperationsClient.Get

ctx := context.TODO()
id := workflowrunoperations.NewOperationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workflowValue", "runValue", "operationIdValue")

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

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForParameterType 

func PossibleValuesForParameterType() []string

func PossibleValuesForWorkflowStatus 

func PossibleValuesForWorkflowStatus() []string

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 ContentHash 

type ContentHash struct {
	Algorithm *string `json:"algorithm,omitempty"`
	Value     *string `json:"value,omitempty"`
}
type ContentLink struct {
	ContentHash    *ContentHash `json:"contentHash,omitempty"`
	ContentSize    *int64       `json:"contentSize,omitempty"`
	ContentVersion *string      `json:"contentVersion,omitempty"`
	Metadata       *interface{} `json:"metadata,omitempty"`
	Uri            *string      `json:"uri,omitempty"`
}

type Correlation 

type Correlation struct {
	ClientTrackingId *string `json:"clientTrackingId,omitempty"`
}

type GetOperationResponse 

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

type OperationId 

type OperationId struct {
	SubscriptionId    string
	ResourceGroupName string
	WorkflowName      string
	RunName           string
	OperationId       string
}

OperationId is a struct representing the Resource ID for a Operation

func NewOperationID 

func NewOperationID(subscriptionId string, resourceGroupName string, workflowName string, runName 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 ParameterType 

type ParameterType string
const (
	ParameterTypeArray        ParameterType = "Array"
	ParameterTypeBool         ParameterType = "Bool"
	ParameterTypeFloat        ParameterType = "Float"
	ParameterTypeInt          ParameterType = "Int"
	ParameterTypeNotSpecified ParameterType = "NotSpecified"
	ParameterTypeObject       ParameterType = "Object"
	ParameterTypeSecureObject ParameterType = "SecureObject"
	ParameterTypeSecureString ParameterType = "SecureString"
	ParameterTypeString       ParameterType = "String"
)

func (*ParameterType) UnmarshalJSON added in v0.20230712.1163130 

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

type ResourceReference 

type ResourceReference struct {
	Id   *string `json:"id,omitempty"`
	Name *string `json:"name,omitempty"`
	Type *string `json:"type,omitempty"`
}

type WorkflowOutputParameter 

type WorkflowOutputParameter struct {
	Description *string        `json:"description,omitempty"`
	Error       *interface{}   `json:"error,omitempty"`
	Metadata    *interface{}   `json:"metadata,omitempty"`
	Type        *ParameterType `json:"type,omitempty"`
	Value       *interface{}   `json:"value,omitempty"`
}

type WorkflowRun 

type WorkflowRun struct {
	Id         *string                `json:"id,omitempty"`
	Name       *string                `json:"name,omitempty"`
	Properties *WorkflowRunProperties `json:"properties,omitempty"`
	Type       *string                `json:"type,omitempty"`
}

type WorkflowRunOperationsClient 

type WorkflowRunOperationsClient struct {
	Client *resourcemanager.Client
}

func NewWorkflowRunOperationsClientWithBaseURI 

func NewWorkflowRunOperationsClientWithBaseURI(sdkApi sdkEnv.Api) (*WorkflowRunOperationsClient, error)

func (WorkflowRunOperationsClient) Get 

func (c WorkflowRunOperationsClient) Get(ctx context.Context, id OperationId) (result GetOperationResponse, err error)

Get ...

type WorkflowRunProperties 

type WorkflowRunProperties struct {
	Code          *string                             `json:"code,omitempty"`
	Correlation   *Correlation                        `json:"correlation,omitempty"`
	CorrelationId *string                             `json:"correlationId,omitempty"`
	EndTime       *string                             `json:"endTime,omitempty"`
	Error         *interface{}                        `json:"error,omitempty"`
	Outputs       *map[string]WorkflowOutputParameter `json:"outputs,omitempty"`
	Response      *WorkflowRunTrigger                 `json:"response,omitempty"`
	StartTime     *string                             `json:"startTime,omitempty"`
	Status        *WorkflowStatus                     `json:"status,omitempty"`
	Trigger       *WorkflowRunTrigger                 `json:"trigger,omitempty"`
	WaitEndTime   *string                             `json:"waitEndTime,omitempty"`
	Workflow      *ResourceReference                  `json:"workflow,omitempty"`
}

func (*WorkflowRunProperties) GetEndTimeAsTime 

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

func (*WorkflowRunProperties) GetStartTimeAsTime 

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

func (*WorkflowRunProperties) GetWaitEndTimeAsTime 

func (o *WorkflowRunProperties) GetWaitEndTimeAsTime() (*time.Time, error)

func (*WorkflowRunProperties) SetEndTimeAsTime 

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

func (*WorkflowRunProperties) SetStartTimeAsTime 

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

func (*WorkflowRunProperties) SetWaitEndTimeAsTime 

func (o *WorkflowRunProperties) SetWaitEndTimeAsTime(input time.Time)

type WorkflowRunTrigger 

type WorkflowRunTrigger struct {
	Code              *string         `json:"code,omitempty"`
	Correlation       *Correlation    `json:"correlation,omitempty"`
	EndTime           *string         `json:"endTime,omitempty"`
	Error             *interface{}    `json:"error,omitempty"`
	Inputs            *interface{}    `json:"inputs,omitempty"`
	InputsLink        *ContentLink    `json:"inputsLink,omitempty"`
	Name              *string         `json:"name,omitempty"`
	Outputs           *interface{}    `json:"outputs,omitempty"`
	OutputsLink       *ContentLink    `json:"outputsLink,omitempty"`
	ScheduledTime     *string         `json:"scheduledTime,omitempty"`
	StartTime         *string         `json:"startTime,omitempty"`
	Status            *WorkflowStatus `json:"status,omitempty"`
	TrackedProperties *interface{}    `json:"trackedProperties,omitempty"`
	TrackingId        *string         `json:"trackingId,omitempty"`
}

func (*WorkflowRunTrigger) GetEndTimeAsTime 

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

func (*WorkflowRunTrigger) GetScheduledTimeAsTime 

func (o *WorkflowRunTrigger) GetScheduledTimeAsTime() (*time.Time, error)

func (*WorkflowRunTrigger) GetStartTimeAsTime 

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

func (*WorkflowRunTrigger) SetEndTimeAsTime 

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

func (*WorkflowRunTrigger) SetScheduledTimeAsTime 

func (o *WorkflowRunTrigger) SetScheduledTimeAsTime(input time.Time)

func (*WorkflowRunTrigger) SetStartTimeAsTime 

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

type WorkflowStatus 

type WorkflowStatus string
const (
	WorkflowStatusAborted      WorkflowStatus = "Aborted"
	WorkflowStatusCancelled    WorkflowStatus = "Cancelled"
	WorkflowStatusFailed       WorkflowStatus = "Failed"
	WorkflowStatusFaulted      WorkflowStatus = "Faulted"
	WorkflowStatusIgnored      WorkflowStatus = "Ignored"
	WorkflowStatusNotSpecified WorkflowStatus = "NotSpecified"
	WorkflowStatusPaused       WorkflowStatus = "Paused"
	WorkflowStatusRunning      WorkflowStatus = "Running"
	WorkflowStatusSkipped      WorkflowStatus = "Skipped"
	WorkflowStatusSucceeded    WorkflowStatus = "Succeeded"
	WorkflowStatusSuspended    WorkflowStatus = "Suspended"
	WorkflowStatusTimedOut     WorkflowStatus = "TimedOut"
	WorkflowStatusWaiting      WorkflowStatus = "Waiting"
)

func (*WorkflowStatus) UnmarshalJSON added in v0.20230712.1163130 

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

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.