dataflowdebugsession

package
v0.20231129.1103252 Latest Latest
Warning

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

 Go to latest Published: Nov 29, 2023 License: MPL-2.0 Imports: 11 Imported by: 1

README

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

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

Client Initialization

client := dataflowdebugsession.NewDataFlowDebugSessionClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: DataFlowDebugSessionClient.AddDataFlow

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

payload := dataflowdebugsession.DataFlowDebugPackage{
	// ...
}


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

Example Usage: DataFlowDebugSessionClient.Create

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

payload := dataflowdebugsession.CreateDataFlowDebugSessionRequest{
	// ...
}


if err := client.CreateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: DataFlowDebugSessionClient.Delete

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

payload := dataflowdebugsession.DeleteDataFlowDebugSessionRequest{
	// ...
}


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

Example Usage: DataFlowDebugSessionClient.ExecuteCommand

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

payload := dataflowdebugsession.DataFlowDebugCommandRequest{
	// ...
}


if err := client.ExecuteCommandThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: DataFlowDebugSessionClient.QueryByFactory

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

// alternatively `client.QueryByFactory(ctx, id)` can be used to do batched pagination
items, err := client.QueryByFactoryComplete(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 PossibleValuesForDataFlowDebugCommandType 

func PossibleValuesForDataFlowDebugCommandType() []string

func PossibleValuesForIntegrationRuntimeType 

func PossibleValuesForIntegrationRuntimeType() []string

func PossibleValuesForParameterType 

func PossibleValuesForParameterType() []string

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 AddDataFlowOperationResponse 

type AddDataFlowOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *AddDataFlowToDebugSessionResponse
}

type AddDataFlowToDebugSessionResponse 

type AddDataFlowToDebugSessionResponse struct {
	JobVersion *string `json:"jobVersion,omitempty"`
}

type CreateDataFlowDebugSessionRequest 

type CreateDataFlowDebugSessionRequest struct {
	ComputeType        *string                          `json:"computeType,omitempty"`
	CoreCount          *int64                           `json:"coreCount,omitempty"`
	IntegrationRuntime *IntegrationRuntimeDebugResource `json:"integrationRuntime,omitempty"`
	TimeToLive         *int64                           `json:"timeToLive,omitempty"`
}

type CreateDataFlowDebugSessionResponse 

type CreateDataFlowDebugSessionResponse struct {
	SessionId *string `json:"sessionId,omitempty"`
	Status    *string `json:"status,omitempty"`
}

type CreateOperationResponse 

type CreateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

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 DataFlowDebugCommandPayload 

type DataFlowDebugCommandPayload struct {
	Columns    *[]string `json:"columns,omitempty"`
	Expression *string   `json:"expression,omitempty"`
	RowLimits  *int64    `json:"rowLimits,omitempty"`
	StreamName string    `json:"streamName"`
}

type DataFlowDebugCommandRequest 

type DataFlowDebugCommandRequest struct {
	Command        *DataFlowDebugCommandType    `json:"command,omitempty"`
	CommandPayload *DataFlowDebugCommandPayload `json:"commandPayload,omitempty"`
	SessionId      *string                      `json:"sessionId,omitempty"`
}

type DataFlowDebugCommandResponse 

type DataFlowDebugCommandResponse struct {
	Data   *string `json:"data,omitempty"`
	Status *string `json:"status,omitempty"`
}

type DataFlowDebugCommandType 

type DataFlowDebugCommandType string
const (
	DataFlowDebugCommandTypeExecuteExpressionQuery DataFlowDebugCommandType = "executeExpressionQuery"
	DataFlowDebugCommandTypeExecutePreviewQuery    DataFlowDebugCommandType = "executePreviewQuery"
	DataFlowDebugCommandTypeExecuteStatisticsQuery DataFlowDebugCommandType = "executeStatisticsQuery"
)

func (*DataFlowDebugCommandType) UnmarshalJSON added in v0.20230516.1215417 

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

type DataFlowDebugPackage 

type DataFlowDebugPackage struct {
	DataFlow       *DataFlowDebugResource             `json:"dataFlow,omitempty"`
	DataFlows      *[]DataFlowDebugResource           `json:"dataFlows,omitempty"`
	Datasets       *[]DatasetDebugResource            `json:"datasets,omitempty"`
	DebugSettings  *DataFlowDebugPackageDebugSettings `json:"debugSettings,omitempty"`
	LinkedServices *[]LinkedServiceDebugResource      `json:"linkedServices,omitempty"`
	SessionId      *string                            `json:"sessionId,omitempty"`
	Staging        *DataFlowStagingInfo               `json:"staging,omitempty"`
}

type DataFlowDebugPackageDebugSettings 

type DataFlowDebugPackageDebugSettings struct {
	DatasetParameters *interface{}             `json:"datasetParameters,omitempty"`
	Parameters        *map[string]interface{}  `json:"parameters,omitempty"`
	SourceSettings    *[]DataFlowSourceSetting `json:"sourceSettings,omitempty"`
}

type DataFlowDebugResource 

type DataFlowDebugResource struct {
	Name       *string  `json:"name,omitempty"`
	Properties DataFlow `json:"properties"`
}

type DataFlowDebugSessionClient 

type DataFlowDebugSessionClient struct {
	Client *resourcemanager.Client
}

func NewDataFlowDebugSessionClientWithBaseURI 

func NewDataFlowDebugSessionClientWithBaseURI(sdkApi sdkEnv.Api) (*DataFlowDebugSessionClient, error)

func (DataFlowDebugSessionClient) AddDataFlow 

func (c DataFlowDebugSessionClient) AddDataFlow(ctx context.Context, id FactoryId, input DataFlowDebugPackage) (result AddDataFlowOperationResponse, err error)

AddDataFlow ...

func (DataFlowDebugSessionClient) Create 

func (c DataFlowDebugSessionClient) Create(ctx context.Context, id FactoryId, input CreateDataFlowDebugSessionRequest) (result CreateOperationResponse, err error)

Create ...

func (DataFlowDebugSessionClient) CreateThenPoll 

func (c DataFlowDebugSessionClient) CreateThenPoll(ctx context.Context, id FactoryId, input CreateDataFlowDebugSessionRequest) error

CreateThenPoll performs Create then polls until it's completed

func (DataFlowDebugSessionClient) Delete 

func (c DataFlowDebugSessionClient) Delete(ctx context.Context, id FactoryId, input DeleteDataFlowDebugSessionRequest) (result DeleteOperationResponse, err error)

Delete ...

func (DataFlowDebugSessionClient) ExecuteCommand 

func (c DataFlowDebugSessionClient) ExecuteCommand(ctx context.Context, id FactoryId, input DataFlowDebugCommandRequest) (result ExecuteCommandOperationResponse, err error)

ExecuteCommand ...

func (DataFlowDebugSessionClient) ExecuteCommandThenPoll 

func (c DataFlowDebugSessionClient) ExecuteCommandThenPoll(ctx context.Context, id FactoryId, input DataFlowDebugCommandRequest) error

ExecuteCommandThenPoll performs ExecuteCommand then polls until it's completed

func (DataFlowDebugSessionClient) QueryByFactory 

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

QueryByFactory ...

func (DataFlowDebugSessionClient) QueryByFactoryComplete 

func (c DataFlowDebugSessionClient) QueryByFactoryComplete(ctx context.Context, id FactoryId) (QueryByFactoryCompleteResult, error)

QueryByFactoryComplete retrieves all the results into a single object

func (DataFlowDebugSessionClient) QueryByFactoryCompleteMatchingPredicate 

func (c DataFlowDebugSessionClient) QueryByFactoryCompleteMatchingPredicate(ctx context.Context, id FactoryId, predicate DataFlowDebugSessionInfoOperationPredicate) (result QueryByFactoryCompleteResult, err error)

QueryByFactoryCompleteMatchingPredicate retrieves all the results and then applies the predicate

type DataFlowDebugSessionInfo 

type DataFlowDebugSessionInfo struct {
	ComputeType            *string `json:"computeType,omitempty"`
	CoreCount              *int64  `json:"coreCount,omitempty"`
	DataFlowName           *string `json:"dataFlowName,omitempty"`
	IntegrationRuntimeName *string `json:"integrationRuntimeName,omitempty"`
	LastActivityTime       *string `json:"lastActivityTime,omitempty"`
	NodeCount              *int64  `json:"nodeCount,omitempty"`
	SessionId              *string `json:"sessionId,omitempty"`
	StartTime              *string `json:"startTime,omitempty"`
	TimeToLiveInMinutes    *int64  `json:"timeToLiveInMinutes,omitempty"`
}

type DataFlowDebugSessionInfoOperationPredicate 

type DataFlowDebugSessionInfoOperationPredicate struct {
	ComputeType            *string
	CoreCount              *int64
	DataFlowName           *string
	IntegrationRuntimeName *string
	LastActivityTime       *string
	NodeCount              *int64
	SessionId              *string
	StartTime              *string
	TimeToLiveInMinutes    *int64
}

func (DataFlowDebugSessionInfoOperationPredicate) Matches 

func (p DataFlowDebugSessionInfoOperationPredicate) Matches(input DataFlowDebugSessionInfo) bool

type DataFlowFolder 

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

type DataFlowSourceSetting 

type DataFlowSourceSetting struct {
	RowLimit   *int64  `json:"rowLimit,omitempty"`
	SourceName *string `json:"sourceName,omitempty"`
}

type DataFlowStagingInfo 

type DataFlowStagingInfo struct {
	FolderPath    *interface{} `json:"folderPath,omitempty"`
	LinkedService Reference    `json:"linkedService"`
}

func (*DataFlowStagingInfo) UnmarshalJSON added in v0.20230313.1115805 

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

type Dataset 

type Dataset struct {
	Annotations       *[]interface{}                     `json:"annotations,omitempty"`
	Description       *string                            `json:"description,omitempty"`
	Folder            *DatasetFolder                     `json:"folder,omitempty"`
	LinkedServiceName Reference                          `json:"linkedServiceName"`
	Parameters        *map[string]ParameterSpecification `json:"parameters,omitempty"`
	Schema            *interface{}                       `json:"schema,omitempty"`
	Structure         *interface{}                       `json:"structure,omitempty"`
	Type              string                             `json:"type"`
}

func (*Dataset) UnmarshalJSON added in v0.20230313.1115805 

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

type DatasetDebugResource 

type DatasetDebugResource struct {
	Name       *string `json:"name,omitempty"`
	Properties Dataset `json:"properties"`
}

type DatasetFolder 

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

type DeleteDataFlowDebugSessionRequest 

type DeleteDataFlowDebugSessionRequest struct {
	SessionId *string `json:"sessionId,omitempty"`
}

type DeleteOperationResponse 

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

type ExecuteCommandOperationResponse 

type ExecuteCommandOperationResponse struct {
	Poller       pollers.Poller
	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 added in v0.20231127.1171502 

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 IntegrationRuntime 

type IntegrationRuntime struct {
	Description *string                `json:"description,omitempty"`
	Type        IntegrationRuntimeType `json:"type"`
}

type IntegrationRuntimeDebugResource 

type IntegrationRuntimeDebugResource struct {
	Name       *string            `json:"name,omitempty"`
	Properties IntegrationRuntime `json:"properties"`
}

type IntegrationRuntimeReference 

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

func (IntegrationRuntimeReference) MarshalJSON added in v0.20230313.1115805 

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

type IntegrationRuntimeType 

type IntegrationRuntimeType string
const (
	IntegrationRuntimeTypeManaged    IntegrationRuntimeType = "Managed"
	IntegrationRuntimeTypeSelfHosted IntegrationRuntimeType = "SelfHosted"
)

func (*IntegrationRuntimeType) UnmarshalJSON added in v0.20230516.1215417 

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

type LinkedService 

type LinkedService struct {
	Annotations *[]interface{}                     `json:"annotations,omitempty"`
	ConnectVia  Reference                          `json:"connectVia"`
	Description *string                            `json:"description,omitempty"`
	Parameters  *map[string]ParameterSpecification `json:"parameters,omitempty"`
	Type        string                             `json:"type"`
}

func (*LinkedService) UnmarshalJSON added in v0.20230313.1115805 

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

type LinkedServiceDebugResource 

type LinkedServiceDebugResource struct {
	Name       *string       `json:"name,omitempty"`
	Properties LinkedService `json:"properties"`
}

type LinkedServiceReference 

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

func (LinkedServiceReference) MarshalJSON added in v0.20230313.1115805 

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

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 QueryByFactoryCompleteResult 

type QueryByFactoryCompleteResult struct {
	Items []DataFlowDebugSessionInfo
}

type QueryByFactoryOperationResponse 

type QueryByFactoryOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]DataFlowDebugSessionInfo
}

type RawReferenceImpl added in v0.20230807.1063129 

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

RawReferenceImpl 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 Reference added in v0.20230313.1115805 

type Reference interface {
}

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.