activityruns

README

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

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

Client Initialization

client := activityruns.NewActivityrunsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ActivityrunsClient.QueryByPipelineRun

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

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


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

Documentation

Index

• func PossibleValuesForRunQueryFilterOperand() []string
• func PossibleValuesForRunQueryFilterOperator() []string
• func PossibleValuesForRunQueryOrder() []string
• func PossibleValuesForRunQueryOrderByField() []string
• func ValidatePipelineRunID(input interface{}, key string) (warnings []string, errors []error)
• type ActivityRun
  • func (o *ActivityRun) GetActivityRunEndAsTime() (*time.Time, error)
  • func (o *ActivityRun) GetActivityRunStartAsTime() (*time.Time, error)
  • func (o *ActivityRun) SetActivityRunEndAsTime(input time.Time)
  • func (o *ActivityRun) SetActivityRunStartAsTime(input time.Time)
• type ActivityRunsQueryResponse
• type ActivityrunsClient
  • func NewActivityrunsClientWithBaseURI(endpoint string) ActivityrunsClient
  • func (c ActivityrunsClient) QueryByPipelineRun(ctx context.Context, id PipelineRunId, input RunFilterParameters) (result QueryByPipelineRunOperationResponse, err error)
• type PipelineRunId
  • func NewPipelineRunID(subscriptionId string, resourceGroupName string, factoryName string, ...) PipelineRunId
  • func ParsePipelineRunID(input string) (*PipelineRunId, error)
  • func ParsePipelineRunIDInsensitively(input string) (*PipelineRunId, error)
  • func (id PipelineRunId) ID() string
  • func (id PipelineRunId) Segments() []resourceids.Segment
  • func (id PipelineRunId) String() string
• type QueryByPipelineRunOperationResponse
• type RunFilterParameters
  • func (o *RunFilterParameters) GetLastUpdatedAfterAsTime() (*time.Time, error)
  • func (o *RunFilterParameters) GetLastUpdatedBeforeAsTime() (*time.Time, error)
  • func (o *RunFilterParameters) SetLastUpdatedAfterAsTime(input time.Time)
  • func (o *RunFilterParameters) SetLastUpdatedBeforeAsTime(input time.Time)
• type RunQueryFilter
• type RunQueryFilterOperand
• type RunQueryFilterOperator
• type RunQueryOrder
• type RunQueryOrderBy
• type RunQueryOrderByField

Functions

func PossibleValuesForRunQueryFilterOperand

func PossibleValuesForRunQueryFilterOperand() []string

func PossibleValuesForRunQueryFilterOperator

func PossibleValuesForRunQueryFilterOperator() []string

func PossibleValuesForRunQueryOrder

func PossibleValuesForRunQueryOrder() []string

func PossibleValuesForRunQueryOrderByField

func PossibleValuesForRunQueryOrderByField() []string

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 ActivityRun

type ActivityRun struct {
	ActivityName      *string      `json:"activityName,omitempty"`
	ActivityRunEnd    *string      `json:"activityRunEnd,omitempty"`
	ActivityRunId     *string      `json:"activityRunId,omitempty"`
	ActivityRunStart  *string      `json:"activityRunStart,omitempty"`
	ActivityType      *string      `json:"activityType,omitempty"`
	DurationInMs      *int64       `json:"durationInMs,omitempty"`
	Error             *interface{} `json:"error,omitempty"`
	Input             *interface{} `json:"input,omitempty"`
	LinkedServiceName *string      `json:"linkedServiceName,omitempty"`
	Output            *interface{} `json:"output,omitempty"`
	PipelineName      *string      `json:"pipelineName,omitempty"`
	PipelineRunId     *string      `json:"pipelineRunId,omitempty"`
	Status            *string      `json:"status,omitempty"`
}

func (*ActivityRun) GetActivityRunEndAsTime

func (o *ActivityRun) GetActivityRunEndAsTime() (*time.Time, error)

func (*ActivityRun) GetActivityRunStartAsTime

func (o *ActivityRun) GetActivityRunStartAsTime() (*time.Time, error)

func (*ActivityRun) SetActivityRunEndAsTime

func (o *ActivityRun) SetActivityRunEndAsTime(input time.Time)

func (*ActivityRun) SetActivityRunStartAsTime

func (o *ActivityRun) SetActivityRunStartAsTime(input time.Time)

type ActivityRunsQueryResponse

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

type ActivityrunsClient

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

func NewActivityrunsClientWithBaseURI

func NewActivityrunsClientWithBaseURI(endpoint string) ActivityrunsClient

func (ActivityrunsClient) QueryByPipelineRun

func (c ActivityrunsClient) QueryByPipelineRun(ctx context.Context, id PipelineRunId, input RunFilterParameters) (result QueryByPipelineRunOperationResponse, err error)

QueryByPipelineRun ...

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 QueryByPipelineRunOperationResponse

type QueryByPipelineRunOperationResponse struct {
	HttpResponse *http.Response
	Model        *ActivityRunsQueryResponse
}

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

type RunQueryFilterOperator

type RunQueryFilterOperator string

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

type RunQueryOrder

type RunQueryOrder string

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

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