topicspaces

package
v0.20240923.1151247 Latest Latest
Warning

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

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

README

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

The topicspaces SDK allows for interaction with Azure Resource Manager 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/topicspaces"

Client Initialization

client := topicspaces.NewTopicSpacesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: TopicSpacesClient.CreateOrUpdate

ctx := context.TODO()
id := topicspaces.NewTopicSpaceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "namespaceName", "topicSpaceName")

payload := topicspaces.TopicSpace{
	// ...
}


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

Example Usage: TopicSpacesClient.Delete

ctx := context.TODO()
id := topicspaces.NewTopicSpaceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "namespaceName", "topicSpaceName")

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

Example Usage: TopicSpacesClient.Get

ctx := context.TODO()
id := topicspaces.NewTopicSpaceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "namespaceName", "topicSpaceName")

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: TopicSpacesClient.ListByNamespace

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

// alternatively `client.ListByNamespace(ctx, id, topicspaces.DefaultListByNamespaceOperationOptions())` can be used to do batched pagination
items, err := client.ListByNamespaceComplete(ctx, id, topicspaces.DefaultListByNamespaceOperationOptions())
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 PossibleValuesForTopicSpaceProvisioningState

func PossibleValuesForTopicSpaceProvisioningState() []string

func ValidateNamespaceID

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

ValidateNamespaceID checks that 'input' can be parsed as a Namespace ID

func ValidateTopicSpaceID

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

ValidateTopicSpaceID checks that 'input' can be parsed as a Topic Space ID

Types

type CreateOrUpdateOperationResponse

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

type DeleteOperationResponse

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

type GetOperationResponse

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

type ListByNamespaceCompleteResult

type ListByNamespaceCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []TopicSpace
}

type ListByNamespaceCustomPager added in v0.20240628.1153531

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

type ListByNamespaceOperationOptions

type ListByNamespaceOperationOptions struct {
	Filter *string
	Top    *int64
}

func DefaultListByNamespaceOperationOptions

func DefaultListByNamespaceOperationOptions() ListByNamespaceOperationOptions

func (ListByNamespaceOperationOptions) ToHeaders

func (ListByNamespaceOperationOptions) ToOData

func (ListByNamespaceOperationOptions) ToQuery

type ListByNamespaceOperationResponse

type ListByNamespaceOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]TopicSpace
}

type NamespaceId

type NamespaceId struct {
	SubscriptionId    string
	ResourceGroupName string
	NamespaceName     string
}

NamespaceId is a struct representing the Resource ID for a Namespace

func NewNamespaceID

func NewNamespaceID(subscriptionId string, resourceGroupName string, namespaceName string) NamespaceId

NewNamespaceID returns a new NamespaceId struct

func ParseNamespaceID

func ParseNamespaceID(input string) (*NamespaceId, error)

ParseNamespaceID parses 'input' into a NamespaceId

func ParseNamespaceIDInsensitively

func ParseNamespaceIDInsensitively(input string) (*NamespaceId, error)

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

func (*NamespaceId) FromParseResult

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

func (NamespaceId) ID

func (id NamespaceId) ID() string

ID returns the formatted Namespace ID

func (NamespaceId) Segments

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

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

func (NamespaceId) String

func (id NamespaceId) String() string

String returns a human-readable description of this Namespace ID

type TopicSpace

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

type TopicSpaceId

type TopicSpaceId struct {
	SubscriptionId    string
	ResourceGroupName string
	NamespaceName     string
	TopicSpaceName    string
}

TopicSpaceId is a struct representing the Resource ID for a Topic Space

func NewTopicSpaceID

func NewTopicSpaceID(subscriptionId string, resourceGroupName string, namespaceName string, topicSpaceName string) TopicSpaceId

NewTopicSpaceID returns a new TopicSpaceId struct

func ParseTopicSpaceID

func ParseTopicSpaceID(input string) (*TopicSpaceId, error)

ParseTopicSpaceID parses 'input' into a TopicSpaceId

func ParseTopicSpaceIDInsensitively

func ParseTopicSpaceIDInsensitively(input string) (*TopicSpaceId, error)

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

func (*TopicSpaceId) FromParseResult

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

func (TopicSpaceId) ID

func (id TopicSpaceId) ID() string

ID returns the formatted Topic Space ID

func (TopicSpaceId) Segments

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

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

func (TopicSpaceId) String

func (id TopicSpaceId) String() string

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

type TopicSpaceOperationPredicate

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

func (TopicSpaceOperationPredicate) Matches

func (p TopicSpaceOperationPredicate) Matches(input TopicSpace) bool

type TopicSpaceProperties

type TopicSpaceProperties struct {
	Description       *string                      `json:"description,omitempty"`
	ProvisioningState *TopicSpaceProvisioningState `json:"provisioningState,omitempty"`
	TopicTemplates    *[]string                    `json:"topicTemplates,omitempty"`
}

type TopicSpaceProvisioningState

type TopicSpaceProvisioningState string
const (
	TopicSpaceProvisioningStateCanceled  TopicSpaceProvisioningState = "Canceled"
	TopicSpaceProvisioningStateCreating  TopicSpaceProvisioningState = "Creating"
	TopicSpaceProvisioningStateDeleted   TopicSpaceProvisioningState = "Deleted"
	TopicSpaceProvisioningStateDeleting  TopicSpaceProvisioningState = "Deleting"
	TopicSpaceProvisioningStateFailed    TopicSpaceProvisioningState = "Failed"
	TopicSpaceProvisioningStateSucceeded TopicSpaceProvisioningState = "Succeeded"
	TopicSpaceProvisioningStateUpdating  TopicSpaceProvisioningState = "Updating"
)

func (*TopicSpaceProvisioningState) UnmarshalJSON

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

type TopicSpacesClient

type TopicSpacesClient struct {
	Client *resourcemanager.Client
}

func NewTopicSpacesClientWithBaseURI

func NewTopicSpacesClientWithBaseURI(sdkApi sdkEnv.Api) (*TopicSpacesClient, error)

func (TopicSpacesClient) CreateOrUpdate

func (c TopicSpacesClient) CreateOrUpdate(ctx context.Context, id TopicSpaceId, input TopicSpace) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (TopicSpacesClient) CreateOrUpdateThenPoll

func (c TopicSpacesClient) CreateOrUpdateThenPoll(ctx context.Context, id TopicSpaceId, input TopicSpace) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (TopicSpacesClient) Delete

Delete ...

func (TopicSpacesClient) DeleteThenPoll

func (c TopicSpacesClient) DeleteThenPoll(ctx context.Context, id TopicSpaceId) error

DeleteThenPoll performs Delete then polls until it's completed

func (TopicSpacesClient) Get

Get ...

func (TopicSpacesClient) ListByNamespace

ListByNamespace ...

func (TopicSpacesClient) ListByNamespaceComplete

ListByNamespaceComplete retrieves all the results into a single object

func (TopicSpacesClient) ListByNamespaceCompleteMatchingPredicate

func (c TopicSpacesClient) ListByNamespaceCompleteMatchingPredicate(ctx context.Context, id NamespaceId, options ListByNamespaceOperationOptions, predicate TopicSpaceOperationPredicate) (result ListByNamespaceCompleteResult, err error)

ListByNamespaceCompleteMatchingPredicate retrieves all the results and then applies the predicate

Jump to

Keyboard shortcuts

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