integrationruntimeobjectmetadata

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{
	// ...
}


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

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

• func PossibleValuesForSsisObjectMetadataType() []string
• func ValidateIntegrationRuntimeID(input interface{}, key string) (warnings []string, errors []error)
• type GetOperationResponse
• type GetSsisObjectMetadataRequest
• type IntegrationRuntimeId
  • func NewIntegrationRuntimeID(subscriptionId string, resourceGroupName string, factoryName string, ...) IntegrationRuntimeId
  • func ParseIntegrationRuntimeID(input string) (*IntegrationRuntimeId, error)
  • func ParseIntegrationRuntimeIDInsensitively(input string) (*IntegrationRuntimeId, error)
  • func (id IntegrationRuntimeId) ID() string
  • func (id IntegrationRuntimeId) Segments() []resourceids.Segment
  • func (id IntegrationRuntimeId) String() string
• type IntegrationRuntimeObjectMetadataClient
  • func NewIntegrationRuntimeObjectMetadataClientWithBaseURI(sdkApi sdkEnv.Api) (*IntegrationRuntimeObjectMetadataClient, error)
  • func (c IntegrationRuntimeObjectMetadataClient) Get(ctx context.Context, id IntegrationRuntimeId, ...) (result GetOperationResponse, err error)
  • func (c IntegrationRuntimeObjectMetadataClient) Refresh(ctx context.Context, id IntegrationRuntimeId) (result RefreshOperationResponse, err error)
  • func (c IntegrationRuntimeObjectMetadataClient) RefreshThenPoll(ctx context.Context, id IntegrationRuntimeId) error
• type RefreshOperationResponse
• type SsisObjectMetadata
• type SsisObjectMetadataListResponse
• type SsisObjectMetadataStatusResponse
• type SsisObjectMetadataType
  • func (s *SsisObjectMetadataType) UnmarshalJSON(bytes []byte) error

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 GetOperationResponse

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

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) 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) 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
}

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 SsisObjectMetadataListResponse

type SsisObjectMetadataListResponse struct {
	NextLink *string               `json:"nextLink,omitempty"`
	Value    *[]SsisObjectMetadata `json:"value,omitempty"`
}

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