workflowtriggers

package
v0.20240903.1131440 Latest Latest
Warning

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

 Go to latest Published: Sep 3, 2024 License: MPL-2.0 Imports: 14 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/web/2023-12-01/workflowtriggers Documentation

The workflowtriggers SDK allows for interaction with the Azure Resource Manager Service web (API Version 2023-12-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/web/2023-12-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", "siteValue", "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", "siteValue", "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.NewManagementWorkflowID("12345678-1234-9876-4563-123456789012", "example-resource-group", "siteValue", "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", "siteValue", "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.Run

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

if err := client.RunThenPoll(ctx, id); err != nil {
	// handle the error
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForDayOfWeek 

func PossibleValuesForDayOfWeek() []string

func PossibleValuesForDaysOfWeek 

func PossibleValuesForDaysOfWeek() []string

func PossibleValuesForRecurrenceFrequency 

func PossibleValuesForRecurrenceFrequency() []string

func PossibleValuesForWorkflowState 

func PossibleValuesForWorkflowState() []string

func PossibleValuesForWorkflowStatus 

func PossibleValuesForWorkflowStatus() []string

func PossibleValuesForWorkflowTriggerProvisioningState 

func PossibleValuesForWorkflowTriggerProvisioningState() []string

func ValidateManagementWorkflowID 

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

ValidateManagementWorkflowID checks that 'input' can be parsed as a Management Workflow 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 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"
)

func (*DayOfWeek) UnmarshalJSON 

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

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

func (*DaysOfWeek) UnmarshalJSON 

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

type GetOperationResponse 

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

type GetSchemaJsonOperationResponse 

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

type JsonSchema 

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

type ListCallbackUrlOperationResponse 

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

type ListCompleteResult 

type ListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []WorkflowTrigger
}

type ListCustomPager added in v0.20240628.1153531 

type ListCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ListCustomPager) NextPageLink() *odata.Link

type ListOperationOptions 

type ListOperationOptions struct {
	Filter *string
	Top    *int64
}

func DefaultListOperationOptions 

func DefaultListOperationOptions() ListOperationOptions

func (ListOperationOptions) ToHeaders 

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

func (ListOperationOptions) ToOData 

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

func (ListOperationOptions) ToQuery 

func (o ListOperationOptions) ToQuery() *client.QueryParams

type ListOperationResponse 

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

type ManagementWorkflowId 

type ManagementWorkflowId struct {
	SubscriptionId    string
	ResourceGroupName string
	SiteName          string
	WorkflowName      string
}

ManagementWorkflowId is a struct representing the Resource ID for a Management Workflow

func NewManagementWorkflowID 

func NewManagementWorkflowID(subscriptionId string, resourceGroupName string, siteName string, workflowName string) ManagementWorkflowId

NewManagementWorkflowID returns a new ManagementWorkflowId struct

func ParseManagementWorkflowID 

func ParseManagementWorkflowID(input string) (*ManagementWorkflowId, error)

ParseManagementWorkflowID parses 'input' into a ManagementWorkflowId

func ParseManagementWorkflowIDInsensitively 

func ParseManagementWorkflowIDInsensitively(input string) (*ManagementWorkflowId, error)

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

func (*ManagementWorkflowId) FromParseResult 

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

func (ManagementWorkflowId) ID 

func (id ManagementWorkflowId) ID() string

ID returns the formatted Management Workflow ID

func (ManagementWorkflowId) Segments 

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

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

func (ManagementWorkflowId) String 

func (id ManagementWorkflowId) String() string

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

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

func (*RecurrenceFrequency) UnmarshalJSON 

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

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 ResourceReference 

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

type RunOperationResponse 

type RunOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type TriggerId 

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

TriggerId is a struct representing the Resource ID for a Trigger

func NewTriggerID 

func NewTriggerID(subscriptionId string, resourceGroupName string, siteName 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) FromParseResult 

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

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 WorkflowState 

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

func (*WorkflowState) UnmarshalJSON 

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

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 

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

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 

func (p WorkflowTriggerOperationPredicate) Matches(input WorkflowTrigger) bool

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

func (*WorkflowTriggerProvisioningState) UnmarshalJSON 

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

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 WorkflowTriggersClient 

type WorkflowTriggersClient struct {
	Client *resourcemanager.Client
}

func NewWorkflowTriggersClientWithBaseURI 

func NewWorkflowTriggersClientWithBaseURI(sdkApi sdkEnv.Api) (*WorkflowTriggersClient, error)

func (WorkflowTriggersClient) Get 

func (c WorkflowTriggersClient) Get(ctx context.Context, id TriggerId) (result GetOperationResponse, err error)

Get ...

func (WorkflowTriggersClient) GetSchemaJson 

func (c WorkflowTriggersClient) GetSchemaJson(ctx context.Context, id TriggerId) (result GetSchemaJsonOperationResponse, err error)

GetSchemaJson ...

func (WorkflowTriggersClient) List 

func (c WorkflowTriggersClient) List(ctx context.Context, id ManagementWorkflowId, options ListOperationOptions) (result ListOperationResponse, err error)

List ...

func (WorkflowTriggersClient) ListCallbackUrl 

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

ListCallbackUrl ...

func (WorkflowTriggersClient) ListComplete 

func (c WorkflowTriggersClient) ListComplete(ctx context.Context, id ManagementWorkflowId, options ListOperationOptions) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (WorkflowTriggersClient) ListCompleteMatchingPredicate 

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

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (WorkflowTriggersClient) Run 

func (c WorkflowTriggersClient) Run(ctx context.Context, id TriggerId) (result RunOperationResponse, err error)

Run ...

func (WorkflowTriggersClient) RunThenPoll 

func (c WorkflowTriggersClient) RunThenPoll(ctx context.Context, id TriggerId) error

RunThenPoll performs Run then polls until it's completed

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.