dataflows

package
v0.20230309.1072929 Latest Latest
Warning

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

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

README

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

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

Client Initialization

client := dataflows.NewDataFlowsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: DataFlowsClient.CreateOrUpdate

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

payload := dataflows.DataFlowResource{
	// ...
}


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

Example Usage: DataFlowsClient.Delete

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

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: DataFlowsClient.Get

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

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

Example Usage: DataFlowsClient.ListByFactory

ctx := context.TODO()
id := dataflows.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 ValidateDataflowID

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

ValidateDataflowID checks that 'input' can be parsed as a Dataflow ID

func ValidateFactoryID

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

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

Types

type CreateOrUpdateOperationOptions

type CreateOrUpdateOperationOptions struct {
	IfMatch *string
}

func DefaultCreateOrUpdateOperationOptions

func DefaultCreateOrUpdateOperationOptions() CreateOrUpdateOperationOptions

type CreateOrUpdateOperationResponse

type CreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	Model        *DataFlowResource
}

type DataFlow

type DataFlow struct {
	Annotations *[]interface{}  `json:"annotations,omitempty"`
	Description *string         `json:"description,omitempty"`
	Folder      *DataFlowFolder `json:"folder,omitempty"`
	Type        string          `json:"type"`
}

type DataFlowFolder

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

type DataFlowResource

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

type DataFlowResourceOperationPredicate

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

func (DataFlowResourceOperationPredicate) Matches

type DataFlowsClient

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

func NewDataFlowsClientWithBaseURI

func NewDataFlowsClientWithBaseURI(endpoint string) DataFlowsClient

func (DataFlowsClient) CreateOrUpdate

CreateOrUpdate ...

func (DataFlowsClient) Delete

func (c DataFlowsClient) Delete(ctx context.Context, id DataflowId) (result DeleteOperationResponse, err error)

Delete ...

func (DataFlowsClient) Get

Get ...

func (DataFlowsClient) ListByFactory

func (c DataFlowsClient) ListByFactory(ctx context.Context, id FactoryId) (resp ListByFactoryOperationResponse, err error)

ListByFactory ...

func (DataFlowsClient) ListByFactoryComplete

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

ListByFactoryComplete retrieves all of the results into a single object

func (DataFlowsClient) ListByFactoryCompleteMatchingPredicate

func (c DataFlowsClient) ListByFactoryCompleteMatchingPredicate(ctx context.Context, id FactoryId, predicate DataFlowResourceOperationPredicate) (resp ListByFactoryCompleteResult, err error)

ListByFactoryCompleteMatchingPredicate retrieves all of the results and then applied the predicate

type DataflowId

type DataflowId struct {
	SubscriptionId    string
	ResourceGroupName string
	FactoryName       string
	DataflowName      string
}

DataflowId is a struct representing the Resource ID for a Dataflow

func NewDataflowID

func NewDataflowID(subscriptionId string, resourceGroupName string, factoryName string, dataflowName string) DataflowId

NewDataflowID returns a new DataflowId struct

func ParseDataflowID

func ParseDataflowID(input string) (*DataflowId, error)

ParseDataflowID parses 'input' into a DataflowId

func ParseDataflowIDInsensitively

func ParseDataflowIDInsensitively(input string) (*DataflowId, error)

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

func (DataflowId) ID

func (id DataflowId) ID() string

ID returns the formatted Dataflow ID

func (DataflowId) Segments

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

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

func (DataflowId) String

func (id DataflowId) String() string

String returns a human-readable description of this Dataflow ID

type DeleteOperationResponse

type DeleteOperationResponse struct {
	HttpResponse *http.Response
}

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

type GetOperationResponse

type GetOperationResponse struct {
	HttpResponse *http.Response
	Model        *DataFlowResource
}

type ListByFactoryCompleteResult

type ListByFactoryCompleteResult struct {
	Items []DataFlowResource
}

type ListByFactoryOperationResponse

type ListByFactoryOperationResponse struct {
	HttpResponse *http.Response
	Model        *[]DataFlowResource
	// contains filtered or unexported fields
}

func (ListByFactoryOperationResponse) HasMore

func (ListByFactoryOperationResponse) LoadMore

Jump to

Keyboard shortcuts

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