streamingjobs

package
v0.20220714.1093308 Latest Latest
Warning

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

Go to latest
Published: Jul 14, 2022 License: MPL-2.0 Imports: 12 Imported by: 1

README

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

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

Client Initialization

client := streamingjobs.NewStreamingJobsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: StreamingJobsClient.CreateOrReplace

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

payload := streamingjobs.StreamingJob{
	// ...
}


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

Example Usage: StreamingJobsClient.Delete

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

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

Example Usage: StreamingJobsClient.Get

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

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

Example Usage: StreamingJobsClient.List

ctx := context.TODO()
id := streamingjobs.NewSubscriptionID()

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

Example Usage: StreamingJobsClient.ListByResourceGroup

ctx := context.TODO()
id := streamingjobs.NewResourceGroupID()

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

Example Usage: StreamingJobsClient.Scale

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

payload := streamingjobs.ScaleStreamingJobParameters{
	// ...
}


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

Example Usage: StreamingJobsClient.Start

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

payload := streamingjobs.StartStreamingJobParameters{
	// ...
}


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

Example Usage: StreamingJobsClient.Stop

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

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

Example Usage: StreamingJobsClient.Update

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

payload := streamingjobs.StreamingJob{
	// ...
}


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

func PossibleValuesForCompatibilityLevel() []string

func PossibleValuesForCompressionType

func PossibleValuesForCompressionType() []string

func PossibleValuesForContentStoragePolicy

func PossibleValuesForContentStoragePolicy() []string

func PossibleValuesForEventSerializationType

func PossibleValuesForEventSerializationType() []string

func PossibleValuesForEventsOutOfOrderPolicy

func PossibleValuesForEventsOutOfOrderPolicy() []string

func PossibleValuesForJobType

func PossibleValuesForJobType() []string

func PossibleValuesForOutputErrorPolicy

func PossibleValuesForOutputErrorPolicy() []string

func PossibleValuesForOutputStartMode

func PossibleValuesForOutputStartMode() []string

func PossibleValuesForSkuName

func PossibleValuesForSkuName() []string

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 ClusterInfo

type ClusterInfo struct {
	Id *string `json:"id,omitempty"`
}

type CompatibilityLevel

type CompatibilityLevel string
const (
	CompatibilityLevelOnePointTwo  CompatibilityLevel = "1.2"
	CompatibilityLevelOnePointZero CompatibilityLevel = "1.0"
)

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 ContentStoragePolicy

type ContentStoragePolicy string
const (
	ContentStoragePolicyJobStorageAccount ContentStoragePolicy = "JobStorageAccount"
	ContentStoragePolicySystemAccount     ContentStoragePolicy = "SystemAccount"
)

type CreateOrReplaceOperationOptions

type CreateOrReplaceOperationOptions struct {
	IfMatch     *string
	IfNoneMatch *string
}

func DefaultCreateOrReplaceOperationOptions

func DefaultCreateOrReplaceOperationOptions() CreateOrReplaceOperationOptions

type CreateOrReplaceOperationResponse

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

type DeleteOperationResponse

type DeleteOperationResponse struct {
	Poller       polling.LongRunningPoller
	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 EventSerializationType

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

type EventsOutOfOrderPolicy

type EventsOutOfOrderPolicy string
const (
	EventsOutOfOrderPolicyAdjust EventsOutOfOrderPolicy = "Adjust"
	EventsOutOfOrderPolicyDrop   EventsOutOfOrderPolicy = "Drop"
)

type Function

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

type FunctionBinding

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

type FunctionConfiguration

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

type FunctionInput

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

type FunctionOutput

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

type FunctionProperties

type FunctionProperties struct {
	Etag       *string                `json:"etag,omitempty"`
	Properties *FunctionConfiguration `json:"properties,omitempty"`
	Type       string                 `json:"type"`
}

type GetOperationOptions

type GetOperationOptions struct {
	Expand *string
}

func DefaultGetOperationOptions

func DefaultGetOperationOptions() GetOperationOptions

type GetOperationResponse

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

type Identity

type Identity struct {
	PrincipalId *string `json:"principalId,omitempty"`
	TenantId    *string `json:"tenantId,omitempty"`
	Type        *string `json:"type,omitempty"`
}

type Input

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

type InputProperties

type InputProperties struct {
	Compression   *Compression   `json:"compression,omitempty"`
	Diagnostics   *Diagnostics   `json:"diagnostics,omitempty"`
	Etag          *string        `json:"etag,omitempty"`
	PartitionKey  *string        `json:"partitionKey,omitempty"`
	Serialization *Serialization `json:"serialization,omitempty"`
	Type          string         `json:"type"`
}

type JobStorageAccount

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

type JobType

type JobType string
const (
	JobTypeCloud JobType = "Cloud"
	JobTypeEdge  JobType = "Edge"
)

type ListByResourceGroupCompleteResult

type ListByResourceGroupCompleteResult struct {
	Items []StreamingJob
}

type ListByResourceGroupOperationOptions

type ListByResourceGroupOperationOptions struct {
	Expand *string
}

func DefaultListByResourceGroupOperationOptions

func DefaultListByResourceGroupOperationOptions() ListByResourceGroupOperationOptions

type ListByResourceGroupOperationResponse

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

func (ListByResourceGroupOperationResponse) HasMore

func (ListByResourceGroupOperationResponse) LoadMore

type ListCompleteResult

type ListCompleteResult struct {
	Items []StreamingJob
}

type ListOperationOptions

type ListOperationOptions struct {
	Expand *string
}

func DefaultListOperationOptions

func DefaultListOperationOptions() ListOperationOptions

type ListOperationResponse

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

func (ListOperationResponse) HasMore

func (r ListOperationResponse) HasMore() bool

func (ListOperationResponse) LoadMore

func (r ListOperationResponse) LoadMore(ctx context.Context) (resp ListOperationResponse, err error)

type Output

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

type OutputDataSource

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

type OutputErrorPolicy

type OutputErrorPolicy string
const (
	OutputErrorPolicyDrop OutputErrorPolicy = "Drop"
	OutputErrorPolicyStop OutputErrorPolicy = "Stop"
)

type OutputProperties

type OutputProperties struct {
	Datasource    *OutputDataSource `json:"datasource,omitempty"`
	Diagnostics   *Diagnostics      `json:"diagnostics,omitempty"`
	Etag          *string           `json:"etag,omitempty"`
	Serialization *Serialization    `json:"serialization,omitempty"`
	SizeWindow    *float64          `json:"sizeWindow,omitempty"`
	TimeWindow    *string           `json:"timeWindow,omitempty"`
}

type OutputStartMode

type OutputStartMode string
const (
	OutputStartModeCustomTime          OutputStartMode = "CustomTime"
	OutputStartModeJobStartTime        OutputStartMode = "JobStartTime"
	OutputStartModeLastOutputEventTime OutputStartMode = "LastOutputEventTime"
)

type ScaleOperationResponse

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

type ScaleStreamingJobParameters

type ScaleStreamingJobParameters struct {
	StreamingUnits *int64 `json:"streamingUnits,omitempty"`
}

type Serialization

type Serialization struct {
	Type EventSerializationType `json:"type"`
}

type Sku

type Sku struct {
	Name *SkuName `json:"name,omitempty"`
}

type SkuName

type SkuName string
const (
	SkuNameStandard SkuName = "Standard"
)

type StartOperationResponse

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

type StartStreamingJobParameters

type StartStreamingJobParameters struct {
	OutputStartMode *OutputStartMode `json:"outputStartMode,omitempty"`
	OutputStartTime *string          `json:"outputStartTime,omitempty"`
}

func (*StartStreamingJobParameters) GetOutputStartTimeAsTime

func (o *StartStreamingJobParameters) GetOutputStartTimeAsTime() (*time.Time, error)

func (*StartStreamingJobParameters) SetOutputStartTimeAsTime

func (o *StartStreamingJobParameters) SetOutputStartTimeAsTime(input time.Time)

type StopOperationResponse

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

type StreamingJob

type StreamingJob struct {
	Id         *string                 `json:"id,omitempty"`
	Identity   *Identity               `json:"identity,omitempty"`
	Location   *string                 `json:"location,omitempty"`
	Name       *string                 `json:"name,omitempty"`
	Properties *StreamingJobProperties `json:"properties,omitempty"`
	Tags       *map[string]string      `json:"tags,omitempty"`
	Type       *string                 `json:"type,omitempty"`
}

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 StreamingJobOperationPredicate

type StreamingJobOperationPredicate struct {
	Id       *string
	Location *string
	Name     *string
	Type     *string
}

func (StreamingJobOperationPredicate) Matches

type StreamingJobProperties

type StreamingJobProperties struct {
	Cluster                            *ClusterInfo            `json:"cluster,omitempty"`
	CompatibilityLevel                 *CompatibilityLevel     `json:"compatibilityLevel,omitempty"`
	ContentStoragePolicy               *ContentStoragePolicy   `json:"contentStoragePolicy,omitempty"`
	CreatedDate                        *string                 `json:"createdDate,omitempty"`
	DataLocale                         *string                 `json:"dataLocale,omitempty"`
	Etag                               *string                 `json:"etag,omitempty"`
	EventsLateArrivalMaxDelayInSeconds *int64                  `json:"eventsLateArrivalMaxDelayInSeconds,omitempty"`
	EventsOutOfOrderMaxDelayInSeconds  *int64                  `json:"eventsOutOfOrderMaxDelayInSeconds,omitempty"`
	EventsOutOfOrderPolicy             *EventsOutOfOrderPolicy `json:"eventsOutOfOrderPolicy,omitempty"`
	Functions                          *[]Function             `json:"functions,omitempty"`
	Inputs                             *[]Input                `json:"inputs,omitempty"`
	JobId                              *string                 `json:"jobId,omitempty"`
	JobState                           *string                 `json:"jobState,omitempty"`
	JobStorageAccount                  *JobStorageAccount      `json:"jobStorageAccount,omitempty"`
	JobType                            *JobType                `json:"jobType,omitempty"`
	LastOutputEventTime                *string                 `json:"lastOutputEventTime,omitempty"`
	OutputErrorPolicy                  *OutputErrorPolicy      `json:"outputErrorPolicy,omitempty"`
	OutputStartMode                    *OutputStartMode        `json:"outputStartMode,omitempty"`
	OutputStartTime                    *string                 `json:"outputStartTime,omitempty"`
	Outputs                            *[]Output               `json:"outputs,omitempty"`
	ProvisioningState                  *string                 `json:"provisioningState,omitempty"`
	Sku                                *Sku                    `json:"sku,omitempty"`
	Transformation                     *Transformation         `json:"transformation,omitempty"`
}

func (*StreamingJobProperties) GetCreatedDateAsTime

func (o *StreamingJobProperties) GetCreatedDateAsTime() (*time.Time, error)

func (*StreamingJobProperties) GetLastOutputEventTimeAsTime

func (o *StreamingJobProperties) GetLastOutputEventTimeAsTime() (*time.Time, error)

func (*StreamingJobProperties) GetOutputStartTimeAsTime

func (o *StreamingJobProperties) GetOutputStartTimeAsTime() (*time.Time, error)

func (*StreamingJobProperties) SetCreatedDateAsTime

func (o *StreamingJobProperties) SetCreatedDateAsTime(input time.Time)

func (*StreamingJobProperties) SetLastOutputEventTimeAsTime

func (o *StreamingJobProperties) SetLastOutputEventTimeAsTime(input time.Time)

func (*StreamingJobProperties) SetOutputStartTimeAsTime

func (o *StreamingJobProperties) SetOutputStartTimeAsTime(input time.Time)

type StreamingJobsClient

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

func NewStreamingJobsClientWithBaseURI

func NewStreamingJobsClientWithBaseURI(endpoint string) StreamingJobsClient

func (StreamingJobsClient) CreateOrReplace

CreateOrReplace ...

func (StreamingJobsClient) CreateOrReplaceThenPoll

func (c StreamingJobsClient) CreateOrReplaceThenPoll(ctx context.Context, id StreamingJobId, input StreamingJob, options CreateOrReplaceOperationOptions) error

CreateOrReplaceThenPoll performs CreateOrReplace then polls until it's completed

func (StreamingJobsClient) Delete

Delete ...

func (StreamingJobsClient) DeleteThenPoll

func (c StreamingJobsClient) DeleteThenPoll(ctx context.Context, id StreamingJobId) error

DeleteThenPoll performs Delete then polls until it's completed

func (StreamingJobsClient) Get

Get ...

func (StreamingJobsClient) List

List ...

func (StreamingJobsClient) ListByResourceGroup

ListByResourceGroup ...

func (StreamingJobsClient) ListByResourceGroupComplete

ListByResourceGroupComplete retrieves all of the results into a single object

func (StreamingJobsClient) ListByResourceGroupCompleteMatchingPredicate

ListByResourceGroupCompleteMatchingPredicate retrieves all of the results and then applied the predicate

func (StreamingJobsClient) ListComplete

ListComplete retrieves all of the results into a single object

func (StreamingJobsClient) ListCompleteMatchingPredicate

func (c StreamingJobsClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, options ListOperationOptions, predicate StreamingJobOperationPredicate) (resp ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all of the results and then applied the predicate

func (StreamingJobsClient) Scale

Scale ...

func (StreamingJobsClient) ScaleThenPoll

ScaleThenPoll performs Scale then polls until it's completed

func (StreamingJobsClient) Start

Start ...

func (StreamingJobsClient) StartThenPoll

StartThenPoll performs Start then polls until it's completed

func (StreamingJobsClient) Stop

Stop ...

func (StreamingJobsClient) StopThenPoll

func (c StreamingJobsClient) StopThenPoll(ctx context.Context, id StreamingJobId) error

StopThenPoll performs Stop then polls until it's completed

func (StreamingJobsClient) Update

Update ...

type Transformation

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

type TransformationProperties

type TransformationProperties struct {
	Etag                *string  `json:"etag,omitempty"`
	Query               *string  `json:"query,omitempty"`
	StreamingUnits      *int64   `json:"streamingUnits,omitempty"`
	ValidStreamingUnits *[]int64 `json:"validStreamingUnits,omitempty"`
}

type UpdateOperationOptions

type UpdateOperationOptions struct {
	IfMatch *string
}

func DefaultUpdateOperationOptions

func DefaultUpdateOperationOptions() UpdateOperationOptions

type UpdateOperationResponse

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

Jump to

Keyboard shortcuts

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