pipelineruns

package
v0.20230809.1073815 Latest Latest
Warning

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

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

README

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

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

Client Initialization

client := pipelineruns.NewPipelineRunsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: PipelineRunsClient.Cancel

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

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

Example Usage: PipelineRunsClient.Get

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

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: PipelineRunsClient.QueryByFactory

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

payload := pipelineruns.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
}

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 ValidateFactoryID 

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

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

func ValidatePipelineRunID 

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

ValidatePipelineRunID checks that 'input' can be parsed as a Pipeline Run ID

Types

type CancelOperationOptions 

type CancelOperationOptions struct {
	IsRecursive *bool
}

func DefaultCancelOperationOptions 

func DefaultCancelOperationOptions() CancelOperationOptions

func (CancelOperationOptions) ToHeaders added in v0.20230516.1215417 

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

func (CancelOperationOptions) ToOData added in v0.20230516.1215417 

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

func (CancelOperationOptions) ToQuery added in v0.20230516.1215417 

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

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

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

type PipelineRun 

type PipelineRun struct {
	DurationInMs  *int64                `json:"durationInMs,omitempty"`
	InvokedBy     *PipelineRunInvokedBy `json:"invokedBy,omitempty"`
	IsLatest      *bool                 `json:"isLatest,omitempty"`
	LastUpdated   *string               `json:"lastUpdated,omitempty"`
	Message       *string               `json:"message,omitempty"`
	Parameters    *map[string]string    `json:"parameters,omitempty"`
	PipelineName  *string               `json:"pipelineName,omitempty"`
	RunDimensions *map[string]string    `json:"runDimensions,omitempty"`
	RunEnd        *string               `json:"runEnd,omitempty"`
	RunGroupId    *string               `json:"runGroupId,omitempty"`
	RunId         *string               `json:"runId,omitempty"`
	RunStart      *string               `json:"runStart,omitempty"`
	Status        *string               `json:"status,omitempty"`
}

func (*PipelineRun) GetLastUpdatedAsTime 

func (o *PipelineRun) GetLastUpdatedAsTime() (*time.Time, error)

func (*PipelineRun) GetRunEndAsTime 

func (o *PipelineRun) GetRunEndAsTime() (*time.Time, error)

func (*PipelineRun) GetRunStartAsTime 

func (o *PipelineRun) GetRunStartAsTime() (*time.Time, error)

func (*PipelineRun) SetLastUpdatedAsTime 

func (o *PipelineRun) SetLastUpdatedAsTime(input time.Time)

func (*PipelineRun) SetRunEndAsTime 

func (o *PipelineRun) SetRunEndAsTime(input time.Time)

func (*PipelineRun) SetRunStartAsTime 

func (o *PipelineRun) SetRunStartAsTime(input time.Time)

type PipelineRunId 

type PipelineRunId struct {
	SubscriptionId    string
	ResourceGroupName string
	FactoryName       string
	RunId             string
}

PipelineRunId is a struct representing the Resource ID for a Pipeline Run

func NewPipelineRunID 

func NewPipelineRunID(subscriptionId string, resourceGroupName string, factoryName string, runId string) PipelineRunId

NewPipelineRunID returns a new PipelineRunId struct

func ParsePipelineRunID 

func ParsePipelineRunID(input string) (*PipelineRunId, error)

ParsePipelineRunID parses 'input' into a PipelineRunId

func ParsePipelineRunIDInsensitively 

func ParsePipelineRunIDInsensitively(input string) (*PipelineRunId, error)

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

func (PipelineRunId) ID 

func (id PipelineRunId) ID() string

ID returns the formatted Pipeline Run ID

func (PipelineRunId) Segments 

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

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

func (PipelineRunId) String 

func (id PipelineRunId) String() string

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

type PipelineRunInvokedBy 

type PipelineRunInvokedBy struct {
	Id            *string `json:"id,omitempty"`
	InvokedByType *string `json:"invokedByType,omitempty"`
	Name          *string `json:"name,omitempty"`
	PipelineName  *string `json:"pipelineName,omitempty"`
	PipelineRunId *string `json:"pipelineRunId,omitempty"`
}

type PipelineRunsClient 

type PipelineRunsClient struct {
	Client *resourcemanager.Client
}

func NewPipelineRunsClientWithBaseURI 

func NewPipelineRunsClientWithBaseURI(sdkApi sdkEnv.Api) (*PipelineRunsClient, error)

func (PipelineRunsClient) Cancel 

func (c PipelineRunsClient) Cancel(ctx context.Context, id PipelineRunId, options CancelOperationOptions) (result CancelOperationResponse, err error)

Cancel ...

func (PipelineRunsClient) Get 

func (c PipelineRunsClient) Get(ctx context.Context, id PipelineRunId) (result GetOperationResponse, err error)

Get ...

func (PipelineRunsClient) QueryByFactory 

func (c PipelineRunsClient) QueryByFactory(ctx context.Context, id FactoryId, input RunFilterParameters) (result QueryByFactoryOperationResponse, err error)

QueryByFactory ...

type PipelineRunsQueryResponse 

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

type QueryByFactoryOperationResponse 

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

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

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.