queueservice

package
v0.20240903.1131440 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: 11 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/storage/2023-05-01/queueservice Documentation

The queueservice SDK allows for interaction with the Azure Resource Manager Service storage (API Version 2023-05-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/storage/2023-05-01/queueservice"

Client Initialization

client := queueservice.NewQueueServiceClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: QueueServiceClient.QueueCreate

ctx := context.TODO()
id := queueservice.NewQueueID("12345678-1234-9876-4563-123456789012", "example-resource-group", "storageAccountValue", "queueValue")

payload := queueservice.StorageQueue{
	// ...
}


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

Example Usage: QueueServiceClient.QueueDelete

ctx := context.TODO()
id := queueservice.NewQueueID("12345678-1234-9876-4563-123456789012", "example-resource-group", "storageAccountValue", "queueValue")

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

Example Usage: QueueServiceClient.QueueGet

ctx := context.TODO()
id := queueservice.NewQueueID("12345678-1234-9876-4563-123456789012", "example-resource-group", "storageAccountValue", "queueValue")

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

Example Usage: QueueServiceClient.QueueList

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

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

Example Usage: QueueServiceClient.QueueUpdate

ctx := context.TODO()
id := queueservice.NewQueueID("12345678-1234-9876-4563-123456789012", "example-resource-group", "storageAccountValue", "queueValue")

payload := queueservice.StorageQueue{
	// ...
}


read, err := client.QueueUpdate(ctx, id, payload)
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 ValidateQueueID

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

ValidateQueueID checks that 'input' can be parsed as a Queue ID

Types

type ListQueue

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

type ListQueueOperationPredicate

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

func (ListQueueOperationPredicate) Matches

func (p ListQueueOperationPredicate) Matches(input ListQueue) bool

type ListQueueProperties

type ListQueueProperties struct {
	Metadata *map[string]string `json:"metadata,omitempty"`
}

type QueueCreateOperationResponse

type QueueCreateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *StorageQueue
}

type QueueDeleteOperationResponse

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

type QueueGetOperationResponse

type QueueGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *StorageQueue
}

type QueueId

type QueueId struct {
	SubscriptionId     string
	ResourceGroupName  string
	StorageAccountName string
	QueueName          string
}

QueueId is a struct representing the Resource ID for a Queue

func NewQueueID

func NewQueueID(subscriptionId string, resourceGroupName string, storageAccountName string, queueName string) QueueId

NewQueueID returns a new QueueId struct

func ParseQueueID

func ParseQueueID(input string) (*QueueId, error)

ParseQueueID parses 'input' into a QueueId

func ParseQueueIDInsensitively

func ParseQueueIDInsensitively(input string) (*QueueId, error)

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

func (*QueueId) FromParseResult

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

func (QueueId) ID

func (id QueueId) ID() string

ID returns the formatted Queue ID

func (QueueId) Segments

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

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

func (QueueId) String

func (id QueueId) String() string

String returns a human-readable description of this Queue ID

type QueueListCompleteResult

type QueueListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ListQueue
}

type QueueListCustomPager added in v0.20240628.1153531

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

type QueueListOperationOptions

type QueueListOperationOptions struct {
	Filter      *string
	Maxpagesize *string
}

func DefaultQueueListOperationOptions

func DefaultQueueListOperationOptions() QueueListOperationOptions

func (QueueListOperationOptions) ToHeaders

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

func (QueueListOperationOptions) ToOData

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

func (QueueListOperationOptions) ToQuery

type QueueListOperationResponse

type QueueListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ListQueue
}

type QueueProperties

type QueueProperties struct {
	ApproximateMessageCount *int64             `json:"approximateMessageCount,omitempty"`
	Metadata                *map[string]string `json:"metadata,omitempty"`
}

type QueueServiceClient

type QueueServiceClient struct {
	Client *resourcemanager.Client
}

func NewQueueServiceClientWithBaseURI

func NewQueueServiceClientWithBaseURI(sdkApi sdkEnv.Api) (*QueueServiceClient, error)

func (QueueServiceClient) QueueCreate

func (c QueueServiceClient) QueueCreate(ctx context.Context, id QueueId, input StorageQueue) (result QueueCreateOperationResponse, err error)

QueueCreate ...

func (QueueServiceClient) QueueDelete

func (c QueueServiceClient) QueueDelete(ctx context.Context, id QueueId) (result QueueDeleteOperationResponse, err error)

QueueDelete ...

func (QueueServiceClient) QueueGet

func (c QueueServiceClient) QueueGet(ctx context.Context, id QueueId) (result QueueGetOperationResponse, err error)

QueueGet ...

func (QueueServiceClient) QueueList

QueueList ...

func (QueueServiceClient) QueueListComplete

QueueListComplete retrieves all the results into a single object

func (QueueServiceClient) QueueListCompleteMatchingPredicate

func (c QueueServiceClient) QueueListCompleteMatchingPredicate(ctx context.Context, id commonids.StorageAccountId, options QueueListOperationOptions, predicate ListQueueOperationPredicate) (result QueueListCompleteResult, err error)

QueueListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (QueueServiceClient) QueueUpdate

func (c QueueServiceClient) QueueUpdate(ctx context.Context, id QueueId, input StorageQueue) (result QueueUpdateOperationResponse, err error)

QueueUpdate ...

type QueueUpdateOperationResponse

type QueueUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *StorageQueue
}

type StorageQueue

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

Jump to

Keyboard shortcuts

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