trigger

README

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

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

Client Initialization

client := trigger.NewTriggerClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: TriggerClient.Get

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

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

Documentation

Index

• func PossibleValuesForTriggerRuntimeState() []string
• func ValidateTriggerID(input interface{}, key string) (warnings []string, errors []error)
• type GetOperationOptions
  • func DefaultGetOperationOptions() GetOperationOptions
  • func (o GetOperationOptions) ToHeaders() *client.Headers
  • func (o GetOperationOptions) ToOData() *odata.Query
  • func (o GetOperationOptions) ToQuery() *client.QueryParams
• type GetOperationResponse
• type Trigger
• type TriggerClient
  • func NewTriggerClientWithBaseURI(api environments.Api) (*TriggerClient, error)
  • func (c TriggerClient) Get(ctx context.Context, id TriggerId, options GetOperationOptions) (result GetOperationResponse, err error)
• type TriggerId
  • func NewTriggerID(subscriptionId string, resourceGroupName string, factoryName string, ...) TriggerId
  • func ParseTriggerID(input string) (*TriggerId, error)
  • func ParseTriggerIDInsensitively(input string) (*TriggerId, error)
  • func (id TriggerId) ID() string
  • func (id TriggerId) Segments() []resourceids.Segment
  • func (id TriggerId) String() string
• type TriggerResource
• type TriggerRuntimeState
  • func (s *TriggerRuntimeState) UnmarshalJSON(bytes []byte) error

Functions

func PossibleValuesForTriggerRuntimeState

func PossibleValuesForTriggerRuntimeState() []string

func ValidateTriggerID

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

ValidateTriggerID checks that 'input' can be parsed as a Trigger ID

Types

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

type Trigger

type Trigger struct {
	Annotations  *[]interface{}       `json:"annotations,omitempty"`
	Description  *string              `json:"description,omitempty"`
	RuntimeState *TriggerRuntimeState `json:"runtimeState,omitempty"`
	Type         string               `json:"type"`
}

type TriggerClient

type TriggerClient struct {
	Client *resourcemanager.Client
}

func NewTriggerClientWithBaseURI

func NewTriggerClientWithBaseURI(api environments.Api) (*TriggerClient, error)

func (TriggerClient) Get

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

Get ...

type TriggerId

type TriggerId struct {
	SubscriptionId    string
	ResourceGroupName string
	FactoryName       string
	TriggerName       string
}

TriggerId is a struct representing the Resource ID for a Trigger

func NewTriggerID

func NewTriggerID(subscriptionId string, resourceGroupName string, factoryName string, triggerName string) TriggerId

NewTriggerID returns a new TriggerId struct

func ParseTriggerID

func ParseTriggerID(input string) (*TriggerId, error)

ParseTriggerID parses 'input' into a TriggerId

func ParseTriggerIDInsensitively

func ParseTriggerIDInsensitively(input string) (*TriggerId, error)

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

func (TriggerId) ID

func (id TriggerId) ID() string

ID returns the formatted Trigger ID

func (TriggerId) Segments

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

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

func (TriggerId) String

func (id TriggerId) String() string

String returns a human-readable description of this Trigger ID

type TriggerResource

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

type TriggerRuntimeState

type TriggerRuntimeState string

const (
	TriggerRuntimeStateDisabled TriggerRuntimeState = "Disabled"
	TriggerRuntimeStateStarted  TriggerRuntimeState = "Started"
	TriggerRuntimeStateStopped  TriggerRuntimeState = "Stopped"
)

func (*TriggerRuntimeState) UnmarshalJSON

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