functions

package
v0.20240903.1111904 Latest Latest
Warning

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

Go to latest
Published: Sep 3, 2024 License: MPL-2.0 Imports: 11 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/streamanalytics/2021-10-01-preview/functions Documentation

The functions SDK allows for interaction with the Azure Resource Manager Service streamanalytics (API Version 2021-10-01-preview).

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/streamanalytics/2021-10-01-preview/functions"

Client Initialization

client := functions.NewFunctionsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: FunctionsClient.CreateOrReplace

ctx := context.TODO()
id := functions.NewFunctionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "streamingJobValue", "functionValue")

payload := functions.Function{
	// ...
}


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

Example Usage: FunctionsClient.Delete

ctx := context.TODO()
id := functions.NewFunctionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "streamingJobValue", "functionValue")

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

ctx := context.TODO()
id := functions.NewFunctionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "streamingJobValue", "functionValue")

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

Example Usage: FunctionsClient.ListByStreamingJob

ctx := context.TODO()
id := functions.NewStreamingJobID("12345678-1234-9876-4563-123456789012", "example-resource-group", "streamingJobValue")

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

Example Usage: FunctionsClient.RetrieveDefaultDefinition

ctx := context.TODO()
id := functions.NewFunctionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "streamingJobValue", "functionValue")

payload := functions.FunctionRetrieveDefaultDefinitionParameters{
	// ...
}


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

Example Usage: FunctionsClient.Test

ctx := context.TODO()
id := functions.NewFunctionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "streamingJobValue", "functionValue")

payload := functions.Function{
	// ...
}


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

Example Usage: FunctionsClient.Update

ctx := context.TODO()
id := functions.NewFunctionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "streamingJobValue", "functionValue")

payload := functions.Function{
	// ...
}


read, err := client.Update(ctx, id, payload, functions.DefaultUpdateOperationOptions())
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 PossibleValuesForUdfType

func PossibleValuesForUdfType() []string

func PossibleValuesForUpdateMode

func PossibleValuesForUpdateMode() []string

func ValidateFunctionID

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

ValidateFunctionID checks that 'input' can be parsed as a Function ID

func ValidateStreamingJobID

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

ValidateStreamingJobID checks that 'input' can be parsed as a Streaming Job ID

Types

type AggregateFunctionProperties

type AggregateFunctionProperties struct {

	// Fields inherited from FunctionProperties
	Etag       *string                `json:"etag,omitempty"`
	Properties *FunctionConfiguration `json:"properties,omitempty"`
}

func (AggregateFunctionProperties) MarshalJSON

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

type AzureMachineLearningServiceFunctionBinding

type AzureMachineLearningServiceFunctionBinding struct {
	Properties *AzureMachineLearningServiceFunctionBindingProperties `json:"properties,omitempty"`
}

func (AzureMachineLearningServiceFunctionBinding) MarshalJSON

type AzureMachineLearningServiceFunctionBindingProperties

type AzureMachineLearningServiceFunctionBindingProperties struct {
	ApiKey                   *string                                    `json:"apiKey,omitempty"`
	BatchSize                *int64                                     `json:"batchSize,omitempty"`
	Endpoint                 *string                                    `json:"endpoint,omitempty"`
	InputRequestName         *string                                    `json:"inputRequestName,omitempty"`
	Inputs                   *[]AzureMachineLearningServiceInputColumn  `json:"inputs,omitempty"`
	NumberOfParallelRequests *int64                                     `json:"numberOfParallelRequests,omitempty"`
	OutputResponseName       *string                                    `json:"outputResponseName,omitempty"`
	Outputs                  *[]AzureMachineLearningServiceOutputColumn `json:"outputs,omitempty"`
}

type AzureMachineLearningServiceFunctionBindingRetrievalProperties

type AzureMachineLearningServiceFunctionBindingRetrievalProperties struct {
	ExecuteEndpoint *string  `json:"executeEndpoint,omitempty"`
	UdfType         *UdfType `json:"udfType,omitempty"`
}

type AzureMachineLearningServiceFunctionRetrieveDefaultDefinitionParameters

type AzureMachineLearningServiceFunctionRetrieveDefaultDefinitionParameters struct {
	BindingRetrievalProperties *AzureMachineLearningServiceFunctionBindingRetrievalProperties `json:"bindingRetrievalProperties,omitempty"`
}

func (AzureMachineLearningServiceFunctionRetrieveDefaultDefinitionParameters) MarshalJSON

type AzureMachineLearningServiceInputColumn

type AzureMachineLearningServiceInputColumn struct {
	DataType *string `json:"dataType,omitempty"`
	MapTo    *int64  `json:"mapTo,omitempty"`
	Name     *string `json:"name,omitempty"`
}

type AzureMachineLearningServiceOutputColumn

type AzureMachineLearningServiceOutputColumn struct {
	DataType *string `json:"dataType,omitempty"`
	MapTo    *int64  `json:"mapTo,omitempty"`
	Name     *string `json:"name,omitempty"`
}

type AzureMachineLearningStudioFunctionBinding

type AzureMachineLearningStudioFunctionBinding struct {
	Properties *AzureMachineLearningStudioFunctionBindingProperties `json:"properties,omitempty"`
}

func (AzureMachineLearningStudioFunctionBinding) MarshalJSON

type AzureMachineLearningStudioFunctionBindingProperties

type AzureMachineLearningStudioFunctionBindingProperties struct {
	ApiKey    *string                                   `json:"apiKey,omitempty"`
	BatchSize *int64                                    `json:"batchSize,omitempty"`
	Endpoint  *string                                   `json:"endpoint,omitempty"`
	Inputs    *AzureMachineLearningStudioInputs         `json:"inputs,omitempty"`
	Outputs   *[]AzureMachineLearningStudioOutputColumn `json:"outputs,omitempty"`
}

type AzureMachineLearningStudioFunctionBindingRetrievalProperties

type AzureMachineLearningStudioFunctionBindingRetrievalProperties struct {
	ExecuteEndpoint *string  `json:"executeEndpoint,omitempty"`
	UdfType         *UdfType `json:"udfType,omitempty"`
}

type AzureMachineLearningStudioFunctionRetrieveDefaultDefinitionParameters

type AzureMachineLearningStudioFunctionRetrieveDefaultDefinitionParameters struct {
	BindingRetrievalProperties *AzureMachineLearningStudioFunctionBindingRetrievalProperties `json:"bindingRetrievalProperties,omitempty"`
}

func (AzureMachineLearningStudioFunctionRetrieveDefaultDefinitionParameters) MarshalJSON

type AzureMachineLearningStudioInputColumn

type AzureMachineLearningStudioInputColumn struct {
	DataType *string `json:"dataType,omitempty"`
	MapTo    *int64  `json:"mapTo,omitempty"`
	Name     *string `json:"name,omitempty"`
}

type AzureMachineLearningStudioInputs

type AzureMachineLearningStudioInputs struct {
	ColumnNames *[]AzureMachineLearningStudioInputColumn `json:"columnNames,omitempty"`
	Name        *string                                  `json:"name,omitempty"`
}

type AzureMachineLearningStudioOutputColumn

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

type CSharpFunctionBinding

type CSharpFunctionBinding struct {
	Properties *CSharpFunctionBindingProperties `json:"properties,omitempty"`
}

func (CSharpFunctionBinding) MarshalJSON

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

type CSharpFunctionBindingProperties

type CSharpFunctionBindingProperties struct {
	Class      *string     `json:"class,omitempty"`
	DllPath    *string     `json:"dllPath,omitempty"`
	Method     *string     `json:"method,omitempty"`
	UpdateMode *UpdateMode `json:"updateMode,omitempty"`
}

type CSharpFunctionBindingRetrievalProperties

type CSharpFunctionBindingRetrievalProperties struct {
	Script  *string  `json:"script,omitempty"`
	UdfType *UdfType `json:"udfType,omitempty"`
}

type CSharpFunctionRetrieveDefaultDefinitionParameters

type CSharpFunctionRetrieveDefaultDefinitionParameters struct {
	BindingRetrievalProperties *CSharpFunctionBindingRetrievalProperties `json:"bindingRetrievalProperties,omitempty"`
}

func (CSharpFunctionRetrieveDefaultDefinitionParameters) MarshalJSON

type CreateOrReplaceOperationOptions

type CreateOrReplaceOperationOptions struct {
	IfMatch     *string
	IfNoneMatch *string
}

func DefaultCreateOrReplaceOperationOptions

func DefaultCreateOrReplaceOperationOptions() CreateOrReplaceOperationOptions

func (CreateOrReplaceOperationOptions) ToHeaders added in v0.20240208.1095436

func (CreateOrReplaceOperationOptions) ToOData added in v0.20240208.1095436

func (CreateOrReplaceOperationOptions) ToQuery added in v0.20240208.1095436

type CreateOrReplaceOperationResponse

type CreateOrReplaceOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Function
}

type DeleteOperationResponse

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

type ErrorResponse

type ErrorResponse struct {
	Code    *string `json:"code,omitempty"`
	Message *string `json:"message,omitempty"`
}

type Function

type Function struct {
	Id         *string            `json:"id,omitempty"`
	Name       *string            `json:"name,omitempty"`
	Properties FunctionProperties `json:"properties"`
	Type       *string            `json:"type,omitempty"`
}

func (*Function) UnmarshalJSON

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

type FunctionBinding

type FunctionBinding interface {
}

type FunctionConfiguration

type FunctionConfiguration struct {
	Binding FunctionBinding  `json:"binding"`
	Inputs  *[]FunctionInput `json:"inputs,omitempty"`
	Output  *FunctionOutput  `json:"output,omitempty"`
}

func (*FunctionConfiguration) UnmarshalJSON

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

type FunctionId

type FunctionId struct {
	SubscriptionId    string
	ResourceGroupName string
	StreamingJobName  string
	FunctionName      string
}

FunctionId is a struct representing the Resource ID for a Function

func NewFunctionID

func NewFunctionID(subscriptionId string, resourceGroupName string, streamingJobName string, functionName string) FunctionId

NewFunctionID returns a new FunctionId struct

func ParseFunctionID

func ParseFunctionID(input string) (*FunctionId, error)

ParseFunctionID parses 'input' into a FunctionId

func ParseFunctionIDInsensitively

func ParseFunctionIDInsensitively(input string) (*FunctionId, error)

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

func (*FunctionId) FromParseResult

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

func (FunctionId) ID

func (id FunctionId) ID() string

ID returns the formatted Function ID

func (FunctionId) Segments

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

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

func (FunctionId) String

func (id FunctionId) String() string

String returns a human-readable description of this Function ID

type FunctionInput

type FunctionInput struct {
	DataType                 *string `json:"dataType,omitempty"`
	IsConfigurationParameter *bool   `json:"isConfigurationParameter,omitempty"`
}

type FunctionOperationPredicate

type FunctionOperationPredicate struct {
	Id   *string
	Name *string
	Type *string
}

func (FunctionOperationPredicate) Matches

func (p FunctionOperationPredicate) Matches(input Function) bool

type FunctionOutput

type FunctionOutput struct {
	DataType *string `json:"dataType,omitempty"`
}

type FunctionProperties

type FunctionProperties interface {
}

type FunctionRetrieveDefaultDefinitionParameters

type FunctionRetrieveDefaultDefinitionParameters interface {
}

type FunctionsClient

type FunctionsClient struct {
	Client *resourcemanager.Client
}

func NewFunctionsClientWithBaseURI

func NewFunctionsClientWithBaseURI(sdkApi sdkEnv.Api) (*FunctionsClient, error)

func (FunctionsClient) CreateOrReplace

CreateOrReplace ...

func (FunctionsClient) Delete

func (c FunctionsClient) Delete(ctx context.Context, id FunctionId) (result DeleteOperationResponse, err error)

Delete ...

func (FunctionsClient) Get

func (c FunctionsClient) Get(ctx context.Context, id FunctionId) (result GetOperationResponse, err error)

Get ...

func (FunctionsClient) ListByStreamingJob

ListByStreamingJob ...

func (FunctionsClient) ListByStreamingJobComplete

ListByStreamingJobComplete retrieves all the results into a single object

func (FunctionsClient) ListByStreamingJobCompleteMatchingPredicate

func (c FunctionsClient) ListByStreamingJobCompleteMatchingPredicate(ctx context.Context, id StreamingJobId, options ListByStreamingJobOperationOptions, predicate FunctionOperationPredicate) (result ListByStreamingJobCompleteResult, err error)

ListByStreamingJobCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (FunctionsClient) RetrieveDefaultDefinition

RetrieveDefaultDefinition ...

func (FunctionsClient) Update

Update ...

type GetOperationResponse

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

type JavaScriptFunctionBinding

type JavaScriptFunctionBinding struct {
	Properties *JavaScriptFunctionBindingProperties `json:"properties,omitempty"`
}

func (JavaScriptFunctionBinding) MarshalJSON

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

type JavaScriptFunctionBindingProperties

type JavaScriptFunctionBindingProperties struct {
	Script *string `json:"script,omitempty"`
}

type JavaScriptFunctionBindingRetrievalProperties

type JavaScriptFunctionBindingRetrievalProperties struct {
	Script  *string  `json:"script,omitempty"`
	UdfType *UdfType `json:"udfType,omitempty"`
}

type JavaScriptFunctionRetrieveDefaultDefinitionParameters

type JavaScriptFunctionRetrieveDefaultDefinitionParameters struct {
	BindingRetrievalProperties *JavaScriptFunctionBindingRetrievalProperties `json:"bindingRetrievalProperties,omitempty"`
}

func (JavaScriptFunctionRetrieveDefaultDefinitionParameters) MarshalJSON

type ListByStreamingJobCompleteResult

type ListByStreamingJobCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []Function
}

type ListByStreamingJobCustomPager added in v0.20240628.1153531

type ListByStreamingJobCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ListByStreamingJobCustomPager) NextPageLink() *odata.Link

type ListByStreamingJobOperationOptions

type ListByStreamingJobOperationOptions struct {
	Select *string
}

func DefaultListByStreamingJobOperationOptions

func DefaultListByStreamingJobOperationOptions() ListByStreamingJobOperationOptions

func (ListByStreamingJobOperationOptions) ToHeaders added in v0.20240208.1095436

func (ListByStreamingJobOperationOptions) ToOData added in v0.20240208.1095436

func (ListByStreamingJobOperationOptions) ToQuery added in v0.20240208.1095436

type ListByStreamingJobOperationResponse

type ListByStreamingJobOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]Function
}

type RawFunctionBindingImpl

type RawFunctionBindingImpl struct {
	Type   string
	Values map[string]interface{}
}

RawFunctionBindingImpl 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).

type RawFunctionPropertiesImpl

type RawFunctionPropertiesImpl struct {
	Type   string
	Values map[string]interface{}
}

RawFunctionPropertiesImpl 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).

type RawFunctionRetrieveDefaultDefinitionParametersImpl

type RawFunctionRetrieveDefaultDefinitionParametersImpl struct {
	Type   string
	Values map[string]interface{}
}

RawFunctionRetrieveDefaultDefinitionParametersImpl 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).

type ResourceTestStatus

type ResourceTestStatus struct {
	Error  *ErrorResponse `json:"error,omitempty"`
	Status *string        `json:"status,omitempty"`
}

type RetrieveDefaultDefinitionOperationResponse

type RetrieveDefaultDefinitionOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Function
}

type ScalarFunctionProperties

type ScalarFunctionProperties struct {

	// Fields inherited from FunctionProperties
	Etag       *string                `json:"etag,omitempty"`
	Properties *FunctionConfiguration `json:"properties,omitempty"`
}

func (ScalarFunctionProperties) MarshalJSON

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

type StreamingJobId

type StreamingJobId struct {
	SubscriptionId    string
	ResourceGroupName string
	StreamingJobName  string
}

StreamingJobId is a struct representing the Resource ID for a Streaming Job

func NewStreamingJobID

func NewStreamingJobID(subscriptionId string, resourceGroupName string, streamingJobName string) StreamingJobId

NewStreamingJobID returns a new StreamingJobId struct

func ParseStreamingJobID

func ParseStreamingJobID(input string) (*StreamingJobId, error)

ParseStreamingJobID parses 'input' into a StreamingJobId

func ParseStreamingJobIDInsensitively

func ParseStreamingJobIDInsensitively(input string) (*StreamingJobId, error)

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

func (*StreamingJobId) FromParseResult

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

func (StreamingJobId) ID

func (id StreamingJobId) ID() string

ID returns the formatted Streaming Job ID

func (StreamingJobId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Streaming Job ID

func (StreamingJobId) String

func (id StreamingJobId) String() string

String returns a human-readable description of this Streaming Job ID

type UdfType

type UdfType string
const (
	UdfTypeScalar UdfType = "Scalar"
)

func (*UdfType) UnmarshalJSON added in v0.20240208.1095436

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

type UpdateMode

type UpdateMode string
const (
	UpdateModeRefreshable UpdateMode = "Refreshable"
	UpdateModeStatic      UpdateMode = "Static"
)

func (*UpdateMode) UnmarshalJSON added in v0.20240208.1095436

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

type UpdateOperationOptions

type UpdateOperationOptions struct {
	IfMatch *string
}

func DefaultUpdateOperationOptions

func DefaultUpdateOperationOptions() UpdateOperationOptions

func (UpdateOperationOptions) ToHeaders added in v0.20240208.1095436

func (o UpdateOperationOptions) ToHeaders() *client.Headers

func (UpdateOperationOptions) ToOData added in v0.20240208.1095436

func (o UpdateOperationOptions) ToOData() *odata.Query

func (UpdateOperationOptions) ToQuery added in v0.20240208.1095436

type UpdateOperationResponse

type UpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Function
}

Source Files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL