domaintopics

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: 13 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/eventgrid/2023-12-15-preview/domaintopics Documentation

The domaintopics SDK allows for interaction with the Azure Resource Manager Service eventgrid (API Version 2023-12-15-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/eventgrid/2023-12-15-preview/domaintopics"

Client Initialization

client := domaintopics.NewDomainTopicsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: DomainTopicsClient.CreateOrUpdate

ctx := context.TODO()
id := domaintopics.NewDomainTopicID("12345678-1234-9876-4563-123456789012", "example-resource-group", "domainValue", "topicValue")

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

Example Usage: DomainTopicsClient.Delete

ctx := context.TODO()
id := domaintopics.NewDomainTopicID("12345678-1234-9876-4563-123456789012", "example-resource-group", "domainValue", "topicValue")

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

Example Usage: DomainTopicsClient.Get

ctx := context.TODO()
id := domaintopics.NewDomainTopicID("12345678-1234-9876-4563-123456789012", "example-resource-group", "domainValue", "topicValue")

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: DomainTopicsClient.ListByDomain

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

// alternatively `client.ListByDomain(ctx, id, domaintopics.DefaultListByDomainOperationOptions())` can be used to do batched pagination
items, err := client.ListByDomainComplete(ctx, id, domaintopics.DefaultListByDomainOperationOptions())
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 PossibleValuesForDomainTopicProvisioningState 

func PossibleValuesForDomainTopicProvisioningState() []string

func ValidateDomainID 

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

ValidateDomainID checks that 'input' can be parsed as a Domain ID

func ValidateDomainTopicID 

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

ValidateDomainTopicID checks that 'input' can be parsed as a Domain Topic ID

Types

type CreateOrUpdateOperationResponse 

type CreateOrUpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *DomainTopic
}

type DeleteOperationResponse 

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

type DomainId 

type DomainId struct {
	SubscriptionId    string
	ResourceGroupName string
	DomainName        string
}

DomainId is a struct representing the Resource ID for a Domain

func NewDomainID 

func NewDomainID(subscriptionId string, resourceGroupName string, domainName string) DomainId

NewDomainID returns a new DomainId struct

func ParseDomainID 

func ParseDomainID(input string) (*DomainId, error)

ParseDomainID parses 'input' into a DomainId

func ParseDomainIDInsensitively 

func ParseDomainIDInsensitively(input string) (*DomainId, error)

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

func (*DomainId) FromParseResult 

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

func (DomainId) ID 

func (id DomainId) ID() string

ID returns the formatted Domain ID

func (DomainId) Segments 

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

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

func (DomainId) String 

func (id DomainId) String() string

String returns a human-readable description of this Domain ID

type DomainTopic 

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

type DomainTopicId 

type DomainTopicId struct {
	SubscriptionId    string
	ResourceGroupName string
	DomainName        string
	TopicName         string
}

DomainTopicId is a struct representing the Resource ID for a Domain Topic

func NewDomainTopicID 

func NewDomainTopicID(subscriptionId string, resourceGroupName string, domainName string, topicName string) DomainTopicId

NewDomainTopicID returns a new DomainTopicId struct

func ParseDomainTopicID 

func ParseDomainTopicID(input string) (*DomainTopicId, error)

ParseDomainTopicID parses 'input' into a DomainTopicId

func ParseDomainTopicIDInsensitively 

func ParseDomainTopicIDInsensitively(input string) (*DomainTopicId, error)

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

func (*DomainTopicId) FromParseResult 

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

func (DomainTopicId) ID 

func (id DomainTopicId) ID() string

ID returns the formatted Domain Topic ID

func (DomainTopicId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Domain Topic ID

func (DomainTopicId) String 

func (id DomainTopicId) String() string

String returns a human-readable description of this Domain Topic ID

type DomainTopicOperationPredicate 

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

func (DomainTopicOperationPredicate) Matches 

func (p DomainTopicOperationPredicate) Matches(input DomainTopic) bool

type DomainTopicProperties 

type DomainTopicProperties struct {
	ProvisioningState *DomainTopicProvisioningState `json:"provisioningState,omitempty"`
}

type DomainTopicProvisioningState 

type DomainTopicProvisioningState string
const (
	DomainTopicProvisioningStateCanceled  DomainTopicProvisioningState = "Canceled"
	DomainTopicProvisioningStateCreating  DomainTopicProvisioningState = "Creating"
	DomainTopicProvisioningStateDeleting  DomainTopicProvisioningState = "Deleting"
	DomainTopicProvisioningStateFailed    DomainTopicProvisioningState = "Failed"
	DomainTopicProvisioningStateSucceeded DomainTopicProvisioningState = "Succeeded"
	DomainTopicProvisioningStateUpdating  DomainTopicProvisioningState = "Updating"
)

func (*DomainTopicProvisioningState) UnmarshalJSON 

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

type DomainTopicsClient 

type DomainTopicsClient struct {
	Client *resourcemanager.Client
}

func NewDomainTopicsClientWithBaseURI 

func NewDomainTopicsClientWithBaseURI(sdkApi sdkEnv.Api) (*DomainTopicsClient, error)

func (DomainTopicsClient) CreateOrUpdate 

func (c DomainTopicsClient) CreateOrUpdate(ctx context.Context, id DomainTopicId) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (DomainTopicsClient) CreateOrUpdateThenPoll 

func (c DomainTopicsClient) CreateOrUpdateThenPoll(ctx context.Context, id DomainTopicId) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (DomainTopicsClient) Delete 

func (c DomainTopicsClient) Delete(ctx context.Context, id DomainTopicId) (result DeleteOperationResponse, err error)

Delete ...

func (DomainTopicsClient) DeleteThenPoll 

func (c DomainTopicsClient) DeleteThenPoll(ctx context.Context, id DomainTopicId) error

DeleteThenPoll performs Delete then polls until it's completed

func (DomainTopicsClient) Get 

func (c DomainTopicsClient) Get(ctx context.Context, id DomainTopicId) (result GetOperationResponse, err error)

Get ...

func (DomainTopicsClient) ListByDomain 

func (c DomainTopicsClient) ListByDomain(ctx context.Context, id DomainId, options ListByDomainOperationOptions) (result ListByDomainOperationResponse, err error)

ListByDomain ...

func (DomainTopicsClient) ListByDomainComplete 

func (c DomainTopicsClient) ListByDomainComplete(ctx context.Context, id DomainId, options ListByDomainOperationOptions) (ListByDomainCompleteResult, error)

ListByDomainComplete retrieves all the results into a single object

func (DomainTopicsClient) ListByDomainCompleteMatchingPredicate 

func (c DomainTopicsClient) ListByDomainCompleteMatchingPredicate(ctx context.Context, id DomainId, options ListByDomainOperationOptions, predicate DomainTopicOperationPredicate) (result ListByDomainCompleteResult, err error)

ListByDomainCompleteMatchingPredicate retrieves all the results and then applies the predicate

type GetOperationResponse 

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

type ListByDomainCompleteResult 

type ListByDomainCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []DomainTopic
}

type ListByDomainCustomPager added in v0.20240628.1153531 

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

type ListByDomainOperationOptions 

type ListByDomainOperationOptions struct {
	Filter *string
	Top    *int64
}

func DefaultListByDomainOperationOptions 

func DefaultListByDomainOperationOptions() ListByDomainOperationOptions

func (ListByDomainOperationOptions) ToHeaders 

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

func (ListByDomainOperationOptions) ToOData 

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

func (ListByDomainOperationOptions) ToQuery 

func (o ListByDomainOperationOptions) ToQuery() *client.QueryParams

type ListByDomainOperationResponse 

type ListByDomainOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]DomainTopic
}

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.