kafkaconfiguration

package
v0.20240411.1145857 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/purview/2021-12-01/kafkaconfiguration Documentation

The kafkaconfiguration SDK allows for interaction with the Azure Resource Manager Service purview (API Version 2021-12-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/purview/2021-12-01/kafkaconfiguration"

Client Initialization

client := kafkaconfiguration.NewKafkaConfigurationClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: KafkaConfigurationClient.CreateOrUpdate

ctx := context.TODO()
id := kafkaconfiguration.NewKafkaConfigurationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "accountValue", "kafkaConfigurationValue")

payload := kafkaconfiguration.KafkaConfiguration{
	// ...
}


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

Example Usage: KafkaConfigurationClient.Delete

ctx := context.TODO()
id := kafkaconfiguration.NewKafkaConfigurationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "accountValue", "kafkaConfigurationValue")

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

ctx := context.TODO()
id := kafkaconfiguration.NewKafkaConfigurationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "accountValue", "kafkaConfigurationValue")

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: KafkaConfigurationClient.ListByAccount

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

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForCredentialsType

func PossibleValuesForCredentialsType() []string

func PossibleValuesForEventHubType

func PossibleValuesForEventHubType() []string

func PossibleValuesForEventStreamingState

func PossibleValuesForEventStreamingState() []string

func PossibleValuesForEventStreamingType

func PossibleValuesForEventStreamingType() []string

func ValidateAccountID

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

ValidateAccountID checks that 'input' can be parsed as a Account ID

func ValidateKafkaConfigurationID

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

ValidateKafkaConfigurationID checks that 'input' can be parsed as a Kafka Configuration ID

Types

type AccountId

type AccountId struct {
	SubscriptionId    string
	ResourceGroupName string
	AccountName       string
}

AccountId is a struct representing the Resource ID for a Account

func NewAccountID

func NewAccountID(subscriptionId string, resourceGroupName string, accountName string) AccountId

NewAccountID returns a new AccountId struct

func ParseAccountID

func ParseAccountID(input string) (*AccountId, error)

ParseAccountID parses 'input' into a AccountId

func ParseAccountIDInsensitively

func ParseAccountIDInsensitively(input string) (*AccountId, error)

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

func (*AccountId) FromParseResult

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

func (AccountId) ID

func (id AccountId) ID() string

ID returns the formatted Account ID

func (AccountId) Segments

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

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

func (AccountId) String

func (id AccountId) String() string

String returns a human-readable description of this Account ID

type CreateOrUpdateOperationResponse

type CreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *KafkaConfiguration
}

type Credentials

type Credentials struct {
	IdentityId *string          `json:"identityId,omitempty"`
	Type       *CredentialsType `json:"type,omitempty"`
}

type CredentialsType

type CredentialsType string
const (
	CredentialsTypeNone           CredentialsType = "None"
	CredentialsTypeSystemAssigned CredentialsType = "SystemAssigned"
	CredentialsTypeUserAssigned   CredentialsType = "UserAssigned"
)

func (*CredentialsType) UnmarshalJSON

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

type DeleteOperationResponse

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

type EventHubType

type EventHubType string
const (
	EventHubTypeHook         EventHubType = "Hook"
	EventHubTypeNotification EventHubType = "Notification"
)

func (*EventHubType) UnmarshalJSON

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

type EventStreamingState

type EventStreamingState string
const (
	EventStreamingStateDisabled EventStreamingState = "Disabled"
	EventStreamingStateEnabled  EventStreamingState = "Enabled"
)

func (*EventStreamingState) UnmarshalJSON

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

type EventStreamingType

type EventStreamingType string
const (
	EventStreamingTypeAzure   EventStreamingType = "Azure"
	EventStreamingTypeManaged EventStreamingType = "Managed"
	EventStreamingTypeNone    EventStreamingType = "None"
)

func (*EventStreamingType) UnmarshalJSON

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

type GetOperationResponse

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

type KafkaConfiguration

type KafkaConfiguration struct {
	Id         *string                       `json:"id,omitempty"`
	Name       *string                       `json:"name,omitempty"`
	Properties *KafkaConfigurationProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData        `json:"systemData,omitempty"`
	Type       *string                       `json:"type,omitempty"`
}

type KafkaConfigurationClient

type KafkaConfigurationClient struct {
	Client *resourcemanager.Client
}

func NewKafkaConfigurationClientWithBaseURI

func NewKafkaConfigurationClientWithBaseURI(sdkApi sdkEnv.Api) (*KafkaConfigurationClient, error)

func (KafkaConfigurationClient) CreateOrUpdate

CreateOrUpdate ...

func (KafkaConfigurationClient) Delete

Delete ...

func (KafkaConfigurationClient) Get

Get ...

func (KafkaConfigurationClient) ListByAccount

ListByAccount ...

func (KafkaConfigurationClient) ListByAccountComplete

ListByAccountComplete retrieves all the results into a single object

func (KafkaConfigurationClient) ListByAccountCompleteMatchingPredicate

func (c KafkaConfigurationClient) ListByAccountCompleteMatchingPredicate(ctx context.Context, id AccountId, predicate KafkaConfigurationOperationPredicate) (result ListByAccountCompleteResult, err error)

ListByAccountCompleteMatchingPredicate retrieves all the results and then applies the predicate

type KafkaConfigurationId

type KafkaConfigurationId struct {
	SubscriptionId         string
	ResourceGroupName      string
	AccountName            string
	KafkaConfigurationName string
}

KafkaConfigurationId is a struct representing the Resource ID for a Kafka Configuration

func NewKafkaConfigurationID

func NewKafkaConfigurationID(subscriptionId string, resourceGroupName string, accountName string, kafkaConfigurationName string) KafkaConfigurationId

NewKafkaConfigurationID returns a new KafkaConfigurationId struct

func ParseKafkaConfigurationID

func ParseKafkaConfigurationID(input string) (*KafkaConfigurationId, error)

ParseKafkaConfigurationID parses 'input' into a KafkaConfigurationId

func ParseKafkaConfigurationIDInsensitively

func ParseKafkaConfigurationIDInsensitively(input string) (*KafkaConfigurationId, error)

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

func (*KafkaConfigurationId) FromParseResult

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

func (KafkaConfigurationId) ID

func (id KafkaConfigurationId) ID() string

ID returns the formatted Kafka Configuration ID

func (KafkaConfigurationId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Kafka Configuration ID

func (KafkaConfigurationId) String

func (id KafkaConfigurationId) String() string

String returns a human-readable description of this Kafka Configuration ID

type KafkaConfigurationOperationPredicate

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

func (KafkaConfigurationOperationPredicate) Matches

type KafkaConfigurationProperties

type KafkaConfigurationProperties struct {
	ConsumerGroup       *string              `json:"consumerGroup,omitempty"`
	Credentials         *Credentials         `json:"credentials,omitempty"`
	EventHubPartitionId *string              `json:"eventHubPartitionId,omitempty"`
	EventHubResourceId  *string              `json:"eventHubResourceId,omitempty"`
	EventHubType        *EventHubType        `json:"eventHubType,omitempty"`
	EventStreamingState *EventStreamingState `json:"eventStreamingState,omitempty"`
	EventStreamingType  *EventStreamingType  `json:"eventStreamingType,omitempty"`
}

type ListByAccountCompleteResult

type ListByAccountCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []KafkaConfiguration
}

type ListByAccountOperationResponse

type ListByAccountOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]KafkaConfiguration
}

Jump to

Keyboard shortcuts

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