pipelines

package
v0.20230530.1105843 Latest Latest
Warning

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

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

README

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

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

Client Initialization

client := pipelines.NewPipelinesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: PipelinesClient.CreateOrUpdate

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

payload := pipelines.PipelineResource{
	// ...
}


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

Example Usage: PipelinesClient.CreateRun

ctx := context.TODO()
id := pipelines.NewPipelineID("12345678-1234-9876-4563-123456789012", "example-resource-group", "factoryValue", "pipelineValue")
var payload map[string]interface{}

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

Example Usage: PipelinesClient.Delete

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

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

Example Usage: PipelinesClient.Get

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

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

Example Usage: PipelinesClient.ListByFactory

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

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForActivityOnInactiveMarkAs added in v0.20230518.1152641 

func PossibleValuesForActivityOnInactiveMarkAs() []string

func PossibleValuesForActivityState added in v0.20230518.1152641 

func PossibleValuesForActivityState() []string

func PossibleValuesForDependencyCondition 

func PossibleValuesForDependencyCondition() []string

func PossibleValuesForParameterType 

func PossibleValuesForParameterType() []string

func PossibleValuesForVariableType 

func PossibleValuesForVariableType() []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 ValidatePipelineID 

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

ValidatePipelineID checks that 'input' can be parsed as a Pipeline ID

Types

type Activity 

type Activity struct {
	DependsOn        *[]ActivityDependency     `json:"dependsOn,omitempty"`
	Description      *string                   `json:"description,omitempty"`
	Name             string                    `json:"name"`
	OnInactiveMarkAs *ActivityOnInactiveMarkAs `json:"onInactiveMarkAs,omitempty"`
	State            *ActivityState            `json:"state,omitempty"`
	Type             string                    `json:"type"`
	UserProperties   *[]UserProperty           `json:"userProperties,omitempty"`
}

type ActivityDependency 

type ActivityDependency struct {
	Activity             string                `json:"activity"`
	DependencyConditions []DependencyCondition `json:"dependencyConditions"`
}

type ActivityOnInactiveMarkAs added in v0.20230518.1152641 

type ActivityOnInactiveMarkAs string
const (
	ActivityOnInactiveMarkAsFailed    ActivityOnInactiveMarkAs = "Failed"
	ActivityOnInactiveMarkAsSkipped   ActivityOnInactiveMarkAs = "Skipped"
	ActivityOnInactiveMarkAsSucceeded ActivityOnInactiveMarkAs = "Succeeded"
)

func (*ActivityOnInactiveMarkAs) UnmarshalJSON added in v0.20230518.1152641 

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

type ActivityState added in v0.20230518.1152641 

type ActivityState string
const (
	ActivityStateActive   ActivityState = "Active"
	ActivityStateInactive ActivityState = "Inactive"
)

func (*ActivityState) UnmarshalJSON added in v0.20230518.1152641 

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

type CreateOrUpdateOperationOptions 

type CreateOrUpdateOperationOptions struct {
	IfMatch *string
}

func DefaultCreateOrUpdateOperationOptions 

func DefaultCreateOrUpdateOperationOptions() CreateOrUpdateOperationOptions

func (CreateOrUpdateOperationOptions) ToHeaders added in v0.20230516.1215417 

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

func (CreateOrUpdateOperationOptions) ToOData added in v0.20230516.1215417 

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

func (CreateOrUpdateOperationOptions) ToQuery added in v0.20230516.1215417 

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

type CreateOrUpdateOperationResponse 

type CreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *PipelineResource
}

type CreateRunOperationOptions 

type CreateRunOperationOptions struct {
	IsRecovery             *bool
	ReferencePipelineRunId *string
	StartActivityName      *string
	StartFromFailure       *bool
}

func DefaultCreateRunOperationOptions 

func DefaultCreateRunOperationOptions() CreateRunOperationOptions

func (CreateRunOperationOptions) ToHeaders added in v0.20230516.1215417 

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

func (CreateRunOperationOptions) ToOData added in v0.20230516.1215417 

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

func (CreateRunOperationOptions) ToQuery added in v0.20230516.1215417 

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

type CreateRunOperationResponse 

type CreateRunOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *CreateRunResponse
}

type CreateRunResponse 

type CreateRunResponse struct {
	RunId string `json:"runId"`
}

type DeleteOperationResponse 

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

type DependencyCondition 

type DependencyCondition string
const (
	DependencyConditionCompleted DependencyCondition = "Completed"
	DependencyConditionFailed    DependencyCondition = "Failed"
	DependencyConditionSkipped   DependencyCondition = "Skipped"
	DependencyConditionSucceeded DependencyCondition = "Succeeded"
)

func (*DependencyCondition) UnmarshalJSON added in v0.20230516.1215417 

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

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 GetOperationOptions 

type GetOperationOptions struct {
	IfNoneMatch *string
}

func DefaultGetOperationOptions 

func DefaultGetOperationOptions() GetOperationOptions

func (GetOperationOptions) ToHeaders added in v0.20230516.1215417 

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

func (GetOperationOptions) ToOData added in v0.20230516.1215417 

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

func (GetOperationOptions) ToQuery added in v0.20230516.1215417 

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

type GetOperationResponse 

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

type ListByFactoryCompleteResult 

type ListByFactoryCompleteResult struct {
	Items []PipelineResource
}

type ListByFactoryOperationResponse 

type ListByFactoryOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]PipelineResource
}

type ParameterSpecification 

type ParameterSpecification struct {
	DefaultValue *interface{}  `json:"defaultValue,omitempty"`
	Type         ParameterType `json:"type"`
}

type ParameterType 

type ParameterType string
const (
	ParameterTypeArray        ParameterType = "Array"
	ParameterTypeBool         ParameterType = "Bool"
	ParameterTypeFloat        ParameterType = "Float"
	ParameterTypeInt          ParameterType = "Int"
	ParameterTypeObject       ParameterType = "Object"
	ParameterTypeSecureString ParameterType = "SecureString"
	ParameterTypeString       ParameterType = "String"
)

func (*ParameterType) UnmarshalJSON added in v0.20230516.1215417 

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

type Pipeline 

type Pipeline struct {
	Activities    *[]Activity                        `json:"activities,omitempty"`
	Annotations   *[]interface{}                     `json:"annotations,omitempty"`
	Concurrency   *int64                             `json:"concurrency,omitempty"`
	Description   *string                            `json:"description,omitempty"`
	Folder        *PipelineFolder                    `json:"folder,omitempty"`
	Parameters    *map[string]ParameterSpecification `json:"parameters,omitempty"`
	Policy        *PipelinePolicy                    `json:"policy,omitempty"`
	RunDimensions *map[string]interface{}            `json:"runDimensions,omitempty"`
	Variables     *map[string]VariableSpecification  `json:"variables,omitempty"`
}

type PipelineElapsedTimeMetricPolicy 

type PipelineElapsedTimeMetricPolicy struct {
	Duration *interface{} `json:"duration,omitempty"`
}

type PipelineFolder 

type PipelineFolder struct {
	Name *string `json:"name,omitempty"`
}

type PipelineId 

type PipelineId struct {
	SubscriptionId    string
	ResourceGroupName string
	FactoryName       string
	PipelineName      string
}

PipelineId is a struct representing the Resource ID for a Pipeline

func NewPipelineID 

func NewPipelineID(subscriptionId string, resourceGroupName string, factoryName string, pipelineName string) PipelineId

NewPipelineID returns a new PipelineId struct

func ParsePipelineID 

func ParsePipelineID(input string) (*PipelineId, error)

ParsePipelineID parses 'input' into a PipelineId

func ParsePipelineIDInsensitively 

func ParsePipelineIDInsensitively(input string) (*PipelineId, error)

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

func (PipelineId) ID 

func (id PipelineId) ID() string

ID returns the formatted Pipeline ID

func (PipelineId) Segments 

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

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

func (PipelineId) String 

func (id PipelineId) String() string

String returns a human-readable description of this Pipeline ID

type PipelinePolicy 

type PipelinePolicy struct {
	ElapsedTimeMetric *PipelineElapsedTimeMetricPolicy `json:"elapsedTimeMetric,omitempty"`
}

type PipelineResource 

type PipelineResource struct {
	Etag       *string  `json:"etag,omitempty"`
	Id         *string  `json:"id,omitempty"`
	Name       *string  `json:"name,omitempty"`
	Properties Pipeline `json:"properties"`
	Type       *string  `json:"type,omitempty"`
}

type PipelineResourceOperationPredicate 

type PipelineResourceOperationPredicate struct {
	Etag *string
	Id   *string
	Name *string
	Type *string
}

func (PipelineResourceOperationPredicate) Matches 

func (p PipelineResourceOperationPredicate) Matches(input PipelineResource) bool

type PipelinesClient 

type PipelinesClient struct {
	Client *resourcemanager.Client
}

func NewPipelinesClientWithBaseURI 

func NewPipelinesClientWithBaseURI(api environments.Api) (*PipelinesClient, error)

func (PipelinesClient) CreateOrUpdate 

func (c PipelinesClient) CreateOrUpdate(ctx context.Context, id PipelineId, input PipelineResource, options CreateOrUpdateOperationOptions) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (PipelinesClient) CreateRun 

func (c PipelinesClient) CreateRun(ctx context.Context, id PipelineId, input map[string]interface{}, options CreateRunOperationOptions) (result CreateRunOperationResponse, err error)

CreateRun ...

func (PipelinesClient) Delete 

func (c PipelinesClient) Delete(ctx context.Context, id PipelineId) (result DeleteOperationResponse, err error)

Delete ...

func (PipelinesClient) Get 

func (c PipelinesClient) Get(ctx context.Context, id PipelineId, options GetOperationOptions) (result GetOperationResponse, err error)

Get ...

func (PipelinesClient) ListByFactory 

func (c PipelinesClient) ListByFactory(ctx context.Context, id FactoryId) (result ListByFactoryOperationResponse, err error)

ListByFactory ...

func (PipelinesClient) ListByFactoryComplete 

func (c PipelinesClient) ListByFactoryComplete(ctx context.Context, id FactoryId) (ListByFactoryCompleteResult, error)

ListByFactoryComplete retrieves all the results into a single object

func (PipelinesClient) ListByFactoryCompleteMatchingPredicate 

func (c PipelinesClient) ListByFactoryCompleteMatchingPredicate(ctx context.Context, id FactoryId, predicate PipelineResourceOperationPredicate) (result ListByFactoryCompleteResult, err error)

ListByFactoryCompleteMatchingPredicate retrieves all the results and then applies the predicate

type UserProperty 

type UserProperty struct {
	Name  string      `json:"name"`
	Value interface{} `json:"value"`
}

type VariableSpecification 

type VariableSpecification struct {
	DefaultValue *interface{} `json:"defaultValue,omitempty"`
	Type         VariableType `json:"type"`
}

type VariableType 

type VariableType string
const (
	VariableTypeArray  VariableType = "Array"
	VariableTypeBool   VariableType = "Bool"
	VariableTypeString VariableType = "String"
)

func (*VariableType) UnmarshalJSON added in v0.20230516.1215417 

func (s *VariableType) 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.