eventhubsclusters

package
v0.20240223.1130721 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/eventhub/2024-01-01/eventhubsclusters Documentation

The eventhubsclusters SDK allows for interaction with the Azure Resource Manager Service eventhub (API Version 2024-01-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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/eventhub/2024-01-01/eventhubsclusters"

Client Initialization

client := eventhubsclusters.NewEventHubsClustersClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: EventHubsClustersClient.ClustersCreateOrUpdate

ctx := context.TODO()
id := eventhubsclusters.NewClusterID("12345678-1234-9876-4563-123456789012", "example-resource-group", "clusterValue")

payload := eventhubsclusters.Cluster{
	// ...
}


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

Example Usage: EventHubsClustersClient.ClustersDelete

ctx := context.TODO()
id := eventhubsclusters.NewClusterID("12345678-1234-9876-4563-123456789012", "example-resource-group", "clusterValue")

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

Example Usage: EventHubsClustersClient.ClustersGet

ctx := context.TODO()
id := eventhubsclusters.NewClusterID("12345678-1234-9876-4563-123456789012", "example-resource-group", "clusterValue")

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

Example Usage: EventHubsClustersClient.ClustersListByResourceGroup

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

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

Example Usage: EventHubsClustersClient.ClustersListBySubscription

ctx := context.TODO()
id := commonids.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

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

Example Usage: EventHubsClustersClient.ClustersUpdate

ctx := context.TODO()
id := eventhubsclusters.NewClusterID("12345678-1234-9876-4563-123456789012", "example-resource-group", "clusterValue")

payload := eventhubsclusters.Cluster{
	// ...
}


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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForClusterSkuName 

func PossibleValuesForClusterSkuName() []string

func PossibleValuesForProvisioningState 

func PossibleValuesForProvisioningState() []string

func PossibleValuesForStartDayOfWeek 

func PossibleValuesForStartDayOfWeek() []string

func ValidateClusterID 

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

ValidateClusterID checks that 'input' can be parsed as a Cluster ID

Types

type Cluster 

type Cluster struct {
	Id         *string                `json:"id,omitempty"`
	Location   *string                `json:"location,omitempty"`
	Name       *string                `json:"name,omitempty"`
	Properties *ClusterProperties     `json:"properties,omitempty"`
	Sku        *ClusterSku            `json:"sku,omitempty"`
	SystemData *systemdata.SystemData `json:"systemData,omitempty"`
	Tags       *map[string]string     `json:"tags,omitempty"`
	Type       *string                `json:"type,omitempty"`
}

type ClusterId 

type ClusterId struct {
	SubscriptionId    string
	ResourceGroupName string
	ClusterName       string
}

ClusterId is a struct representing the Resource ID for a Cluster

func NewClusterID 

func NewClusterID(subscriptionId string, resourceGroupName string, clusterName string) ClusterId

NewClusterID returns a new ClusterId struct

func ParseClusterID 

func ParseClusterID(input string) (*ClusterId, error)

ParseClusterID parses 'input' into a ClusterId

func ParseClusterIDInsensitively 

func ParseClusterIDInsensitively(input string) (*ClusterId, error)

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

func (*ClusterId) FromParseResult 

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

func (ClusterId) ID 

func (id ClusterId) ID() string

ID returns the formatted Cluster ID

func (ClusterId) Segments 

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

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

func (ClusterId) String 

func (id ClusterId) String() string

String returns a human-readable description of this Cluster ID

type ClusterOperationPredicate 

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

func (ClusterOperationPredicate) Matches 

func (p ClusterOperationPredicate) Matches(input Cluster) bool

type ClusterProperties 

type ClusterProperties struct {
	CreatedAt          *string             `json:"createdAt,omitempty"`
	MetricId           *string             `json:"metricId,omitempty"`
	ProvisioningState  *ProvisioningState  `json:"provisioningState,omitempty"`
	Status             *string             `json:"status,omitempty"`
	SupportsScaling    *bool               `json:"supportsScaling,omitempty"`
	UpdatedAt          *string             `json:"updatedAt,omitempty"`
	UpgradePreferences *UpgradePreferences `json:"upgradePreferences,omitempty"`
}

type ClusterSku 

type ClusterSku struct {
	Capacity *int64         `json:"capacity,omitempty"`
	Name     ClusterSkuName `json:"name"`
}

type ClusterSkuName 

type ClusterSkuName string
const (
	ClusterSkuNameDedicated ClusterSkuName = "Dedicated"
)

func (*ClusterSkuName) UnmarshalJSON 

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

type ClustersCreateOrUpdateOperationResponse 

type ClustersCreateOrUpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Cluster
}

type ClustersDeleteOperationResponse 

type ClustersDeleteOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type ClustersGetOperationResponse 

type ClustersGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Cluster
}

type ClustersListByResourceGroupCompleteResult 

type ClustersListByResourceGroupCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []Cluster
}

type ClustersListByResourceGroupOperationResponse 

type ClustersListByResourceGroupOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]Cluster
}

type ClustersListBySubscriptionCompleteResult 

type ClustersListBySubscriptionCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []Cluster
}

type ClustersListBySubscriptionOperationResponse 

type ClustersListBySubscriptionOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]Cluster
}

type ClustersUpdateOperationResponse 

type ClustersUpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Cluster
}

type EventHubsClustersClient 

type EventHubsClustersClient struct {
	Client *resourcemanager.Client
}

func NewEventHubsClustersClientWithBaseURI 

func NewEventHubsClustersClientWithBaseURI(sdkApi sdkEnv.Api) (*EventHubsClustersClient, error)

func (EventHubsClustersClient) ClustersCreateOrUpdate 

func (c EventHubsClustersClient) ClustersCreateOrUpdate(ctx context.Context, id ClusterId, input Cluster) (result ClustersCreateOrUpdateOperationResponse, err error)

ClustersCreateOrUpdate ...

func (EventHubsClustersClient) ClustersCreateOrUpdateThenPoll 

func (c EventHubsClustersClient) ClustersCreateOrUpdateThenPoll(ctx context.Context, id ClusterId, input Cluster) error

ClustersCreateOrUpdateThenPoll performs ClustersCreateOrUpdate then polls until it's completed

func (EventHubsClustersClient) ClustersDelete 

func (c EventHubsClustersClient) ClustersDelete(ctx context.Context, id ClusterId) (result ClustersDeleteOperationResponse, err error)

ClustersDelete ...

func (EventHubsClustersClient) ClustersDeleteThenPoll 

func (c EventHubsClustersClient) ClustersDeleteThenPoll(ctx context.Context, id ClusterId) error

ClustersDeleteThenPoll performs ClustersDelete then polls until it's completed

func (EventHubsClustersClient) ClustersGet 

func (c EventHubsClustersClient) ClustersGet(ctx context.Context, id ClusterId) (result ClustersGetOperationResponse, err error)

ClustersGet ...

func (EventHubsClustersClient) ClustersListByResourceGroup 

func (c EventHubsClustersClient) ClustersListByResourceGroup(ctx context.Context, id commonids.ResourceGroupId) (result ClustersListByResourceGroupOperationResponse, err error)

ClustersListByResourceGroup ...

func (EventHubsClustersClient) ClustersListByResourceGroupComplete 

func (c EventHubsClustersClient) ClustersListByResourceGroupComplete(ctx context.Context, id commonids.ResourceGroupId) (ClustersListByResourceGroupCompleteResult, error)

ClustersListByResourceGroupComplete retrieves all the results into a single object

func (EventHubsClustersClient) ClustersListByResourceGroupCompleteMatchingPredicate 

func (c EventHubsClustersClient) ClustersListByResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, predicate ClusterOperationPredicate) (result ClustersListByResourceGroupCompleteResult, err error)

ClustersListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (EventHubsClustersClient) ClustersListBySubscription 

func (c EventHubsClustersClient) ClustersListBySubscription(ctx context.Context, id commonids.SubscriptionId) (result ClustersListBySubscriptionOperationResponse, err error)

ClustersListBySubscription ...

func (EventHubsClustersClient) ClustersListBySubscriptionComplete 

func (c EventHubsClustersClient) ClustersListBySubscriptionComplete(ctx context.Context, id commonids.SubscriptionId) (ClustersListBySubscriptionCompleteResult, error)

ClustersListBySubscriptionComplete retrieves all the results into a single object

func (EventHubsClustersClient) ClustersListBySubscriptionCompleteMatchingPredicate 

func (c EventHubsClustersClient) ClustersListBySubscriptionCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate ClusterOperationPredicate) (result ClustersListBySubscriptionCompleteResult, err error)

ClustersListBySubscriptionCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (EventHubsClustersClient) ClustersUpdate 

func (c EventHubsClustersClient) ClustersUpdate(ctx context.Context, id ClusterId, input Cluster) (result ClustersUpdateOperationResponse, err error)

ClustersUpdate ...

func (EventHubsClustersClient) ClustersUpdateThenPoll 

func (c EventHubsClustersClient) ClustersUpdateThenPoll(ctx context.Context, id ClusterId, input Cluster) error

ClustersUpdateThenPoll performs ClustersUpdate then polls until it's completed

type ProvisioningState 

type ProvisioningState string
const (
	ProvisioningStateActive    ProvisioningState = "Active"
	ProvisioningStateCanceled  ProvisioningState = "Canceled"
	ProvisioningStateCreating  ProvisioningState = "Creating"
	ProvisioningStateDeleting  ProvisioningState = "Deleting"
	ProvisioningStateFailed    ProvisioningState = "Failed"
	ProvisioningStateScaling   ProvisioningState = "Scaling"
	ProvisioningStateSucceeded ProvisioningState = "Succeeded"
	ProvisioningStateUnknown   ProvisioningState = "Unknown"
)

func (*ProvisioningState) UnmarshalJSON 

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

type StartDayOfWeek 

type StartDayOfWeek string
const (
	StartDayOfWeekAny       StartDayOfWeek = "Any"
	StartDayOfWeekFriday    StartDayOfWeek = "Friday"
	StartDayOfWeekMonday    StartDayOfWeek = "Monday"
	StartDayOfWeekSaturday  StartDayOfWeek = "Saturday"
	StartDayOfWeekSunday    StartDayOfWeek = "Sunday"
	StartDayOfWeekThursday  StartDayOfWeek = "Thursday"
	StartDayOfWeekTuesday   StartDayOfWeek = "Tuesday"
	StartDayOfWeekWednesday StartDayOfWeek = "Wednesday"
)

func (*StartDayOfWeek) UnmarshalJSON 

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

type UpgradePreferences 

type UpgradePreferences struct {
	StartDayOfWeek *StartDayOfWeek `json:"startDayOfWeek,omitempty"`
	StartHourOfDay *int64          `json:"startHourOfDay,omitempty"`
}

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.