dataflows

package
v0.20240516.1091934 Latest Latest
Warning

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

 Go to latest Published: May 16, 2024 License: MPL-2.0 Imports: 11 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 PossibleValuesForDataFlowReferenceType added in v0.20240320.1143605 

func PossibleValuesForDataFlowReferenceType() []string

func PossibleValuesForDatasetReferenceType added in v0.20240320.1143605 

func PossibleValuesForDatasetReferenceType() []string

func PossibleValuesForType added in v0.20240320.1143605 

func PossibleValuesForType() []string

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

func (CreateOrUpdateOperationOptions) ToHeaders 

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

func (CreateOrUpdateOperationOptions) ToOData 

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

func (CreateOrUpdateOperationOptions) ToQuery 

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

type CreateOrUpdateOperationResponse 

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

type DataFlow 

type DataFlow interface {
}

type DataFlowFolder 

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

type DataFlowReference added in v0.20240320.1143605 

type DataFlowReference struct {
	DatasetParameters *interface{}            `json:"datasetParameters,omitempty"`
	Parameters        *map[string]interface{} `json:"parameters,omitempty"`
	ReferenceName     string                  `json:"referenceName"`
	Type              DataFlowReferenceType   `json:"type"`
}

type DataFlowReferenceType added in v0.20240320.1143605 

type DataFlowReferenceType string
const (
	DataFlowReferenceTypeDataFlowReference DataFlowReferenceType = "DataFlowReference"
)

func (*DataFlowReferenceType) UnmarshalJSON added in v0.20240320.1143605 

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

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"`
}

func (*DataFlowResource) UnmarshalJSON added in v0.20240320.1143605 

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

type DataFlowResourceOperationPredicate 

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

func (DataFlowResourceOperationPredicate) Matches 

func (p DataFlowResourceOperationPredicate) Matches(input DataFlowResource) bool

type DataFlowSink added in v0.20240320.1143605 

type DataFlowSink struct {
	Dataset                   *DatasetReference       `json:"dataset,omitempty"`
	Description               *string                 `json:"description,omitempty"`
	Flowlet                   *DataFlowReference      `json:"flowlet,omitempty"`
	LinkedService             *LinkedServiceReference `json:"linkedService,omitempty"`
	Name                      string                  `json:"name"`
	RejectedDataLinkedService *LinkedServiceReference `json:"rejectedDataLinkedService,omitempty"`
	SchemaLinkedService       *LinkedServiceReference `json:"schemaLinkedService,omitempty"`
}

type DataFlowSource added in v0.20240320.1143605 

type DataFlowSource struct {
	Dataset             *DatasetReference       `json:"dataset,omitempty"`
	Description         *string                 `json:"description,omitempty"`
	Flowlet             *DataFlowReference      `json:"flowlet,omitempty"`
	LinkedService       *LinkedServiceReference `json:"linkedService,omitempty"`
	Name                string                  `json:"name"`
	SchemaLinkedService *LinkedServiceReference `json:"schemaLinkedService,omitempty"`
}

type DataFlowsClient 

type DataFlowsClient struct {
	Client *resourcemanager.Client
}

func NewDataFlowsClientWithBaseURI 

func NewDataFlowsClientWithBaseURI(sdkApi sdkEnv.Api) (*DataFlowsClient, error)

func (DataFlowsClient) CreateOrUpdate 

func (c DataFlowsClient) CreateOrUpdate(ctx context.Context, id DataflowId, input DataFlowResource, options CreateOrUpdateOperationOptions) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (DataFlowsClient) Delete 

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

Delete ...

func (DataFlowsClient) Get 

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

Get ...

func (DataFlowsClient) ListByFactory 

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

ListByFactory ...

func (DataFlowsClient) ListByFactoryComplete 

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

ListByFactoryComplete retrieves all the results into a single object

func (DataFlowsClient) ListByFactoryCompleteMatchingPredicate 

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

ListByFactoryCompleteMatchingPredicate retrieves all the results and then applies 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) FromParseResult 

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

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 DatasetReference added in v0.20240320.1143605 

type DatasetReference struct {
	Parameters    *map[string]interface{} `json:"parameters,omitempty"`
	ReferenceName string                  `json:"referenceName"`
	Type          DatasetReferenceType    `json:"type"`
}

type DatasetReferenceType added in v0.20240320.1143605 

type DatasetReferenceType string
const (
	DatasetReferenceTypeDatasetReference DatasetReferenceType = "DatasetReference"
)

func (*DatasetReferenceType) UnmarshalJSON added in v0.20240320.1143605 

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

type DeleteOperationResponse 

type DeleteOperationResponse 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 

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 Flowlet added in v0.20240320.1143605 

type Flowlet struct {
	TypeProperties *FlowletTypeProperties `json:"typeProperties,omitempty"`

	// Fields inherited from DataFlow
	Annotations *[]interface{}  `json:"annotations,omitempty"`
	Description *string         `json:"description,omitempty"`
	Folder      *DataFlowFolder `json:"folder,omitempty"`
}

func (Flowlet) MarshalJSON added in v0.20240320.1143605 

func (s Flowlet) MarshalJSON() ([]byte, error)

type FlowletTypeProperties added in v0.20240320.1143605 

type FlowletTypeProperties struct {
	Script          *string           `json:"script,omitempty"`
	ScriptLines     *[]string         `json:"scriptLines,omitempty"`
	Sinks           *[]DataFlowSink   `json:"sinks,omitempty"`
	Sources         *[]DataFlowSource `json:"sources,omitempty"`
	Transformations *[]Transformation `json:"transformations,omitempty"`
}

type GetOperationOptions 

type GetOperationOptions struct {
	IfNoneMatch *string
}

func DefaultGetOperationOptions 

func DefaultGetOperationOptions() GetOperationOptions

func (GetOperationOptions) ToHeaders 

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

func (GetOperationOptions) ToOData 

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

func (GetOperationOptions) ToQuery 

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

type GetOperationResponse 

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

type LinkedServiceReference added in v0.20240320.1143605 

type LinkedServiceReference struct {
	Parameters    *map[string]interface{} `json:"parameters,omitempty"`
	ReferenceName string                  `json:"referenceName"`
	Type          Type                    `json:"type"`
}

type ListByFactoryCompleteResult 

type ListByFactoryCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []DataFlowResource
}

type ListByFactoryOperationResponse 

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

type MappingDataFlow added in v0.20240320.1143605 

type MappingDataFlow struct {
	TypeProperties *MappingDataFlowTypeProperties `json:"typeProperties,omitempty"`

	// Fields inherited from DataFlow
	Annotations *[]interface{}  `json:"annotations,omitempty"`
	Description *string         `json:"description,omitempty"`
	Folder      *DataFlowFolder `json:"folder,omitempty"`
}

func (MappingDataFlow) MarshalJSON added in v0.20240320.1143605 

func (s MappingDataFlow) MarshalJSON() ([]byte, error)

type MappingDataFlowTypeProperties added in v0.20240320.1143605 

type MappingDataFlowTypeProperties struct {
	Script          *string           `json:"script,omitempty"`
	ScriptLines     *[]string         `json:"scriptLines,omitempty"`
	Sinks           *[]DataFlowSink   `json:"sinks,omitempty"`
	Sources         *[]DataFlowSource `json:"sources,omitempty"`
	Transformations *[]Transformation `json:"transformations,omitempty"`
}

type PowerQuerySource added in v0.20240320.1143605 

type PowerQuerySource struct {
	Dataset             *DatasetReference       `json:"dataset,omitempty"`
	Description         *string                 `json:"description,omitempty"`
	Flowlet             *DataFlowReference      `json:"flowlet,omitempty"`
	LinkedService       *LinkedServiceReference `json:"linkedService,omitempty"`
	Name                string                  `json:"name"`
	SchemaLinkedService *LinkedServiceReference `json:"schemaLinkedService,omitempty"`
	Script              *string                 `json:"script,omitempty"`
}

type PowerQueryTypeProperties added in v0.20240320.1143605 

type PowerQueryTypeProperties struct {
	DocumentLocale *string             `json:"documentLocale,omitempty"`
	Script         *string             `json:"script,omitempty"`
	Sources        *[]PowerQuerySource `json:"sources,omitempty"`
}

type RawDataFlowImpl added in v0.20240320.1143605 

type RawDataFlowImpl struct {
	Type   string
	Values map[string]interface{}
}

RawDataFlowImpl is returned when the Discriminated Value doesn't match any of the defined types NOTE: this should only be used when a type isn't defined for this type of Object (as a workaround) and is used only for Deserialization (e.g. this cannot be used as a Request Payload).

type Transformation added in v0.20240320.1143605 

type Transformation struct {
	Dataset       *DatasetReference       `json:"dataset,omitempty"`
	Description   *string                 `json:"description,omitempty"`
	Flowlet       *DataFlowReference      `json:"flowlet,omitempty"`
	LinkedService *LinkedServiceReference `json:"linkedService,omitempty"`
	Name          string                  `json:"name"`
}

type Type added in v0.20240320.1143605 

type Type string
const (
	TypeLinkedServiceReference Type = "LinkedServiceReference"
)

func (*Type) UnmarshalJSON added in v0.20240320.1143605 

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

type WranglingDataFlow added in v0.20240320.1143605 

type WranglingDataFlow struct {
	TypeProperties *PowerQueryTypeProperties `json:"typeProperties,omitempty"`

	// Fields inherited from DataFlow
	Annotations *[]interface{}  `json:"annotations,omitempty"`
	Description *string         `json:"description,omitempty"`
	Folder      *DataFlowFolder `json:"folder,omitempty"`
}

func (WranglingDataFlow) MarshalJSON added in v0.20240320.1143605 

func (s WranglingDataFlow) MarshalJSON() ([]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.