Help us shape the future of Go! Take the 2026 Go Developer Survey

queues

package
v0.2.7 Latest Latest
Warning

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

Go to latest
Published: Mar 30, 2021 License: Apache-2.0 Imports: 3 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func List

func List(client *golangsdk.ServiceClient, includeDeadLetter bool) pagination.Pager

List all the queues

Types

type CreateOps

type CreateOps struct {
	// Indicates the unique name of a queue.
	// A string of 1 to 64 characters that contain
	// a-z, A-Z, 0-9, hyphens (-), and underscores (_).
	// The name cannot be modified once specified.
	Name string `json:"name" required:"true"`

	// Indicates the queue type. Default value: NORMAL. Options:
	// NORMAL: Standard queue. Best-effort ordering.
	// FIFO: First-ln-First-out (FIFO) queue. FIFO delivery.
	// KAFKA_HA: High-availability Kafka queue.
	// KAFKA_HT: High-throughput Kafka queue.
	// AMQP: Advanced Message Queuing Protocol (AMQP) queue.
	QueueMode string `json:"queue_mode,omitempty"`

	// Indicates the basic information about a queue.
	// The queue description must be 0 to 160 characters in length,
	// and does not contain angle brackets (<) and (>).
	Description string `json:"description,omitempty"`

	// This parameter is mandatory only when queue_mode is NORMAL or FIFO.
	// Indicates whether to enable dead letter messages.
	// Default value: disable. Options: enable, disable.
	RedrivePolicy string `json:"redrive_policy,omitempty"`

	// This parameter is mandatory only when
	// redrive_policy is set to enable.
	// This parameter indicates the maximum number
	// of allowed message consumption failures.
	// Value range: 1-100.
	MaxConsumeCount int `json:"max_consume_count,omitempty"`

	// This parameter is mandatory only when
	// queue_mode is set to KAFKA_HA or KAFKA_HT.
	// This parameter indicates the retention time
	// of messages in Kafka queues.
	// Value range: 1 to 72 hours.
	RetentionHours int `json:"retention_hours,omitempty"`
}

CreateOps is a struct that contains all the parameters.

func (CreateOps) ToQueueCreateMap

func (ops CreateOps) ToQueueCreateMap() (map[string]interface{}, error)

ToQueueCreateMap is used for type convert

type CreateOpsBuilder

type CreateOpsBuilder interface {
	ToQueueCreateMap() (map[string]interface{}, error)
}

CreateOpsBuilder is used for creating queue parameters. any struct providing the parameters should implement this interface

type CreateResult

type CreateResult struct {
	golangsdk.Result
}

CreateResult is a struct that contains all the return parameters of creation

func Create

func Create(client *golangsdk.ServiceClient, ops CreateOpsBuilder) (r CreateResult)

Create a queue with given parameters.

func (CreateResult) Extract

func (r CreateResult) Extract() (*QueueCreate, error)

Extract from CreateResult

type DeleteResult

type DeleteResult struct {
	golangsdk.ErrResult
}

DeleteResult is a struct which contains the result of deletion

func Delete

func Delete(client *golangsdk.ServiceClient, id string) (r DeleteResult)

Delete a queue by id

type GetResult

type GetResult struct {
	golangsdk.Result
}

GetResult contains the body of getting detailed

func Get

func Get(client *golangsdk.ServiceClient, id string, includeDeadLetter bool) (r GetResult)

Get a queue with detailed information by id

func (GetResult) Extract

func (r GetResult) Extract() (*Queue, error)

Extract from GetResult

type Queue

type Queue struct {
	ID               string  `json:"id"`
	Name             string  `json:"name"`
	Created          float64 `json:"created"`
	Description      string  `json:"description"`
	QueueMode        string  `json:"queue_mode"`
	Reservation      int     `json:"reservation"`
	MaxMsgSizeByte   int     `json:"max_msg_size_byte"`
	ProducedMessages int     `json:"produced_messages"`
	RedrivePolicy    string  `json:"redrive_policy"`
	MaxConsumeCount  int     `json:"max_consume_count"`
	GroupCount       int     `json:"group_count"`
}

Queue response

func ExtractQueues

func ExtractQueues(r pagination.Page) ([]Queue, error)

ExtractQueues from List

type QueueCreate

type QueueCreate struct {
	ID         string `json:"id"`
	Name       string `json:"name"`
	KafkaTopic string `json:"kafka_topic"`
}

QueueCreate response

type QueuePage

type QueuePage struct {
	pagination.SinglePageBase
}

QueuePage may be embedded in a Page that contains all of the results from an operation at once.

func (QueuePage) IsEmpty

func (r QueuePage) IsEmpty() (bool, error)

IsEmpty returns true if a ListResult contains no queues.

Jump to

Keyboard shortcuts

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