workflowtriggerhistories

package
v0.20231116.1162710 Latest Latest
Warning

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

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

README

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

The workflowtriggerhistories 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/workflowtriggerhistories"

Client Initialization

client := workflowtriggerhistories.NewWorkflowTriggerHistoriesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: WorkflowTriggerHistoriesClient.Get

ctx := context.TODO()
id := workflowtriggerhistories.NewHistoryID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workflowValue", "triggerValue", "historyValue")

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
}

Example Usage: WorkflowTriggerHistoriesClient.List

ctx := context.TODO()
id := workflowtriggerhistories.NewTriggerID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workflowValue", "triggerValue")

// alternatively `client.List(ctx, id, workflowtriggerhistories.DefaultListOperationOptions())` can be used to do batched pagination
items, err := client.ListComplete(ctx, id, workflowtriggerhistories.DefaultListOperationOptions())
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: WorkflowTriggerHistoriesClient.Resubmit

ctx := context.TODO()
id := workflowtriggerhistories.NewHistoryID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workflowValue", "triggerValue", "historyValue")

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

func PossibleValuesForWorkflowStatus() []string

func ValidateHistoryID

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

ValidateHistoryID checks that 'input' can be parsed as a History ID

func ValidateTriggerID

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

ValidateTriggerID checks that 'input' can be parsed as a Trigger 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        *WorkflowTriggerHistory
}

type HistoryId

type HistoryId struct {
	SubscriptionId    string
	ResourceGroupName string
	WorkflowName      string
	TriggerName       string
	HistoryName       string
}

HistoryId is a struct representing the Resource ID for a History

func NewHistoryID

func NewHistoryID(subscriptionId string, resourceGroupName string, workflowName string, triggerName string, historyName string) HistoryId

NewHistoryID returns a new HistoryId struct

func ParseHistoryID

func ParseHistoryID(input string) (*HistoryId, error)

ParseHistoryID parses 'input' into a HistoryId

func ParseHistoryIDInsensitively

func ParseHistoryIDInsensitively(input string) (*HistoryId, error)

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

func (HistoryId) ID

func (id HistoryId) ID() string

ID returns the formatted History ID

func (HistoryId) Segments

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

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

func (HistoryId) String

func (id HistoryId) String() string

String returns a human-readable description of this History ID

type ListCompleteResult

type ListCompleteResult struct {
	Items []WorkflowTriggerHistory
}

type ListOperationOptions

type ListOperationOptions struct {
	Filter *string
	Top    *int64
}

func DefaultListOperationOptions

func DefaultListOperationOptions() ListOperationOptions

func (ListOperationOptions) ToHeaders added in v0.20230712.1163130

func (o ListOperationOptions) ToHeaders() *client.Headers

func (ListOperationOptions) ToOData added in v0.20230712.1163130

func (o ListOperationOptions) ToOData() *odata.Query

func (ListOperationOptions) ToQuery added in v0.20230712.1163130

type ListOperationResponse

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]WorkflowTriggerHistory
}

type ResourceReference

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

type ResubmitOperationResponse

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

type TriggerId

type TriggerId struct {
	SubscriptionId    string
	ResourceGroupName string
	WorkflowName      string
	TriggerName       string
}

TriggerId is a struct representing the Resource ID for a Trigger

func NewTriggerID

func NewTriggerID(subscriptionId string, resourceGroupName string, workflowName string, triggerName string) TriggerId

NewTriggerID returns a new TriggerId struct

func ParseTriggerID

func ParseTriggerID(input string) (*TriggerId, error)

ParseTriggerID parses 'input' into a TriggerId

func ParseTriggerIDInsensitively

func ParseTriggerIDInsensitively(input string) (*TriggerId, error)

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

func (TriggerId) ID

func (id TriggerId) ID() string

ID returns the formatted Trigger ID

func (TriggerId) Segments

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

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

func (TriggerId) String

func (id TriggerId) String() string

String returns a human-readable description of this Trigger ID

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

type WorkflowTriggerHistoriesClient

type WorkflowTriggerHistoriesClient struct {
	Client *resourcemanager.Client
}

func NewWorkflowTriggerHistoriesClientWithBaseURI

func NewWorkflowTriggerHistoriesClientWithBaseURI(sdkApi sdkEnv.Api) (*WorkflowTriggerHistoriesClient, error)

func (WorkflowTriggerHistoriesClient) Get

Get ...

func (WorkflowTriggerHistoriesClient) List

List ...

func (WorkflowTriggerHistoriesClient) ListComplete

ListComplete retrieves all the results into a single object

func (WorkflowTriggerHistoriesClient) ListCompleteMatchingPredicate

func (c WorkflowTriggerHistoriesClient) ListCompleteMatchingPredicate(ctx context.Context, id TriggerId, options ListOperationOptions, predicate WorkflowTriggerHistoryOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (WorkflowTriggerHistoriesClient) Resubmit

Resubmit ...

type WorkflowTriggerHistory

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

type WorkflowTriggerHistoryOperationPredicate

type WorkflowTriggerHistoryOperationPredicate struct {
	Id   *string
	Name *string
	Type *string
}

func (WorkflowTriggerHistoryOperationPredicate) Matches

type WorkflowTriggerHistoryProperties

type WorkflowTriggerHistoryProperties struct {
	Code          *string            `json:"code,omitempty"`
	Correlation   *Correlation       `json:"correlation,omitempty"`
	EndTime       *string            `json:"endTime,omitempty"`
	Error         *interface{}       `json:"error,omitempty"`
	Fired         *bool              `json:"fired,omitempty"`
	InputsLink    *ContentLink       `json:"inputsLink,omitempty"`
	OutputsLink   *ContentLink       `json:"outputsLink,omitempty"`
	Run           *ResourceReference `json:"run,omitempty"`
	ScheduledTime *string            `json:"scheduledTime,omitempty"`
	StartTime     *string            `json:"startTime,omitempty"`
	Status        *WorkflowStatus    `json:"status,omitempty"`
	TrackingId    *string            `json:"trackingId,omitempty"`
}

func (*WorkflowTriggerHistoryProperties) GetEndTimeAsTime

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

func (*WorkflowTriggerHistoryProperties) GetScheduledTimeAsTime

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

func (*WorkflowTriggerHistoryProperties) GetStartTimeAsTime

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

func (*WorkflowTriggerHistoryProperties) SetEndTimeAsTime

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

func (*WorkflowTriggerHistoryProperties) SetScheduledTimeAsTime

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

func (*WorkflowTriggerHistoryProperties) SetStartTimeAsTime

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL