inputs

package
v0.20230118.1181553 Latest Latest
Warning

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

Go to latest
Published: Jan 18, 2023 License: MPL-2.0 Imports: 10 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/streamanalytics/2020-03-01/inputs Documentation

The inputs SDK allows for interaction with the Azure Resource Manager Service streamanalytics (API Version 2020-03-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/streamanalytics/2020-03-01/inputs"

Client Initialization

client := inputs.NewInputsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: InputsClient.CreateOrReplace

ctx := context.TODO()
id := inputs.NewInputID("12345678-1234-9876-4563-123456789012", "example-resource-group", "jobValue", "inputValue")

payload := inputs.Input{
	// ...
}


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

Example Usage: InputsClient.Delete

ctx := context.TODO()
id := inputs.NewInputID("12345678-1234-9876-4563-123456789012", "example-resource-group", "jobValue", "inputValue")

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

ctx := context.TODO()
id := inputs.NewInputID("12345678-1234-9876-4563-123456789012", "example-resource-group", "jobValue", "inputValue")

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: InputsClient.ListByStreamingJob

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

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

Example Usage: InputsClient.Test

ctx := context.TODO()
id := inputs.NewInputID("12345678-1234-9876-4563-123456789012", "example-resource-group", "jobValue", "inputValue")

payload := inputs.Input{
	// ...
}


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

Example Usage: InputsClient.Update

ctx := context.TODO()
id := inputs.NewInputID("12345678-1234-9876-4563-123456789012", "example-resource-group", "jobValue", "inputValue")

payload := inputs.Input{
	// ...
}


read, err := client.Update(ctx, id, payload, inputs.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 PossibleValuesForAuthenticationMode

func PossibleValuesForAuthenticationMode() []string

func PossibleValuesForCompressionType

func PossibleValuesForCompressionType() []string

func PossibleValuesForEncoding

func PossibleValuesForEncoding() []string

func PossibleValuesForEventSerializationType

func PossibleValuesForEventSerializationType() []string

func PossibleValuesForJsonOutputSerializationFormat

func PossibleValuesForJsonOutputSerializationFormat() []string

func PossibleValuesForRefreshType

func PossibleValuesForRefreshType() []string

func ValidateInputID

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

ValidateInputID checks that 'input' can be parsed as a Input 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 AuthenticationMode

type AuthenticationMode string
const (
	AuthenticationModeConnectionString AuthenticationMode = "ConnectionString"
	AuthenticationModeMsi              AuthenticationMode = "Msi"
	AuthenticationModeUserToken        AuthenticationMode = "UserToken"
)

type AvroSerialization

type AvroSerialization struct {
	Properties *interface{} `json:"properties,omitempty"`
}

func (AvroSerialization) MarshalJSON

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

type AzureSqlReferenceInputDataSource

type AzureSqlReferenceInputDataSource struct {
	Properties *AzureSqlReferenceInputDataSourceProperties `json:"properties,omitempty"`
}

func (AzureSqlReferenceInputDataSource) MarshalJSON

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

type AzureSqlReferenceInputDataSourceProperties

type AzureSqlReferenceInputDataSourceProperties struct {
	Database           *string      `json:"database,omitempty"`
	DeltaSnapshotQuery *string      `json:"deltaSnapshotQuery,omitempty"`
	FullSnapshotQuery  *string      `json:"fullSnapshotQuery,omitempty"`
	Password           *string      `json:"password,omitempty"`
	RefreshRate        *string      `json:"refreshRate,omitempty"`
	RefreshType        *RefreshType `json:"refreshType,omitempty"`
	Server             *string      `json:"server,omitempty"`
	Table              *string      `json:"table,omitempty"`
	User               *string      `json:"user,omitempty"`
}

type BlobDataSourceProperties

type BlobDataSourceProperties struct {
	AuthenticationMode *AuthenticationMode `json:"authenticationMode,omitempty"`
	Container          *string             `json:"container,omitempty"`
	DateFormat         *string             `json:"dateFormat,omitempty"`
	PathPattern        *string             `json:"pathPattern,omitempty"`
	StorageAccounts    *[]StorageAccount   `json:"storageAccounts,omitempty"`
	TimeFormat         *string             `json:"timeFormat,omitempty"`
}

type BlobReferenceInputDataSource

type BlobReferenceInputDataSource struct {
	Properties *BlobDataSourceProperties `json:"properties,omitempty"`
}

func (BlobReferenceInputDataSource) MarshalJSON

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

type BlobStreamInputDataSource

type BlobStreamInputDataSource struct {
	Properties *BlobStreamInputDataSourceProperties `json:"properties,omitempty"`
}

func (BlobStreamInputDataSource) MarshalJSON

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

type BlobStreamInputDataSourceProperties

type BlobStreamInputDataSourceProperties struct {
	AuthenticationMode   *AuthenticationMode `json:"authenticationMode,omitempty"`
	Container            *string             `json:"container,omitempty"`
	DateFormat           *string             `json:"dateFormat,omitempty"`
	PathPattern          *string             `json:"pathPattern,omitempty"`
	SourcePartitionCount *int64              `json:"sourcePartitionCount,omitempty"`
	StorageAccounts      *[]StorageAccount   `json:"storageAccounts,omitempty"`
	TimeFormat           *string             `json:"timeFormat,omitempty"`
}

type Compression

type Compression struct {
	Type CompressionType `json:"type"`
}

type CompressionType

type CompressionType string
const (
	CompressionTypeDeflate CompressionType = "Deflate"
	CompressionTypeGZip    CompressionType = "GZip"
	CompressionTypeNone    CompressionType = "None"
)

type CreateOrReplaceOperationOptions

type CreateOrReplaceOperationOptions struct {
	IfMatch     *string
	IfNoneMatch *string
}

func DefaultCreateOrReplaceOperationOptions

func DefaultCreateOrReplaceOperationOptions() CreateOrReplaceOperationOptions

type CreateOrReplaceOperationResponse

type CreateOrReplaceOperationResponse struct {
	HttpResponse *http.Response
	Model        *Input
}

type CsvSerialization

type CsvSerialization struct {
	Properties *CsvSerializationProperties `json:"properties,omitempty"`
}

func (CsvSerialization) MarshalJSON

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

type CsvSerializationProperties

type CsvSerializationProperties struct {
	Encoding       *Encoding `json:"encoding,omitempty"`
	FieldDelimiter *string   `json:"fieldDelimiter,omitempty"`
}

type DeleteOperationResponse

type DeleteOperationResponse struct {
	HttpResponse *http.Response
}

type DiagnosticCondition

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

type Diagnostics

type Diagnostics struct {
	Conditions *[]DiagnosticCondition `json:"conditions,omitempty"`
}

type Encoding

type Encoding string
const (
	EncodingUTFEight Encoding = "UTF8"
)

type ErrorResponse

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

type EventHubStreamInputDataSource

type EventHubStreamInputDataSource struct {
	Properties *EventHubStreamInputDataSourceProperties `json:"properties,omitempty"`
}

func (EventHubStreamInputDataSource) MarshalJSON

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

type EventHubStreamInputDataSourceProperties

type EventHubStreamInputDataSourceProperties struct {
	AuthenticationMode     *AuthenticationMode `json:"authenticationMode,omitempty"`
	ConsumerGroupName      *string             `json:"consumerGroupName,omitempty"`
	EventHubName           *string             `json:"eventHubName,omitempty"`
	ServiceBusNamespace    *string             `json:"serviceBusNamespace,omitempty"`
	SharedAccessPolicyKey  *string             `json:"sharedAccessPolicyKey,omitempty"`
	SharedAccessPolicyName *string             `json:"sharedAccessPolicyName,omitempty"`
}

type EventHubV2StreamInputDataSource

type EventHubV2StreamInputDataSource struct {
	Properties *EventHubStreamInputDataSourceProperties `json:"properties,omitempty"`
}

func (EventHubV2StreamInputDataSource) MarshalJSON

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

type EventSerializationType

type EventSerializationType string
const (
	EventSerializationTypeAvro    EventSerializationType = "Avro"
	EventSerializationTypeCsv     EventSerializationType = "Csv"
	EventSerializationTypeJson    EventSerializationType = "Json"
	EventSerializationTypeParquet EventSerializationType = "Parquet"
)

type FileReferenceInputDataSource added in v0.20220706.1192509

type FileReferenceInputDataSource struct {
	Properties *FileReferenceInputDataSourceProperties `json:"properties,omitempty"`
}

func (FileReferenceInputDataSource) MarshalJSON added in v0.20220706.1192509

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

type FileReferenceInputDataSourceProperties added in v0.20220706.1192509

type FileReferenceInputDataSourceProperties struct {
	Path *string `json:"path,omitempty"`
}

type GatewayMessageBusSourceProperties added in v0.20220706.1192509

type GatewayMessageBusSourceProperties struct {
	Topic *string `json:"topic,omitempty"`
}

type GatewayMessageBusStreamInputDataSource added in v0.20220706.1192509

type GatewayMessageBusStreamInputDataSource struct {
	Properties *GatewayMessageBusSourceProperties `json:"properties,omitempty"`
}

func (GatewayMessageBusStreamInputDataSource) MarshalJSON added in v0.20220706.1192509

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

type GetOperationResponse

type GetOperationResponse struct {
	HttpResponse *http.Response
	Model        *Input
}

type Input

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

func (*Input) UnmarshalJSON

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

type InputId

type InputId struct {
	SubscriptionId    string
	ResourceGroupName string
	JobName           string
	InputName         string
}

InputId is a struct representing the Resource ID for a Input

func NewInputID

func NewInputID(subscriptionId string, resourceGroupName string, jobName string, inputName string) InputId

NewInputID returns a new InputId struct

func ParseInputID

func ParseInputID(input string) (*InputId, error)

ParseInputID parses 'input' into a InputId

func ParseInputIDInsensitively

func ParseInputIDInsensitively(input string) (*InputId, error)

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

func (InputId) ID

func (id InputId) ID() string

ID returns the formatted Input ID

func (InputId) Segments

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

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

func (InputId) String

func (id InputId) String() string

String returns a human-readable description of this Input ID

type InputOperationPredicate

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

func (InputOperationPredicate) Matches

func (p InputOperationPredicate) Matches(input Input) bool

type InputProperties

type InputProperties interface {
}

type InputsClient

type InputsClient struct {
	Client autorest.Client
	// contains filtered or unexported fields
}

func NewInputsClientWithBaseURI

func NewInputsClientWithBaseURI(endpoint string) InputsClient

func (InputsClient) CreateOrReplace

func (c InputsClient) CreateOrReplace(ctx context.Context, id InputId, input Input, options CreateOrReplaceOperationOptions) (result CreateOrReplaceOperationResponse, err error)

CreateOrReplace ...

func (InputsClient) Delete

func (c InputsClient) Delete(ctx context.Context, id InputId) (result DeleteOperationResponse, err error)

Delete ...

func (InputsClient) Get

func (c InputsClient) Get(ctx context.Context, id InputId) (result GetOperationResponse, err error)

Get ...

func (InputsClient) ListByStreamingJob

ListByStreamingJob ...

func (InputsClient) ListByStreamingJobComplete

ListByStreamingJobComplete retrieves all of the results into a single object

func (InputsClient) ListByStreamingJobCompleteMatchingPredicate

func (c InputsClient) ListByStreamingJobCompleteMatchingPredicate(ctx context.Context, id StreamingJobId, options ListByStreamingJobOperationOptions, predicate InputOperationPredicate) (resp ListByStreamingJobCompleteResult, err error)

ListByStreamingJobCompleteMatchingPredicate retrieves all of the results and then applied the predicate

func (InputsClient) Test

func (c InputsClient) Test(ctx context.Context, id InputId, input Input) (result TestOperationResponse, err error)

Test ...

func (InputsClient) TestThenPoll

func (c InputsClient) TestThenPoll(ctx context.Context, id InputId, input Input) error

TestThenPoll performs Test then polls until it's completed

func (InputsClient) Update

func (c InputsClient) Update(ctx context.Context, id InputId, input Input, options UpdateOperationOptions) (result UpdateOperationResponse, err error)

Update ...

type IoTHubStreamInputDataSource

type IoTHubStreamInputDataSource struct {
	Properties *IoTHubStreamInputDataSourceProperties `json:"properties,omitempty"`
}

func (IoTHubStreamInputDataSource) MarshalJSON

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

type IoTHubStreamInputDataSourceProperties

type IoTHubStreamInputDataSourceProperties struct {
	ConsumerGroupName      *string `json:"consumerGroupName,omitempty"`
	Endpoint               *string `json:"endpoint,omitempty"`
	IotHubNamespace        *string `json:"iotHubNamespace,omitempty"`
	SharedAccessPolicyKey  *string `json:"sharedAccessPolicyKey,omitempty"`
	SharedAccessPolicyName *string `json:"sharedAccessPolicyName,omitempty"`
}

type JsonOutputSerializationFormat

type JsonOutputSerializationFormat string
const (
	JsonOutputSerializationFormatArray         JsonOutputSerializationFormat = "Array"
	JsonOutputSerializationFormatLineSeparated JsonOutputSerializationFormat = "LineSeparated"
)

type JsonSerialization

type JsonSerialization struct {
	Properties *JsonSerializationProperties `json:"properties,omitempty"`
}

func (JsonSerialization) MarshalJSON

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

type JsonSerializationProperties

type JsonSerializationProperties struct {
	Encoding *Encoding                      `json:"encoding,omitempty"`
	Format   *JsonOutputSerializationFormat `json:"format,omitempty"`
}

type ListByStreamingJobCompleteResult

type ListByStreamingJobCompleteResult struct {
	Items []Input
}

type ListByStreamingJobOperationOptions

type ListByStreamingJobOperationOptions struct {
	Select *string
}

func DefaultListByStreamingJobOperationOptions

func DefaultListByStreamingJobOperationOptions() ListByStreamingJobOperationOptions

type ListByStreamingJobOperationResponse

type ListByStreamingJobOperationResponse struct {
	HttpResponse *http.Response
	Model        *[]Input
	// contains filtered or unexported fields
}

func (ListByStreamingJobOperationResponse) HasMore

func (ListByStreamingJobOperationResponse) LoadMore

type ParquetSerialization

type ParquetSerialization struct {
	Properties *interface{} `json:"properties,omitempty"`
}

func (ParquetSerialization) MarshalJSON

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

type ReferenceInputDataSource

type ReferenceInputDataSource interface {
}

type ReferenceInputProperties

type ReferenceInputProperties struct {
	Datasource ReferenceInputDataSource `json:"datasource"`

	// Fields inherited from InputProperties
	Compression   *Compression  `json:"compression,omitempty"`
	Diagnostics   *Diagnostics  `json:"diagnostics,omitempty"`
	Etag          *string       `json:"etag,omitempty"`
	PartitionKey  *string       `json:"partitionKey,omitempty"`
	Serialization Serialization `json:"serialization"`
}

func (ReferenceInputProperties) MarshalJSON

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

func (*ReferenceInputProperties) UnmarshalJSON

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

type RefreshType

type RefreshType string
const (
	RefreshTypeRefreshPeriodicallyWithDelta RefreshType = "RefreshPeriodicallyWithDelta"
	RefreshTypeRefreshPeriodicallyWithFull  RefreshType = "RefreshPeriodicallyWithFull"
	RefreshTypeStatic                       RefreshType = "Static"
)

type ResourceTestStatus

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

type Serialization

type Serialization interface {
}

type StorageAccount

type StorageAccount struct {
	AccountKey  *string `json:"accountKey,omitempty"`
	AccountName *string `json:"accountName,omitempty"`
}

type StreamInputDataSource

type StreamInputDataSource interface {
}

type StreamInputProperties

type StreamInputProperties struct {
	Datasource StreamInputDataSource `json:"datasource"`

	// Fields inherited from InputProperties
	Compression   *Compression  `json:"compression,omitempty"`
	Diagnostics   *Diagnostics  `json:"diagnostics,omitempty"`
	Etag          *string       `json:"etag,omitempty"`
	PartitionKey  *string       `json:"partitionKey,omitempty"`
	Serialization Serialization `json:"serialization"`
}

func (StreamInputProperties) MarshalJSON

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

func (*StreamInputProperties) UnmarshalJSON

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

type StreamingJobId

type StreamingJobId struct {
	SubscriptionId    string
	ResourceGroupName string
	JobName           string
}

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

func NewStreamingJobID

func NewStreamingJobID(subscriptionId string, resourceGroupName string, jobName 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) 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 TestOperationResponse

type TestOperationResponse struct {
	Poller       polling.LongRunningPoller
	HttpResponse *http.Response
}

type UpdateOperationOptions

type UpdateOperationOptions struct {
	IfMatch *string
}

func DefaultUpdateOperationOptions

func DefaultUpdateOperationOptions() UpdateOperationOptions

type UpdateOperationResponse

type UpdateOperationResponse struct {
	HttpResponse *http.Response
	Model        *Input
}

Jump to

Keyboard shortcuts

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