workflowtriggers

package
v0.20230408.1052134 Latest Latest
Warning

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

Go to latest
Published: Apr 8, 2023 License: MPL-2.0 Imports: 10 Imported by: 1

README

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

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

Client Initialization

client := workflowtriggers.NewWorkflowTriggersClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: WorkflowTriggersClient.Get

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

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: WorkflowTriggersClient.GetSchemaJson

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

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

Example Usage: WorkflowTriggersClient.List

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

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

Example Usage: WorkflowTriggersClient.ListCallbackUrl

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

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

Example Usage: WorkflowTriggersClient.Reset

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

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

Example Usage: WorkflowTriggersClient.Run

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

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

Example Usage: WorkflowTriggersClient.SetState

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

payload := workflowtriggers.SetTriggerStateActionDefinition{
	// ...
}


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

Example Usage: WorkflowTriggersClient.WorkflowVersionTriggersListCallbackUrl

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

payload := workflowtriggers.GetCallbackUrlParameters{
	// ...
}


read, err := client.WorkflowVersionTriggersListCallbackUrl(ctx, id, payload)
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 PossibleValuesForDayOfWeek

func PossibleValuesForDayOfWeek() []string

func PossibleValuesForDaysOfWeek

func PossibleValuesForDaysOfWeek() []string

func PossibleValuesForKeyType

func PossibleValuesForKeyType() []string

func PossibleValuesForRecurrenceFrequency

func PossibleValuesForRecurrenceFrequency() []string

func PossibleValuesForWorkflowState

func PossibleValuesForWorkflowState() []string

func PossibleValuesForWorkflowStatus

func PossibleValuesForWorkflowStatus() []string

func PossibleValuesForWorkflowTriggerProvisioningState

func PossibleValuesForWorkflowTriggerProvisioningState() []string

func ValidateTriggerID

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

ValidateTriggerID checks that 'input' can be parsed as a Trigger ID

func ValidateVersionTriggerID

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

ValidateVersionTriggerID checks that 'input' can be parsed as a Version Trigger 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 DayOfWeek

type DayOfWeek string
const (
	DayOfWeekFriday    DayOfWeek = "Friday"
	DayOfWeekMonday    DayOfWeek = "Monday"
	DayOfWeekSaturday  DayOfWeek = "Saturday"
	DayOfWeekSunday    DayOfWeek = "Sunday"
	DayOfWeekThursday  DayOfWeek = "Thursday"
	DayOfWeekTuesday   DayOfWeek = "Tuesday"
	DayOfWeekWednesday DayOfWeek = "Wednesday"
)

type DaysOfWeek

type DaysOfWeek string
const (
	DaysOfWeekFriday    DaysOfWeek = "Friday"
	DaysOfWeekMonday    DaysOfWeek = "Monday"
	DaysOfWeekSaturday  DaysOfWeek = "Saturday"
	DaysOfWeekSunday    DaysOfWeek = "Sunday"
	DaysOfWeekThursday  DaysOfWeek = "Thursday"
	DaysOfWeekTuesday   DaysOfWeek = "Tuesday"
	DaysOfWeekWednesday DaysOfWeek = "Wednesday"
)

type GetCallbackUrlParameters

type GetCallbackUrlParameters struct {
	KeyType  *KeyType `json:"keyType,omitempty"`
	NotAfter *string  `json:"notAfter,omitempty"`
}

func (*GetCallbackUrlParameters) GetNotAfterAsTime

func (o *GetCallbackUrlParameters) GetNotAfterAsTime() (*time.Time, error)

func (*GetCallbackUrlParameters) SetNotAfterAsTime

func (o *GetCallbackUrlParameters) SetNotAfterAsTime(input time.Time)

type GetOperationResponse

type GetOperationResponse struct {
	HttpResponse *http.Response
	Model        *WorkflowTrigger
}

type GetSchemaJsonOperationResponse

type GetSchemaJsonOperationResponse struct {
	HttpResponse *http.Response
	Model        *JsonSchema
}

type JsonSchema

type JsonSchema struct {
	Content *string `json:"content,omitempty"`
	Title   *string `json:"title,omitempty"`
}

type KeyType

type KeyType string
const (
	KeyTypeNotSpecified KeyType = "NotSpecified"
	KeyTypePrimary      KeyType = "Primary"
	KeyTypeSecondary    KeyType = "Secondary"
)

type ListCallbackUrlOperationResponse

type ListCallbackUrlOperationResponse struct {
	HttpResponse *http.Response
	Model        *WorkflowTriggerCallbackUrl
}

type ListCompleteResult

type ListCompleteResult struct {
	Items []WorkflowTrigger
}

type ListOperationOptions

type ListOperationOptions struct {
	Filter *string
	Top    *int64
}

func DefaultListOperationOptions

func DefaultListOperationOptions() ListOperationOptions

type ListOperationResponse

type ListOperationResponse struct {
	HttpResponse *http.Response
	Model        *[]WorkflowTrigger
	// contains filtered or unexported fields
}

func (ListOperationResponse) HasMore

func (r ListOperationResponse) HasMore() bool

func (ListOperationResponse) LoadMore

func (r ListOperationResponse) LoadMore(ctx context.Context) (resp ListOperationResponse, err error)

type RecurrenceFrequency

type RecurrenceFrequency string
const (
	RecurrenceFrequencyDay          RecurrenceFrequency = "Day"
	RecurrenceFrequencyHour         RecurrenceFrequency = "Hour"
	RecurrenceFrequencyMinute       RecurrenceFrequency = "Minute"
	RecurrenceFrequencyMonth        RecurrenceFrequency = "Month"
	RecurrenceFrequencyNotSpecified RecurrenceFrequency = "NotSpecified"
	RecurrenceFrequencySecond       RecurrenceFrequency = "Second"
	RecurrenceFrequencyWeek         RecurrenceFrequency = "Week"
	RecurrenceFrequencyYear         RecurrenceFrequency = "Year"
)

type RecurrenceSchedule

type RecurrenceSchedule struct {
	Hours              *[]int64                        `json:"hours,omitempty"`
	Minutes            *[]int64                        `json:"minutes,omitempty"`
	MonthDays          *[]int64                        `json:"monthDays,omitempty"`
	MonthlyOccurrences *[]RecurrenceScheduleOccurrence `json:"monthlyOccurrences,omitempty"`
	WeekDays           *[]DaysOfWeek                   `json:"weekDays,omitempty"`
}

type RecurrenceScheduleOccurrence

type RecurrenceScheduleOccurrence struct {
	Day        *DayOfWeek `json:"day,omitempty"`
	Occurrence *int64     `json:"occurrence,omitempty"`
}

type ResetOperationResponse

type ResetOperationResponse struct {
	HttpResponse *http.Response
}

type ResourceReference

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

type RunOperationResponse

type RunOperationResponse struct {
	HttpResponse *http.Response
}

type SetStateOperationResponse

type SetStateOperationResponse struct {
	HttpResponse *http.Response
}

type SetTriggerStateActionDefinition

type SetTriggerStateActionDefinition struct {
	Source WorkflowTriggerReference `json:"source"`
}

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 VersionTriggerId

type VersionTriggerId struct {
	SubscriptionId    string
	ResourceGroupName string
	WorkflowName      string
	VersionId         string
	TriggerName       string
}

VersionTriggerId is a struct representing the Resource ID for a Version Trigger

func NewVersionTriggerID

func NewVersionTriggerID(subscriptionId string, resourceGroupName string, workflowName string, versionId string, triggerName string) VersionTriggerId

NewVersionTriggerID returns a new VersionTriggerId struct

func ParseVersionTriggerID

func ParseVersionTriggerID(input string) (*VersionTriggerId, error)

ParseVersionTriggerID parses 'input' into a VersionTriggerId

func ParseVersionTriggerIDInsensitively

func ParseVersionTriggerIDInsensitively(input string) (*VersionTriggerId, error)

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

func (VersionTriggerId) ID

func (id VersionTriggerId) ID() string

ID returns the formatted Version Trigger ID

func (VersionTriggerId) Segments

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

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

func (VersionTriggerId) String

func (id VersionTriggerId) String() string

String returns a human-readable description of this Version Trigger ID

type WorkflowId

type WorkflowId struct {
	SubscriptionId    string
	ResourceGroupName string
	WorkflowName      string
}

WorkflowId is a struct representing the Resource ID for a Workflow

func NewWorkflowID

func NewWorkflowID(subscriptionId string, resourceGroupName string, workflowName 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) 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 WorkflowState

type WorkflowState string
const (
	WorkflowStateCompleted    WorkflowState = "Completed"
	WorkflowStateDeleted      WorkflowState = "Deleted"
	WorkflowStateDisabled     WorkflowState = "Disabled"
	WorkflowStateEnabled      WorkflowState = "Enabled"
	WorkflowStateNotSpecified WorkflowState = "NotSpecified"
	WorkflowStateSuspended    WorkflowState = "Suspended"
)

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"
)

type WorkflowTrigger

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

type WorkflowTriggerCallbackUrl

type WorkflowTriggerCallbackUrl struct {
	BasePath               *string                                `json:"basePath,omitempty"`
	Method                 *string                                `json:"method,omitempty"`
	Queries                *WorkflowTriggerListCallbackUrlQueries `json:"queries,omitempty"`
	RelativePath           *string                                `json:"relativePath,omitempty"`
	RelativePathParameters *[]string                              `json:"relativePathParameters,omitempty"`
	Value                  *string                                `json:"value,omitempty"`
}

type WorkflowTriggerListCallbackUrlQueries

type WorkflowTriggerListCallbackUrlQueries struct {
	ApiVersion *string `json:"api-version,omitempty"`
	Se         *string `json:"se,omitempty"`
	Sig        *string `json:"sig,omitempty"`
	Sp         *string `json:"sp,omitempty"`
	Sv         *string `json:"sv,omitempty"`
}

type WorkflowTriggerOperationPredicate

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

func (WorkflowTriggerOperationPredicate) Matches

type WorkflowTriggerProperties

type WorkflowTriggerProperties struct {
	ChangedTime       *string                           `json:"changedTime,omitempty"`
	CreatedTime       *string                           `json:"createdTime,omitempty"`
	LastExecutionTime *string                           `json:"lastExecutionTime,omitempty"`
	NextExecutionTime *string                           `json:"nextExecutionTime,omitempty"`
	ProvisioningState *WorkflowTriggerProvisioningState `json:"provisioningState,omitempty"`
	Recurrence        *WorkflowTriggerRecurrence        `json:"recurrence,omitempty"`
	State             *WorkflowState                    `json:"state,omitempty"`
	Status            *WorkflowStatus                   `json:"status,omitempty"`
	Workflow          *ResourceReference                `json:"workflow,omitempty"`
}

func (*WorkflowTriggerProperties) GetChangedTimeAsTime

func (o *WorkflowTriggerProperties) GetChangedTimeAsTime() (*time.Time, error)

func (*WorkflowTriggerProperties) GetCreatedTimeAsTime

func (o *WorkflowTriggerProperties) GetCreatedTimeAsTime() (*time.Time, error)

func (*WorkflowTriggerProperties) GetLastExecutionTimeAsTime

func (o *WorkflowTriggerProperties) GetLastExecutionTimeAsTime() (*time.Time, error)

func (*WorkflowTriggerProperties) GetNextExecutionTimeAsTime

func (o *WorkflowTriggerProperties) GetNextExecutionTimeAsTime() (*time.Time, error)

func (*WorkflowTriggerProperties) SetChangedTimeAsTime

func (o *WorkflowTriggerProperties) SetChangedTimeAsTime(input time.Time)

func (*WorkflowTriggerProperties) SetCreatedTimeAsTime

func (o *WorkflowTriggerProperties) SetCreatedTimeAsTime(input time.Time)

func (*WorkflowTriggerProperties) SetLastExecutionTimeAsTime

func (o *WorkflowTriggerProperties) SetLastExecutionTimeAsTime(input time.Time)

func (*WorkflowTriggerProperties) SetNextExecutionTimeAsTime

func (o *WorkflowTriggerProperties) SetNextExecutionTimeAsTime(input time.Time)

type WorkflowTriggerProvisioningState

type WorkflowTriggerProvisioningState string
const (
	WorkflowTriggerProvisioningStateAccepted      WorkflowTriggerProvisioningState = "Accepted"
	WorkflowTriggerProvisioningStateCanceled      WorkflowTriggerProvisioningState = "Canceled"
	WorkflowTriggerProvisioningStateCompleted     WorkflowTriggerProvisioningState = "Completed"
	WorkflowTriggerProvisioningStateCreated       WorkflowTriggerProvisioningState = "Created"
	WorkflowTriggerProvisioningStateCreating      WorkflowTriggerProvisioningState = "Creating"
	WorkflowTriggerProvisioningStateDeleted       WorkflowTriggerProvisioningState = "Deleted"
	WorkflowTriggerProvisioningStateDeleting      WorkflowTriggerProvisioningState = "Deleting"
	WorkflowTriggerProvisioningStateFailed        WorkflowTriggerProvisioningState = "Failed"
	WorkflowTriggerProvisioningStateMoving        WorkflowTriggerProvisioningState = "Moving"
	WorkflowTriggerProvisioningStateNotSpecified  WorkflowTriggerProvisioningState = "NotSpecified"
	WorkflowTriggerProvisioningStateReady         WorkflowTriggerProvisioningState = "Ready"
	WorkflowTriggerProvisioningStateRegistered    WorkflowTriggerProvisioningState = "Registered"
	WorkflowTriggerProvisioningStateRegistering   WorkflowTriggerProvisioningState = "Registering"
	WorkflowTriggerProvisioningStateRunning       WorkflowTriggerProvisioningState = "Running"
	WorkflowTriggerProvisioningStateSucceeded     WorkflowTriggerProvisioningState = "Succeeded"
	WorkflowTriggerProvisioningStateUnregistered  WorkflowTriggerProvisioningState = "Unregistered"
	WorkflowTriggerProvisioningStateUnregistering WorkflowTriggerProvisioningState = "Unregistering"
	WorkflowTriggerProvisioningStateUpdating      WorkflowTriggerProvisioningState = "Updating"
)

type WorkflowTriggerRecurrence

type WorkflowTriggerRecurrence struct {
	EndTime   *string              `json:"endTime,omitempty"`
	Frequency *RecurrenceFrequency `json:"frequency,omitempty"`
	Interval  *int64               `json:"interval,omitempty"`
	Schedule  *RecurrenceSchedule  `json:"schedule,omitempty"`
	StartTime *string              `json:"startTime,omitempty"`
	TimeZone  *string              `json:"timeZone,omitempty"`
}

type WorkflowTriggerReference

type WorkflowTriggerReference struct {
	FlowName    *string `json:"flowName,omitempty"`
	Id          *string `json:"id,omitempty"`
	Name        *string `json:"name,omitempty"`
	TriggerName *string `json:"triggerName,omitempty"`
	Type        *string `json:"type,omitempty"`
}

type WorkflowTriggersClient

type WorkflowTriggersClient struct {
	Client autorest.Client
	// contains filtered or unexported fields
}

func NewWorkflowTriggersClientWithBaseURI

func NewWorkflowTriggersClientWithBaseURI(endpoint string) WorkflowTriggersClient

func (WorkflowTriggersClient) Get

Get ...

func (WorkflowTriggersClient) GetSchemaJson

GetSchemaJson ...

func (WorkflowTriggersClient) List

List ...

func (WorkflowTriggersClient) ListCallbackUrl

func (c WorkflowTriggersClient) ListCallbackUrl(ctx context.Context, id TriggerId) (result ListCallbackUrlOperationResponse, err error)

ListCallbackUrl ...

func (WorkflowTriggersClient) ListComplete

ListComplete retrieves all of the results into a single object

func (WorkflowTriggersClient) ListCompleteMatchingPredicate

func (c WorkflowTriggersClient) ListCompleteMatchingPredicate(ctx context.Context, id WorkflowId, options ListOperationOptions, predicate WorkflowTriggerOperationPredicate) (resp ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all of the results and then applied the predicate

func (WorkflowTriggersClient) Reset

Reset ...

func (WorkflowTriggersClient) Run

Run ...

func (WorkflowTriggersClient) SetState

SetState ...

func (WorkflowTriggersClient) WorkflowVersionTriggersListCallbackUrl

WorkflowVersionTriggersListCallbackUrl ...

type WorkflowVersionTriggersListCallbackUrlOperationResponse

type WorkflowVersionTriggersListCallbackUrlOperationResponse struct {
	HttpResponse *http.Response
	Model        *WorkflowTriggerCallbackUrl
}

Jump to

Keyboard shortcuts

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