triggerruns

package
v0.20240118.1113719 Latest Latest
Warning

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

Go to latest
Published: Jan 18, 2024 License: MPL-2.0 Imports: 12 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/datafactory/2018-06-01/triggerruns Documentation

The triggerruns SDK allows for interaction with the Azure Resource Manager Service datafactory (API Version 2018-06-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/datafactory/2018-06-01/triggerruns"

Client Initialization

client := triggerruns.NewTriggerrunsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: TriggerrunsClient.Cancel

ctx := context.TODO()
id := triggerruns.NewTriggerRunID("12345678-1234-9876-4563-123456789012", "example-resource-group", "factoryValue", "triggerValue", "runIdValue")

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

Example Usage: TriggerrunsClient.QueryByFactory

ctx := context.TODO()
id := triggerruns.NewFactoryID("12345678-1234-9876-4563-123456789012", "example-resource-group", "factoryValue")

payload := triggerruns.RunFilterParameters{
	// ...
}


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

Example Usage: TriggerrunsClient.Rerun

ctx := context.TODO()
id := triggerruns.NewTriggerRunID("12345678-1234-9876-4563-123456789012", "example-resource-group", "factoryValue", "triggerValue", "runIdValue")

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

func PossibleValuesForRunQueryFilterOperand() []string

func PossibleValuesForRunQueryFilterOperator

func PossibleValuesForRunQueryFilterOperator() []string

func PossibleValuesForRunQueryOrder

func PossibleValuesForRunQueryOrder() []string

func PossibleValuesForRunQueryOrderByField

func PossibleValuesForRunQueryOrderByField() []string

func PossibleValuesForTriggerRunStatus

func PossibleValuesForTriggerRunStatus() []string

func ValidateFactoryID

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

ValidateFactoryID checks that 'input' can be parsed as a Factory ID

func ValidateTriggerRunID

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

ValidateTriggerRunID checks that 'input' can be parsed as a Trigger Run ID

Types

type CancelOperationResponse

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

type FactoryId

type FactoryId struct {
	SubscriptionId    string
	ResourceGroupName string
	FactoryName       string
}

FactoryId is a struct representing the Resource ID for a Factory

func NewFactoryID

func NewFactoryID(subscriptionId string, resourceGroupName string, factoryName string) FactoryId

NewFactoryID returns a new FactoryId struct

func ParseFactoryID

func ParseFactoryID(input string) (*FactoryId, error)

ParseFactoryID parses 'input' into a FactoryId

func ParseFactoryIDInsensitively

func ParseFactoryIDInsensitively(input string) (*FactoryId, error)

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

func (*FactoryId) FromParseResult added in v0.20231127.1171502

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

func (FactoryId) ID

func (id FactoryId) ID() string

ID returns the formatted Factory ID

func (FactoryId) Segments

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

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

func (FactoryId) String

func (id FactoryId) String() string

String returns a human-readable description of this Factory ID

type QueryByFactoryOperationResponse

type QueryByFactoryOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *TriggerRunsQueryResponse
}

type RerunOperationResponse

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

type RunFilterParameters

type RunFilterParameters struct {
	ContinuationToken *string            `json:"continuationToken,omitempty"`
	Filters           *[]RunQueryFilter  `json:"filters,omitempty"`
	LastUpdatedAfter  string             `json:"lastUpdatedAfter"`
	LastUpdatedBefore string             `json:"lastUpdatedBefore"`
	OrderBy           *[]RunQueryOrderBy `json:"orderBy,omitempty"`
}

func (*RunFilterParameters) GetLastUpdatedAfterAsTime

func (o *RunFilterParameters) GetLastUpdatedAfterAsTime() (*time.Time, error)

func (*RunFilterParameters) GetLastUpdatedBeforeAsTime

func (o *RunFilterParameters) GetLastUpdatedBeforeAsTime() (*time.Time, error)

func (*RunFilterParameters) SetLastUpdatedAfterAsTime

func (o *RunFilterParameters) SetLastUpdatedAfterAsTime(input time.Time)

func (*RunFilterParameters) SetLastUpdatedBeforeAsTime

func (o *RunFilterParameters) SetLastUpdatedBeforeAsTime(input time.Time)

type RunQueryFilter

type RunQueryFilter struct {
	Operand  RunQueryFilterOperand  `json:"operand"`
	Operator RunQueryFilterOperator `json:"operator"`
	Values   []string               `json:"values"`
}

type RunQueryFilterOperand

type RunQueryFilterOperand string
const (
	RunQueryFilterOperandActivityName        RunQueryFilterOperand = "ActivityName"
	RunQueryFilterOperandActivityRunEnd      RunQueryFilterOperand = "ActivityRunEnd"
	RunQueryFilterOperandActivityRunStart    RunQueryFilterOperand = "ActivityRunStart"
	RunQueryFilterOperandActivityType        RunQueryFilterOperand = "ActivityType"
	RunQueryFilterOperandLatestOnly          RunQueryFilterOperand = "LatestOnly"
	RunQueryFilterOperandPipelineName        RunQueryFilterOperand = "PipelineName"
	RunQueryFilterOperandRunEnd              RunQueryFilterOperand = "RunEnd"
	RunQueryFilterOperandRunGroupId          RunQueryFilterOperand = "RunGroupId"
	RunQueryFilterOperandRunStart            RunQueryFilterOperand = "RunStart"
	RunQueryFilterOperandStatus              RunQueryFilterOperand = "Status"
	RunQueryFilterOperandTriggerName         RunQueryFilterOperand = "TriggerName"
	RunQueryFilterOperandTriggerRunTimestamp RunQueryFilterOperand = "TriggerRunTimestamp"
)

func (*RunQueryFilterOperand) UnmarshalJSON added in v0.20230516.1215417

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

type RunQueryFilterOperator

type RunQueryFilterOperator string
const (
	RunQueryFilterOperatorEquals    RunQueryFilterOperator = "Equals"
	RunQueryFilterOperatorIn        RunQueryFilterOperator = "In"
	RunQueryFilterOperatorNotEquals RunQueryFilterOperator = "NotEquals"
	RunQueryFilterOperatorNotIn     RunQueryFilterOperator = "NotIn"
)

func (*RunQueryFilterOperator) UnmarshalJSON added in v0.20230516.1215417

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

type RunQueryOrder

type RunQueryOrder string
const (
	RunQueryOrderASC  RunQueryOrder = "ASC"
	RunQueryOrderDESC RunQueryOrder = "DESC"
)

func (*RunQueryOrder) UnmarshalJSON added in v0.20230516.1215417

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

type RunQueryOrderBy

type RunQueryOrderBy struct {
	Order   RunQueryOrder        `json:"order"`
	OrderBy RunQueryOrderByField `json:"orderBy"`
}

type RunQueryOrderByField

type RunQueryOrderByField string
const (
	RunQueryOrderByFieldActivityName        RunQueryOrderByField = "ActivityName"
	RunQueryOrderByFieldActivityRunEnd      RunQueryOrderByField = "ActivityRunEnd"
	RunQueryOrderByFieldActivityRunStart    RunQueryOrderByField = "ActivityRunStart"
	RunQueryOrderByFieldPipelineName        RunQueryOrderByField = "PipelineName"
	RunQueryOrderByFieldRunEnd              RunQueryOrderByField = "RunEnd"
	RunQueryOrderByFieldRunStart            RunQueryOrderByField = "RunStart"
	RunQueryOrderByFieldStatus              RunQueryOrderByField = "Status"
	RunQueryOrderByFieldTriggerName         RunQueryOrderByField = "TriggerName"
	RunQueryOrderByFieldTriggerRunTimestamp RunQueryOrderByField = "TriggerRunTimestamp"
)

func (*RunQueryOrderByField) UnmarshalJSON added in v0.20230516.1215417

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

type TriggerRun

type TriggerRun struct {
	DependencyStatus    *map[string]interface{} `json:"dependencyStatus,omitempty"`
	Message             *string                 `json:"message,omitempty"`
	Properties          *map[string]string      `json:"properties,omitempty"`
	RunDimension        *map[string]string      `json:"runDimension,omitempty"`
	Status              *TriggerRunStatus       `json:"status,omitempty"`
	TriggerName         *string                 `json:"triggerName,omitempty"`
	TriggerRunId        *string                 `json:"triggerRunId,omitempty"`
	TriggerRunTimestamp *string                 `json:"triggerRunTimestamp,omitempty"`
	TriggerType         *string                 `json:"triggerType,omitempty"`
	TriggeredPipelines  *map[string]string      `json:"triggeredPipelines,omitempty"`
}

func (*TriggerRun) GetTriggerRunTimestampAsTime

func (o *TriggerRun) GetTriggerRunTimestampAsTime() (*time.Time, error)

func (*TriggerRun) SetTriggerRunTimestampAsTime

func (o *TriggerRun) SetTriggerRunTimestampAsTime(input time.Time)

type TriggerRunId

type TriggerRunId struct {
	SubscriptionId    string
	ResourceGroupName string
	FactoryName       string
	TriggerName       string
	RunId             string
}

TriggerRunId is a struct representing the Resource ID for a Trigger Run

func NewTriggerRunID

func NewTriggerRunID(subscriptionId string, resourceGroupName string, factoryName string, triggerName string, runId string) TriggerRunId

NewTriggerRunID returns a new TriggerRunId struct

func ParseTriggerRunID

func ParseTriggerRunID(input string) (*TriggerRunId, error)

ParseTriggerRunID parses 'input' into a TriggerRunId

func ParseTriggerRunIDInsensitively

func ParseTriggerRunIDInsensitively(input string) (*TriggerRunId, error)

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

func (*TriggerRunId) FromParseResult added in v0.20231127.1171502

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

func (TriggerRunId) ID

func (id TriggerRunId) ID() string

ID returns the formatted Trigger Run ID

func (TriggerRunId) Segments

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

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

func (TriggerRunId) String

func (id TriggerRunId) String() string

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

type TriggerRunStatus

type TriggerRunStatus string
const (
	TriggerRunStatusFailed     TriggerRunStatus = "Failed"
	TriggerRunStatusInprogress TriggerRunStatus = "Inprogress"
	TriggerRunStatusSucceeded  TriggerRunStatus = "Succeeded"
)

func (*TriggerRunStatus) UnmarshalJSON added in v0.20230516.1215417

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

type TriggerRunsQueryResponse

type TriggerRunsQueryResponse struct {
	ContinuationToken *string      `json:"continuationToken,omitempty"`
	Value             []TriggerRun `json:"value"`
}

type TriggerrunsClient

type TriggerrunsClient struct {
	Client *resourcemanager.Client
}

func NewTriggerrunsClientWithBaseURI

func NewTriggerrunsClientWithBaseURI(sdkApi sdkEnv.Api) (*TriggerrunsClient, error)

func (TriggerrunsClient) Cancel

Cancel ...

func (TriggerrunsClient) QueryByFactory

QueryByFactory ...

func (TriggerrunsClient) Rerun

Rerun ...

Jump to

Keyboard shortcuts

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