changedatacapture

package
v0.20240304.1112406 Latest Latest
Warning

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

 Go to latest Published: Mar 4, 2024 License: MPL-2.0 Imports: 10 Imported by: 1

README

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

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

Client Initialization

client := changedatacapture.NewChangeDataCaptureClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ChangeDataCaptureClient.CreateOrUpdate

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

payload := changedatacapture.ChangeDataCaptureResource{
	// ...
}


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

Example Usage: ChangeDataCaptureClient.Delete

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

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

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

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

Example Usage: ChangeDataCaptureClient.ListByFactory

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

Example Usage: ChangeDataCaptureClient.Start

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

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

Example Usage: ChangeDataCaptureClient.Status

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

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

Example Usage: ChangeDataCaptureClient.Stop

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

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForConnectionType 

func PossibleValuesForConnectionType() []string

func PossibleValuesForFrequencyType 

func PossibleValuesForFrequencyType() []string

func PossibleValuesForMappingType 

func PossibleValuesForMappingType() []string

func PossibleValuesForType 

func PossibleValuesForType() []string

func ValidateAdfcdcID 

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

ValidateAdfcdcID checks that 'input' can be parsed as a Adfcdc 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 AdfcdcId 

type AdfcdcId struct {
	SubscriptionId    string
	ResourceGroupName string
	FactoryName       string
	AdfcdcName        string
}

AdfcdcId is a struct representing the Resource ID for a Adfcdc

func NewAdfcdcID 

func NewAdfcdcID(subscriptionId string, resourceGroupName string, factoryName string, adfcdcName string) AdfcdcId

NewAdfcdcID returns a new AdfcdcId struct

func ParseAdfcdcID 

func ParseAdfcdcID(input string) (*AdfcdcId, error)

ParseAdfcdcID parses 'input' into a AdfcdcId

func ParseAdfcdcIDInsensitively 

func ParseAdfcdcIDInsensitively(input string) (*AdfcdcId, error)

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

func (*AdfcdcId) FromParseResult 

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

func (AdfcdcId) ID 

func (id AdfcdcId) ID() string

ID returns the formatted Adfcdc ID

func (AdfcdcId) Segments 

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

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

func (AdfcdcId) String 

func (id AdfcdcId) String() string

String returns a human-readable description of this Adfcdc ID

type ChangeDataCapture 

type ChangeDataCapture struct {
	AllowVNetOverride     *bool                         `json:"allowVNetOverride,omitempty"`
	Description           *string                       `json:"description,omitempty"`
	Folder                *ChangeDataCaptureFolder      `json:"folder,omitempty"`
	Policy                MapperPolicy                  `json:"policy"`
	SourceConnectionsInfo []MapperSourceConnectionsInfo `json:"sourceConnectionsInfo"`
	Status                *string                       `json:"status,omitempty"`
	TargetConnectionsInfo []MapperTargetConnectionsInfo `json:"targetConnectionsInfo"`
}

type ChangeDataCaptureClient 

type ChangeDataCaptureClient struct {
	Client *resourcemanager.Client
}

func NewChangeDataCaptureClientWithBaseURI 

func NewChangeDataCaptureClientWithBaseURI(sdkApi sdkEnv.Api) (*ChangeDataCaptureClient, error)

func (ChangeDataCaptureClient) CreateOrUpdate 

func (c ChangeDataCaptureClient) CreateOrUpdate(ctx context.Context, id AdfcdcId, input ChangeDataCaptureResource, options CreateOrUpdateOperationOptions) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (ChangeDataCaptureClient) Delete 

func (c ChangeDataCaptureClient) Delete(ctx context.Context, id AdfcdcId) (result DeleteOperationResponse, err error)

Delete ...

func (ChangeDataCaptureClient) Get 

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

Get ...

func (ChangeDataCaptureClient) ListByFactory 

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

ListByFactory ...

func (ChangeDataCaptureClient) ListByFactoryComplete 

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

ListByFactoryComplete retrieves all the results into a single object

func (ChangeDataCaptureClient) ListByFactoryCompleteMatchingPredicate 

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

ListByFactoryCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ChangeDataCaptureClient) Start 

func (c ChangeDataCaptureClient) Start(ctx context.Context, id AdfcdcId) (result StartOperationResponse, err error)

Start ...

func (ChangeDataCaptureClient) Status 

func (c ChangeDataCaptureClient) Status(ctx context.Context, id AdfcdcId) (result StatusOperationResponse, err error)

Status ...

func (ChangeDataCaptureClient) Stop 

func (c ChangeDataCaptureClient) Stop(ctx context.Context, id AdfcdcId) (result StopOperationResponse, err error)

Stop ...

type ChangeDataCaptureFolder 

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

type ChangeDataCaptureResource 

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

type ChangeDataCaptureResourceOperationPredicate 

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

func (ChangeDataCaptureResourceOperationPredicate) Matches 

func (p ChangeDataCaptureResourceOperationPredicate) Matches(input ChangeDataCaptureResource) bool

type ConnectionType 

type ConnectionType string
const (
	ConnectionTypeLinkedservicetype ConnectionType = "linkedservicetype"
)

func (*ConnectionType) UnmarshalJSON 

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

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

type DataMapperMapping 

type DataMapperMapping struct {
	AttributeMappingInfo      *MapperAttributeMappings   `json:"attributeMappingInfo,omitempty"`
	SourceConnectionReference *MapperConnectionReference `json:"sourceConnectionReference,omitempty"`
	SourceDenormalizeInfo     *interface{}               `json:"sourceDenormalizeInfo,omitempty"`
	SourceEntityName          *string                    `json:"sourceEntityName,omitempty"`
	TargetEntityName          *string                    `json:"targetEntityName,omitempty"`
}

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 FrequencyType 

type FrequencyType string
const (
	FrequencyTypeHour   FrequencyType = "Hour"
	FrequencyTypeMinute FrequencyType = "Minute"
	FrequencyTypeSecond FrequencyType = "Second"
)

func (*FrequencyType) UnmarshalJSON 

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

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

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 {
	LatestHttpResponse *http.Response
	Items              []ChangeDataCaptureResource
}

type ListByFactoryOperationResponse 

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

type MapperAttributeMapping 

type MapperAttributeMapping struct {
	AttributeReference  *MapperAttributeReference   `json:"attributeReference,omitempty"`
	AttributeReferences *[]MapperAttributeReference `json:"attributeReferences,omitempty"`
	Expression          *string                     `json:"expression,omitempty"`
	FunctionName        *string                     `json:"functionName,omitempty"`
	Name                *string                     `json:"name,omitempty"`
	Type                *MappingType                `json:"type,omitempty"`
}

type MapperAttributeMappings 

type MapperAttributeMappings struct {
	AttributeMappings *[]MapperAttributeMapping `json:"attributeMappings,omitempty"`
}

type MapperAttributeReference 

type MapperAttributeReference struct {
	Entity                    *string                    `json:"entity,omitempty"`
	EntityConnectionReference *MapperConnectionReference `json:"entityConnectionReference,omitempty"`
	Name                      *string                    `json:"name,omitempty"`
}

type MapperConnection 

type MapperConnection struct {
	CommonDslConnectorProperties *[]MapperDslConnectorProperties `json:"commonDslConnectorProperties,omitempty"`
	IsInlineDataset              *bool                           `json:"isInlineDataset,omitempty"`
	LinkedService                *LinkedServiceReference         `json:"linkedService,omitempty"`
	LinkedServiceType            *string                         `json:"linkedServiceType,omitempty"`
	Type                         ConnectionType                  `json:"type"`
}

type MapperConnectionReference 

type MapperConnectionReference struct {
	ConnectionName *string         `json:"connectionName,omitempty"`
	Type           *ConnectionType `json:"type,omitempty"`
}

type MapperDslConnectorProperties 

type MapperDslConnectorProperties struct {
	Name  *string      `json:"name,omitempty"`
	Value *interface{} `json:"value,omitempty"`
}

type MapperPolicy 

type MapperPolicy struct {
	Mode       *string                 `json:"mode,omitempty"`
	Recurrence *MapperPolicyRecurrence `json:"recurrence,omitempty"`
}

type MapperPolicyRecurrence 

type MapperPolicyRecurrence struct {
	Frequency *FrequencyType `json:"frequency,omitempty"`
	Interval  *int64         `json:"interval,omitempty"`
}

type MapperSourceConnectionsInfo 

type MapperSourceConnectionsInfo struct {
	Connection     *MapperConnection `json:"connection,omitempty"`
	SourceEntities *[]MapperTable    `json:"sourceEntities,omitempty"`
}

type MapperTable 

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

type MapperTableProperties 

type MapperTableProperties struct {
	DslConnectorProperties *[]MapperDslConnectorProperties `json:"dslConnectorProperties,omitempty"`
	Schema                 *[]MapperTableSchema            `json:"schema,omitempty"`
}

type MapperTableSchema 

type MapperTableSchema struct {
	DataType *string `json:"dataType,omitempty"`
	Name     *string `json:"name,omitempty"`
}

type MapperTargetConnectionsInfo 

type MapperTargetConnectionsInfo struct {
	Connection         *MapperConnection    `json:"connection,omitempty"`
	DataMapperMappings *[]DataMapperMapping `json:"dataMapperMappings,omitempty"`
	Relationships      *[]interface{}       `json:"relationships,omitempty"`
	TargetEntities     *[]MapperTable       `json:"targetEntities,omitempty"`
}

type MappingType 

type MappingType string
const (
	MappingTypeAggregate MappingType = "Aggregate"
	MappingTypeDerived   MappingType = "Derived"
	MappingTypeDirect    MappingType = "Direct"
)

func (*MappingType) UnmarshalJSON 

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

type StartOperationResponse 

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

type StatusOperationResponse 

type StatusOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *string
}

type StopOperationResponse 

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

type Type 

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

func (*Type) UnmarshalJSON 

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