trigger

package
v0.20241104.1140654 Latest Latest
Warning

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

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

README

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

The trigger SDK allows for interaction with Azure Resource Manager 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", "factoryName", "triggerName")

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

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForPipelineReferenceType added in v0.20241009.1142232 

func PossibleValuesForPipelineReferenceType() []string

func PossibleValuesForTriggerReferenceType added in v0.20241009.1142232 

func PossibleValuesForTriggerReferenceType() []string

func PossibleValuesForTriggerRuntimeState 

func PossibleValuesForTriggerRuntimeState() []string

func PossibleValuesForTumblingWindowFrequency added in v0.20241009.1142232 

func PossibleValuesForTumblingWindowFrequency() []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 BaseDependencyReferenceImpl added in v0.20241009.1142232 

type BaseDependencyReferenceImpl struct {
	Type string `json:"type"`
}

func (BaseDependencyReferenceImpl) DependencyReference added in v0.20241009.1142232 

func (s BaseDependencyReferenceImpl) DependencyReference() BaseDependencyReferenceImpl

type BaseTriggerImpl added in v0.20241009.1142232 

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

func (BaseTriggerImpl) Trigger added in v0.20241009.1142232 

func (s BaseTriggerImpl) Trigger() BaseTriggerImpl

type ChainingTrigger added in v0.20241009.1142232 

type ChainingTrigger struct {
	Pipeline       TriggerPipelineReference      `json:"pipeline"`
	TypeProperties ChainingTriggerTypeProperties `json:"typeProperties"`

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

func (ChainingTrigger) MarshalJSON added in v0.20241009.1142232 

func (s ChainingTrigger) MarshalJSON() ([]byte, error)

func (ChainingTrigger) Trigger added in v0.20241009.1142232 

func (s ChainingTrigger) Trigger() BaseTriggerImpl

type ChainingTriggerTypeProperties added in v0.20241009.1142232 

type ChainingTriggerTypeProperties struct {
	DependsOn    []PipelineReference `json:"dependsOn"`
	RunDimension string              `json:"runDimension"`
}

type DependencyReference added in v0.20241009.1142232 

type DependencyReference interface {
	DependencyReference() BaseDependencyReferenceImpl
}

func UnmarshalDependencyReferenceImplementation added in v0.20241009.1142232 

func UnmarshalDependencyReferenceImplementation(input []byte) (DependencyReference, 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        *TriggerResource
}

type MultiplePipelineTrigger added in v0.20241009.1142232 

type MultiplePipelineTrigger struct {
	Pipelines *[]TriggerPipelineReference `json:"pipelines,omitempty"`

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

func (MultiplePipelineTrigger) MarshalJSON added in v0.20241009.1142232 

func (s MultiplePipelineTrigger) MarshalJSON() ([]byte, error)

func (MultiplePipelineTrigger) Trigger added in v0.20241009.1142232 

func (s MultiplePipelineTrigger) Trigger() BaseTriggerImpl

type PipelineReference added in v0.20241009.1142232 

type PipelineReference struct {
	Name          *string               `json:"name,omitempty"`
	ReferenceName string                `json:"referenceName"`
	Type          PipelineReferenceType `json:"type"`
}

type PipelineReferenceType added in v0.20241009.1142232 

type PipelineReferenceType string
const (
	PipelineReferenceTypePipelineReference PipelineReferenceType = "PipelineReference"
)

func (*PipelineReferenceType) UnmarshalJSON added in v0.20241009.1142232 

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

type RawDependencyReferenceImpl added in v0.20241009.1142232 

type RawDependencyReferenceImpl struct {
	Type   string
	Values map[string]interface{}
	// contains filtered or unexported fields
}

RawDependencyReferenceImpl is returned when the Discriminated Value doesn't match any of the defined types NOTE: this should only be used when a type isn't defined for this type of Object (as a workaround) and is used only for Deserialization (e.g. this cannot be used as a Request Payload).

func (RawDependencyReferenceImpl) DependencyReference added in v0.20241009.1142232 

func (s RawDependencyReferenceImpl) DependencyReference() BaseDependencyReferenceImpl

type RawTriggerImpl added in v0.20241009.1142232 

type RawTriggerImpl struct {
	Type   string
	Values map[string]interface{}
	// contains filtered or unexported fields
}

RawTriggerImpl is returned when the Discriminated Value doesn't match any of the defined types NOTE: this should only be used when a type isn't defined for this type of Object (as a workaround) and is used only for Deserialization (e.g. this cannot be used as a Request Payload).

func (RawTriggerImpl) Trigger added in v0.20241009.1142232 

func (s RawTriggerImpl) Trigger() BaseTriggerImpl

type RerunTumblingWindowTrigger added in v0.20241009.1142232 

type RerunTumblingWindowTrigger struct {
	TypeProperties RerunTumblingWindowTriggerTypeProperties `json:"typeProperties"`

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

func (RerunTumblingWindowTrigger) MarshalJSON added in v0.20241009.1142232 

func (s RerunTumblingWindowTrigger) MarshalJSON() ([]byte, error)

func (RerunTumblingWindowTrigger) Trigger added in v0.20241009.1142232 

func (s RerunTumblingWindowTrigger) Trigger() BaseTriggerImpl

type RerunTumblingWindowTriggerTypeProperties added in v0.20241009.1142232 

type RerunTumblingWindowTriggerTypeProperties struct {
	ParentTrigger      interface{} `json:"parentTrigger"`
	RequestedEndTime   string      `json:"requestedEndTime"`
	RequestedStartTime string      `json:"requestedStartTime"`
	RerunConcurrency   int64       `json:"rerunConcurrency"`
}

func (*RerunTumblingWindowTriggerTypeProperties) GetRequestedEndTimeAsTime added in v0.20241009.1142232 

func (o *RerunTumblingWindowTriggerTypeProperties) GetRequestedEndTimeAsTime() (*time.Time, error)

func (*RerunTumblingWindowTriggerTypeProperties) GetRequestedStartTimeAsTime added in v0.20241009.1142232 

func (o *RerunTumblingWindowTriggerTypeProperties) GetRequestedStartTimeAsTime() (*time.Time, error)

func (*RerunTumblingWindowTriggerTypeProperties) SetRequestedEndTimeAsTime added in v0.20241009.1142232 

func (o *RerunTumblingWindowTriggerTypeProperties) SetRequestedEndTimeAsTime(input time.Time)

func (*RerunTumblingWindowTriggerTypeProperties) SetRequestedStartTimeAsTime added in v0.20241009.1142232 

func (o *RerunTumblingWindowTriggerTypeProperties) SetRequestedStartTimeAsTime(input time.Time)

type RetryPolicy added in v0.20241009.1142232 

type RetryPolicy struct {
	Count             *int64 `json:"count,omitempty"`
	IntervalInSeconds *int64 `json:"intervalInSeconds,omitempty"`
}

type SelfDependencyTumblingWindowTriggerReference added in v0.20241009.1142232 

type SelfDependencyTumblingWindowTriggerReference struct {
	Offset string  `json:"offset"`
	Size   *string `json:"size,omitempty"`

	Type string `json:"type"`
}

func (SelfDependencyTumblingWindowTriggerReference) DependencyReference added in v0.20241009.1142232 

func (s SelfDependencyTumblingWindowTriggerReference) DependencyReference() BaseDependencyReferenceImpl

func (SelfDependencyTumblingWindowTriggerReference) MarshalJSON added in v0.20241009.1142232 

func (s SelfDependencyTumblingWindowTriggerReference) MarshalJSON() ([]byte, error)

type Trigger 

type Trigger interface {
	Trigger() BaseTriggerImpl
}

func UnmarshalTriggerImplementation added in v0.20241009.1142232 

func UnmarshalTriggerImplementation(input []byte) (Trigger, error)

type TriggerClient 

type TriggerClient struct {
	Client *resourcemanager.Client
}

func NewTriggerClientWithBaseURI 

func NewTriggerClientWithBaseURI(sdkApi sdkEnv.Api) (*TriggerClient, error)

func (TriggerClient) Get 

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

Get ...

type TriggerDependencyReference added in v0.20241009.1142232 

type TriggerDependencyReference struct {
	ReferenceTrigger TriggerReference `json:"referenceTrigger"`

	Type string `json:"type"`
}

func (TriggerDependencyReference) DependencyReference added in v0.20241009.1142232 

func (s TriggerDependencyReference) DependencyReference() BaseDependencyReferenceImpl

func (TriggerDependencyReference) MarshalJSON added in v0.20241009.1142232 

func (s TriggerDependencyReference) MarshalJSON() ([]byte, error)

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

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

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 TriggerPipelineReference added in v0.20241009.1142232 

type TriggerPipelineReference struct {
	Parameters        *map[string]interface{} `json:"parameters,omitempty"`
	PipelineReference *PipelineReference      `json:"pipelineReference,omitempty"`
}

type TriggerReference added in v0.20241009.1142232 

type TriggerReference struct {
	ReferenceName string               `json:"referenceName"`
	Type          TriggerReferenceType `json:"type"`
}

type TriggerReferenceType added in v0.20241009.1142232 

type TriggerReferenceType string
const (
	TriggerReferenceTypeTriggerReference TriggerReferenceType = "TriggerReference"
)

func (*TriggerReferenceType) UnmarshalJSON added in v0.20241009.1142232 

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

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"`
}

func (*TriggerResource) UnmarshalJSON added in v0.20241009.1142232 

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

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

type TumblingWindowFrequency added in v0.20241009.1142232 

type TumblingWindowFrequency string
const (
	TumblingWindowFrequencyHour   TumblingWindowFrequency = "Hour"
	TumblingWindowFrequencyMinute TumblingWindowFrequency = "Minute"
	TumblingWindowFrequencyMonth  TumblingWindowFrequency = "Month"
)

func (*TumblingWindowFrequency) UnmarshalJSON added in v0.20241009.1142232 

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

type TumblingWindowTrigger added in v0.20241009.1142232 

type TumblingWindowTrigger struct {
	Pipeline       TriggerPipelineReference            `json:"pipeline"`
	TypeProperties TumblingWindowTriggerTypeProperties `json:"typeProperties"`

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

func (TumblingWindowTrigger) MarshalJSON added in v0.20241009.1142232 

func (s TumblingWindowTrigger) MarshalJSON() ([]byte, error)

func (TumblingWindowTrigger) Trigger added in v0.20241009.1142232 

func (s TumblingWindowTrigger) Trigger() BaseTriggerImpl

type TumblingWindowTriggerTypeProperties added in v0.20241009.1142232 

type TumblingWindowTriggerTypeProperties struct {
	Delay          *string                 `json:"delay,omitempty"`
	DependsOn      *[]DependencyReference  `json:"dependsOn,omitempty"`
	EndTime        *string                 `json:"endTime,omitempty"`
	Frequency      TumblingWindowFrequency `json:"frequency"`
	Interval       int64                   `json:"interval"`
	MaxConcurrency int64                   `json:"maxConcurrency"`
	RetryPolicy    *RetryPolicy            `json:"retryPolicy,omitempty"`
	StartTime      string                  `json:"startTime"`
}

func (*TumblingWindowTriggerTypeProperties) GetEndTimeAsTime added in v0.20241009.1142232 

func (o *TumblingWindowTriggerTypeProperties) GetEndTimeAsTime() (*time.Time, error)

func (*TumblingWindowTriggerTypeProperties) GetStartTimeAsTime added in v0.20241009.1142232 

func (o *TumblingWindowTriggerTypeProperties) GetStartTimeAsTime() (*time.Time, error)

func (*TumblingWindowTriggerTypeProperties) SetEndTimeAsTime added in v0.20241009.1142232 

func (o *TumblingWindowTriggerTypeProperties) SetEndTimeAsTime(input time.Time)

func (*TumblingWindowTriggerTypeProperties) SetStartTimeAsTime added in v0.20241009.1142232 

func (o *TumblingWindowTriggerTypeProperties) SetStartTimeAsTime(input time.Time)

func (*TumblingWindowTriggerTypeProperties) UnmarshalJSON added in v0.20241009.1142232 

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