integrationruntimeobjectmetadata

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: 11 Imported by: 1

README

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

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

Client Initialization

client := integrationruntimeobjectmetadata.NewIntegrationRuntimeObjectMetadataClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: IntegrationRuntimeObjectMetadataClient.Get

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

payload := integrationruntimeobjectmetadata.GetSsisObjectMetadataRequest{
	// ...
}


// alternatively `client.Get(ctx, id, payload)` can be used to do batched pagination
items, err := client.GetComplete(ctx, id, payload)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: IntegrationRuntimeObjectMetadataClient.Refresh

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

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForSsisObjectMetadataType 

func PossibleValuesForSsisObjectMetadataType() []string

func ValidateIntegrationRuntimeID 

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

ValidateIntegrationRuntimeID checks that 'input' can be parsed as a Integration Runtime ID

Types

type GetCompleteResult added in v0.20240227.1172434 

type GetCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []SsisObjectMetadata
}

type GetOperationResponse 

type GetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]SsisObjectMetadata
}

type GetSsisObjectMetadataRequest 

type GetSsisObjectMetadataRequest struct {
	MetadataPath *string `json:"metadataPath,omitempty"`
}

type IntegrationRuntimeId 

type IntegrationRuntimeId struct {
	SubscriptionId         string
	ResourceGroupName      string
	FactoryName            string
	IntegrationRuntimeName string
}

IntegrationRuntimeId is a struct representing the Resource ID for a Integration Runtime

func NewIntegrationRuntimeID 

func NewIntegrationRuntimeID(subscriptionId string, resourceGroupName string, factoryName string, integrationRuntimeName string) IntegrationRuntimeId

NewIntegrationRuntimeID returns a new IntegrationRuntimeId struct

func ParseIntegrationRuntimeID 

func ParseIntegrationRuntimeID(input string) (*IntegrationRuntimeId, error)

ParseIntegrationRuntimeID parses 'input' into a IntegrationRuntimeId

func ParseIntegrationRuntimeIDInsensitively 

func ParseIntegrationRuntimeIDInsensitively(input string) (*IntegrationRuntimeId, error)

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

func (*IntegrationRuntimeId) FromParseResult 

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

func (IntegrationRuntimeId) ID 

func (id IntegrationRuntimeId) ID() string

ID returns the formatted Integration Runtime ID

func (IntegrationRuntimeId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Integration Runtime ID

func (IntegrationRuntimeId) String 

func (id IntegrationRuntimeId) String() string

String returns a human-readable description of this Integration Runtime ID

type IntegrationRuntimeObjectMetadataClient 

type IntegrationRuntimeObjectMetadataClient struct {
	Client *resourcemanager.Client
}

func NewIntegrationRuntimeObjectMetadataClientWithBaseURI 

func NewIntegrationRuntimeObjectMetadataClientWithBaseURI(sdkApi sdkEnv.Api) (*IntegrationRuntimeObjectMetadataClient, error)

func (IntegrationRuntimeObjectMetadataClient) Get 

func (c IntegrationRuntimeObjectMetadataClient) Get(ctx context.Context, id IntegrationRuntimeId, input GetSsisObjectMetadataRequest) (result GetOperationResponse, err error)

Get ...

func (IntegrationRuntimeObjectMetadataClient) GetComplete added in v0.20240227.1172434 

func (c IntegrationRuntimeObjectMetadataClient) GetComplete(ctx context.Context, id IntegrationRuntimeId, input GetSsisObjectMetadataRequest) (GetCompleteResult, error)

GetComplete retrieves all the results into a single object

func (IntegrationRuntimeObjectMetadataClient) GetCompleteMatchingPredicate added in v0.20240227.1172434 

func (c IntegrationRuntimeObjectMetadataClient) GetCompleteMatchingPredicate(ctx context.Context, id IntegrationRuntimeId, input GetSsisObjectMetadataRequest, predicate SsisObjectMetadataOperationPredicate) (result GetCompleteResult, err error)

GetCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (IntegrationRuntimeObjectMetadataClient) Refresh 

func (c IntegrationRuntimeObjectMetadataClient) Refresh(ctx context.Context, id IntegrationRuntimeId) (result RefreshOperationResponse, err error)

Refresh ...

func (IntegrationRuntimeObjectMetadataClient) RefreshThenPoll 

func (c IntegrationRuntimeObjectMetadataClient) RefreshThenPoll(ctx context.Context, id IntegrationRuntimeId) error

RefreshThenPoll performs Refresh then polls until it's completed

type RefreshOperationResponse 

type RefreshOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *SsisObjectMetadataStatusResponse
}

type SsisObjectMetadata 

type SsisObjectMetadata struct {
	Description *string                `json:"description,omitempty"`
	Id          *int64                 `json:"id,omitempty"`
	Name        *string                `json:"name,omitempty"`
	Type        SsisObjectMetadataType `json:"type"`
}

type SsisObjectMetadataOperationPredicate added in v0.20240227.1172434 

type SsisObjectMetadataOperationPredicate struct {
	Description *string
	Id          *int64
	Name        *string
}

func (SsisObjectMetadataOperationPredicate) Matches added in v0.20240227.1172434 

func (p SsisObjectMetadataOperationPredicate) Matches(input SsisObjectMetadata) bool

type SsisObjectMetadataStatusResponse 

type SsisObjectMetadataStatusResponse struct {
	Error      *string `json:"error,omitempty"`
	Name       *string `json:"name,omitempty"`
	Properties *string `json:"properties,omitempty"`
	Status     *string `json:"status,omitempty"`
}

type SsisObjectMetadataType 

type SsisObjectMetadataType string
const (
	SsisObjectMetadataTypeEnvironment SsisObjectMetadataType = "Environment"
	SsisObjectMetadataTypeFolder      SsisObjectMetadataType = "Folder"
	SsisObjectMetadataTypePackage     SsisObjectMetadataType = "Package"
	SsisObjectMetadataTypeProject     SsisObjectMetadataType = "Project"
)

func (*SsisObjectMetadataType) UnmarshalJSON 

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