datasets

package
v0.20231213.1163732 Latest Latest
Warning

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

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

README

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

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

Client Initialization

client := datasets.NewDatasetsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: DatasetsClient.CreateOrUpdate

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

payload := datasets.DatasetResource{
	// ...
}


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

Example Usage: DatasetsClient.Delete

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

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

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

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

Example Usage: DatasetsClient.ListByFactory

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

func PossibleValuesForParameterType() []string

func PossibleValuesForType

func PossibleValuesForType() []string

func ValidateDatasetID

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

ValidateDatasetID checks that 'input' can be parsed as a Dataset 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 added in v0.20230516.1215417

func (CreateOrUpdateOperationOptions) ToOData added in v0.20230516.1215417

func (CreateOrUpdateOperationOptions) ToQuery added in v0.20230516.1215417

type CreateOrUpdateOperationResponse

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

type Dataset

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

type DatasetFolder

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

type DatasetId

type DatasetId struct {
	SubscriptionId    string
	ResourceGroupName string
	FactoryName       string
	DatasetName       string
}

DatasetId is a struct representing the Resource ID for a Dataset

func NewDatasetID

func NewDatasetID(subscriptionId string, resourceGroupName string, factoryName string, datasetName string) DatasetId

NewDatasetID returns a new DatasetId struct

func ParseDatasetID

func ParseDatasetID(input string) (*DatasetId, error)

ParseDatasetID parses 'input' into a DatasetId

func ParseDatasetIDInsensitively

func ParseDatasetIDInsensitively(input string) (*DatasetId, error)

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

func (*DatasetId) FromParseResult added in v0.20231127.1171502

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

func (DatasetId) ID

func (id DatasetId) ID() string

ID returns the formatted Dataset ID

func (DatasetId) Segments

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

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

func (DatasetId) String

func (id DatasetId) String() string

String returns a human-readable description of this Dataset ID

type DatasetResource

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

type DatasetResourceOperationPredicate

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

func (DatasetResourceOperationPredicate) Matches

type DatasetsClient

type DatasetsClient struct {
	Client *resourcemanager.Client
}

func NewDatasetsClientWithBaseURI

func NewDatasetsClientWithBaseURI(sdkApi sdkEnv.Api) (*DatasetsClient, error)

func (DatasetsClient) CreateOrUpdate

CreateOrUpdate ...

func (DatasetsClient) Delete

func (c DatasetsClient) Delete(ctx context.Context, id DatasetId) (result DeleteOperationResponse, err error)

Delete ...

func (DatasetsClient) Get

Get ...

func (DatasetsClient) ListByFactory

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

ListByFactory ...

func (DatasetsClient) ListByFactoryComplete

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

ListByFactoryComplete retrieves all the results into a single object

func (DatasetsClient) ListByFactoryCompleteMatchingPredicate

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

ListByFactoryCompleteMatchingPredicate retrieves all the results and then applies the predicate

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 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 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        *DatasetResource
}

type LinkedServiceReference

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

type ListByFactoryCompleteResult

type ListByFactoryCompleteResult struct {
	Items []DatasetResource
}

type ListByFactoryOperationResponse

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

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 Type

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

func (*Type) UnmarshalJSON added in v0.20230516.1215417

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

Jump to

Keyboard shortcuts

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