generated

package
v1.0.0 Latest Latest
Warning

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

Go to latest
Published: May 9, 2023 License: MIT Imports: 14 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessPolicy

type AccessPolicy struct {
	// the date-time the policy expires
	Expiry *time.Time `xml:"Expiry"`

	// the permissions for the acl policy
	Permission *string `xml:"Permission"`

	// the date-time the policy is active
	Start *time.Time `xml:"Start"`
}

AccessPolicy - An Access policy

func (AccessPolicy) MarshalXML

func (a AccessPolicy) MarshalXML(enc *xml.Encoder, start xml.StartElement) error

MarshalXML implements the xml.Marshaller interface for type AccessPolicy.

func (*AccessPolicy) UnmarshalXML

func (a *AccessPolicy) UnmarshalXML(dec *xml.Decoder, start xml.StartElement) error

UnmarshalXML implements the xml.Unmarshaller interface for type AccessPolicy.

type CORSRule

type CORSRule struct {
	// REQUIRED; the request headers that the origin domain may specify on the CORS request.
	AllowedHeaders *string `xml:"AllowedHeaders"`

	// REQUIRED; The methods (HTTP request verbs) that the origin domain may use for a CORS request. (comma separated)
	AllowedMethods *string `xml:"AllowedMethods"`

	// REQUIRED; The origin domains that are permitted to make a request against the storage service via CORS. The origin domain
	// is the domain from which the request originates. Note that the origin must be an exact
	// case-sensitive match with the origin that the user age sends to the service. You can also use the wildcard character '*'
	// to allow all origin domains to make requests via CORS.
	AllowedOrigins *string `xml:"AllowedOrigins"`

	// REQUIRED; The response headers that may be sent in the response to the CORS request and exposed by the browser to the request
	// issuer
	ExposedHeaders *string `xml:"ExposedHeaders"`

	// REQUIRED; The maximum amount time that a browser should cache the preflight OPTIONS request.
	MaxAgeInSeconds *int32 `xml:"MaxAgeInSeconds"`
}

CORSRule - CORS is an HTTP feature that enables a web application running under one domain to access resources in another domain. Web browsers implement a security restriction known as same-origin policy that prevents a web page from calling APIs in a different domain; CORS provides a secure way to allow one domain (the origin domain) to call APIs in another domain

type DequeuedMessage

type DequeuedMessage struct {
	// REQUIRED; The number of times the message has been dequeued.
	DequeueCount *int64 `xml:"DequeueCount"`

	// REQUIRED; The time that the Message will expire and be automatically deleted.
	ExpirationTime *time.Time `xml:"ExpirationTime"`

	// REQUIRED; The time the Message was inserted into the Queue.
	InsertionTime *time.Time `xml:"InsertionTime"`

	// REQUIRED; The Id of the Message.
	MessageID *string `xml:"MessageId"`

	// REQUIRED; The content of the Message.
	MessageText *string `xml:"MessageText"`

	// REQUIRED; This value is required to delete the Message. If deletion fails using this popreceipt then the message has been
	// dequeued by another client.
	PopReceipt *string `xml:"PopReceipt"`

	// REQUIRED; The time that the message will again become visible in the Queue.
	TimeNextVisible *time.Time `xml:"TimeNextVisible"`
}

DequeuedMessage - The object returned in the QueueMessageList array when calling Get Messages on a Queue.

func (DequeuedMessage) MarshalXML

func (d DequeuedMessage) MarshalXML(enc *xml.Encoder, start xml.StartElement) error

MarshalXML implements the xml.Marshaller interface for type DequeuedMessage.

func (*DequeuedMessage) UnmarshalXML

func (d *DequeuedMessage) UnmarshalXML(dec *xml.Decoder, start xml.StartElement) error

UnmarshalXML implements the xml.Unmarshaller interface for type DequeuedMessage.

type EnqueuedMessage

type EnqueuedMessage struct {
	// REQUIRED; The time that the Message will expire and be automatically deleted.
	ExpirationTime *time.Time `xml:"ExpirationTime"`

	// REQUIRED; The time the Message was inserted into the Queue.
	InsertionTime *time.Time `xml:"InsertionTime"`

	// REQUIRED; The Id of the Message.
	MessageID *string `xml:"MessageId"`

	// REQUIRED; This value is required to delete the Message. If deletion fails using this popreceipt then the message has been
	// dequeued by another client.
	PopReceipt *string `xml:"PopReceipt"`

	// REQUIRED; The time that the message will again become visible in the Queue.
	TimeNextVisible *time.Time `xml:"TimeNextVisible"`
}

EnqueuedMessage - The object returned in the QueueMessageList array when calling Put Message on a Queue

func (EnqueuedMessage) MarshalXML

func (e EnqueuedMessage) MarshalXML(enc *xml.Encoder, start xml.StartElement) error

MarshalXML implements the xml.Marshaller interface for type EnqueuedMessage.

func (*EnqueuedMessage) UnmarshalXML

func (e *EnqueuedMessage) UnmarshalXML(dec *xml.Decoder, start xml.StartElement) error

UnmarshalXML implements the xml.Unmarshaller interface for type EnqueuedMessage.

type GeoReplication

type GeoReplication struct {
	// REQUIRED; A GMT date/time value, to the second. All primary writes preceding this value are guaranteed to be available
	// for read operations at the secondary. Primary writes after this point in time may or may
	// not be available for reads.
	LastSyncTime *time.Time `xml:"LastSyncTime"`

	// REQUIRED; The status of the secondary location
	Status *GeoReplicationStatus `xml:"Status"`
}

func (GeoReplication) MarshalXML

func (g GeoReplication) MarshalXML(enc *xml.Encoder, start xml.StartElement) error

MarshalXML implements the xml.Marshaller interface for type GeoReplication.

func (*GeoReplication) UnmarshalXML

func (g *GeoReplication) UnmarshalXML(dec *xml.Decoder, start xml.StartElement) error

UnmarshalXML implements the xml.Unmarshaller interface for type GeoReplication.

type GeoReplicationStatus

type GeoReplicationStatus string

GeoReplicationStatus - The status of the secondary location

const (
	GeoReplicationStatusLive        GeoReplicationStatus = "live"
	GeoReplicationStatusBootstrap   GeoReplicationStatus = "bootstrap"
	GeoReplicationStatusUnavailable GeoReplicationStatus = "unavailable"
)

func PossibleGeoReplicationStatusValues

func PossibleGeoReplicationStatusValues() []GeoReplicationStatus

PossibleGeoReplicationStatusValues returns the possible values for the GeoReplicationStatus const type.

type ListQueuesSegmentResponse

type ListQueuesSegmentResponse struct {
	// REQUIRED
	MaxResults *int32 `xml:"MaxResults"`

	// REQUIRED
	NextMarker *string `xml:"NextMarker"`

	// REQUIRED
	Prefix *string `xml:"Prefix"`

	// REQUIRED
	ServiceEndpoint *string  `xml:"ServiceEndpoint,attr"`
	Marker          *string  `xml:"Marker"`
	Queues          []*Queue `xml:"Queues>Queue"`
}

ListQueuesSegmentResponse - The object returned when calling List Queues on a Queue Service.

func (ListQueuesSegmentResponse) MarshalXML

func (l ListQueuesSegmentResponse) MarshalXML(enc *xml.Encoder, start xml.StartElement) error

MarshalXML implements the xml.Marshaller interface for type ListQueuesSegmentResponse.

type Logging

type Logging struct {
	// REQUIRED; Indicates whether all delete requests should be logged.
	Delete *bool `xml:"Delete"`

	// REQUIRED; Indicates whether all read requests should be logged.
	Read *bool `xml:"Read"`

	// REQUIRED; the retention policy
	RetentionPolicy *RetentionPolicy `xml:"RetentionPolicy"`

	// REQUIRED; The version of Storage Analytics to configure.
	Version *string `xml:"Version"`

	// REQUIRED; Indicates whether all write requests should be logged.
	Write *bool `xml:"Write"`
}

Logging - Azure Analytics Logging settings.

type MessageIDClient

type MessageIDClient struct {
	// contains filtered or unexported fields
}

MessageIDClient contains the methods for the MessageID group. Don't use this type directly, use NewMessageIDClient() instead.

func NewMessageIDClient

func NewMessageIDClient(endpoint string, pl runtime.Pipeline) *MessageIDClient

NewMessageIDClient creates a new instance of MessageIDClient with the specified values.

  • endpoint - The URL of the service account, queue or message that is the target of the desired operation.
  • pl - the pipeline used for sending requests and handling responses.

func (*MessageIDClient) Delete

Delete - The Delete operation deletes the specified message. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2018-03-28

  • popReceipt - Required. Specifies the valid pop receipt value returned from an earlier call to the Get Messages or Update Message operation.
  • options - MessageIDClientDeleteOptions contains the optional parameters for the MessageIDClient.Delete method.

func (*MessageIDClient) Update

func (client *MessageIDClient) Update(ctx context.Context, popReceipt string, queueMessage QueueMessage, options *MessageIDClientUpdateOptions) (MessageIDClientUpdateResponse, error)

Update - The Update operation was introduced with version 2011-08-18 of the Queue service API. The Update Message operation updates the visibility timeout of a message. You can also use this operation to update the contents of a message. A message must be in a format that can be included in an XML request with UTF-8 encoding, and the encoded message can be up to 64KB in size. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2018-03-28

  • popReceipt - Required. Specifies the valid pop receipt value returned from an earlier call to the Get Messages or Update Message operation.
  • queueMessage - A Message object which can be stored in a Queue
  • options - MessageIDClientUpdateOptions contains the optional parameters for the MessageIDClient.Update method.

type MessageIDClientDeleteOptions

type MessageIDClientDeleteOptions struct {
	// Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage
	// analytics logging is enabled.
	RequestID *string
	// The The timeout parameter is expressed in seconds. For more information, see
	Timeout *int32
}

MessageIDClientDeleteOptions contains the optional parameters for the MessageIDClient.Delete method.

type MessageIDClientDeleteResponse

type MessageIDClientDeleteResponse struct {
	// Date contains the information returned from the Date header response.
	Date *time.Time

	// RequestID contains the information returned from the x-ms-request-id header response.
	RequestID *string

	// Version contains the information returned from the x-ms-version header response.
	Version *string
}

MessageIDClientDeleteResponse contains the response from method MessageIDClient.Delete.

type MessageIDClientUpdateOptions

type MessageIDClientUpdateOptions struct {
	// Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage
	// analytics logging is enabled.
	RequestID *string
	// The The timeout parameter is expressed in seconds. For more information, see
	Timeout *int32
	// Optional. Specifies the new visibility timeout value, in seconds, relative to server time. The default value is 30 seconds.
	// A specified value must be larger than or equal to 1 second, and cannot be
	// larger than 7 days, or larger than 2 hours on REST protocol versions prior to version 2011-08-18. The visibility timeout
	// of a message can be set to a value later than the expiry time.
	Visibilitytimeout *int32
}

MessageIDClientUpdateOptions contains the optional parameters for the MessageIDClient.Update method.

type MessageIDClientUpdateResponse

type MessageIDClientUpdateResponse struct {
	// Date contains the information returned from the Date header response.
	Date *time.Time

	// PopReceipt contains the information returned from the x-ms-popreceipt header response.
	PopReceipt *string

	// RequestID contains the information returned from the x-ms-request-id header response.
	RequestID *string

	// TimeNextVisible contains the information returned from the x-ms-time-next-visible header response.
	TimeNextVisible *time.Time

	// Version contains the information returned from the x-ms-version header response.
	Version *string
}

MessageIDClientUpdateResponse contains the response from method MessageIDClient.Update.

type MessagesClient

type MessagesClient struct {
	// contains filtered or unexported fields
}

MessagesClient contains the methods for the Messages group. Don't use this type directly, use NewMessagesClient() instead.

func NewMessagesClient

func NewMessagesClient(endpoint string, pl runtime.Pipeline) *MessagesClient

NewMessagesClient creates a new instance of MessagesClient with the specified values.

  • endpoint - The URL of the service account, queue or message that is the target of the desired operation.
  • pl - the pipeline used for sending requests and handling responses.

func (*MessagesClient) Clear

Clear - The Clear operation deletes all messages from the specified queue. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2018-03-28

  • options - MessagesClientClearOptions contains the optional parameters for the MessagesClient.Clear method.

func (*MessagesClient) Dequeue

Dequeue - The Dequeue operation retrieves one or more messages from the front of the queue. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2018-03-28

  • options - MessagesClientDequeueOptions contains the optional parameters for the MessagesClient.Dequeue method.

func (*MessagesClient) Enqueue

Enqueue - The Enqueue operation adds a new message to the back of the message queue. A visibility timeout can also be specified to make the message invisible until the visibility timeout expires. A message must be in a format that can be included in an XML request with UTF-8 encoding. The encoded message can be up to 64 KB in size for versions 2011-08-18 and newer, or 8 KB in size for previous versions. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2018-03-28

  • queueMessage - A Message object which can be stored in a Queue
  • options - MessagesClientEnqueueOptions contains the optional parameters for the MessagesClient.Enqueue method.

func (*MessagesClient) Peek

Peek - The Peek operation retrieves one or more messages from the front of the queue, but does not alter the visibility of the message. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2018-03-28

  • options - MessagesClientPeekOptions contains the optional parameters for the MessagesClient.Peek method.

type MessagesClientClearOptions

type MessagesClientClearOptions struct {
	// Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage
	// analytics logging is enabled.
	RequestID *string
	// The The timeout parameter is expressed in seconds. For more information, see
	Timeout *int32
}

MessagesClientClearOptions contains the optional parameters for the MessagesClient.Clear method.

type MessagesClientClearResponse

type MessagesClientClearResponse struct {
	// Date contains the information returned from the Date header response.
	Date *time.Time

	// RequestID contains the information returned from the x-ms-request-id header response.
	RequestID *string

	// Version contains the information returned from the x-ms-version header response.
	Version *string
}

MessagesClientClearResponse contains the response from method MessagesClient.Clear.

type MessagesClientDequeueOptions

type MessagesClientDequeueOptions struct {
	// Optional. A nonzero integer value that specifies the number of messages to retrieve from the queue, up to a maximum of
	// 32. If fewer are visible, the visible messages are returned. By default, a single
	// message is retrieved from the queue with this operation.
	NumberOfMessages *int32
	// Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage
	// analytics logging is enabled.
	RequestID *string
	// The The timeout parameter is expressed in seconds. For more information, see
	Timeout *int32
	// Optional. Specifies the new visibility timeout value, in seconds, relative to server time. The default value is 30 seconds.
	// A specified value must be larger than or equal to 1 second, and cannot be
	// larger than 7 days, or larger than 2 hours on REST protocol versions prior to version 2011-08-18. The visibility timeout
	// of a message can be set to a value later than the expiry time.
	Visibilitytimeout *int32
}

MessagesClientDequeueOptions contains the optional parameters for the MessagesClient.Dequeue method.

type MessagesClientDequeueResponse

type MessagesClientDequeueResponse struct {
	// Date contains the information returned from the Date header response.
	Date *time.Time `xml:"Date"`

	// The object returned when calling Get Messages on a Queue
	Messages []*DequeuedMessage `xml:"QueueMessage"`

	// RequestID contains the information returned from the x-ms-request-id header response.
	RequestID *string `xml:"RequestID"`

	// Version contains the information returned from the x-ms-version header response.
	Version *string `xml:"Version"`
}

MessagesClientDequeueResponse contains the response from method MessagesClient.Dequeue.

type MessagesClientEnqueueOptions

type MessagesClientEnqueueOptions struct {
	// Optional. Specifies the time-to-live interval for the message, in seconds. Prior to version 2017-07-29, the maximum time-to-live
	// allowed is 7 days. For version 2017-07-29 or later, the maximum
	// time-to-live can be any positive number, as well as -1 indicating that the message does not expire. If this parameter is
	// omitted, the default time-to-live is 7 days.
	MessageTimeToLive *int32
	// Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage
	// analytics logging is enabled.
	RequestID *string
	// The The timeout parameter is expressed in seconds. For more information, see
	Timeout *int32
	// Optional. If specified, the request must be made using an x-ms-version of 2011-08-18 or later. If not specified, the default
	// value is 0. Specifies the new visibility timeout value, in seconds,
	// relative to server time. The new value must be larger than or equal to 0, and cannot be larger than 7 days. The visibility
	// timeout of a message cannot be set to a value later than the expiry time.
	// visibilitytimeout should be set to a value smaller than the time-to-live value.
	Visibilitytimeout *int32
}

MessagesClientEnqueueOptions contains the optional parameters for the MessagesClient.Enqueue method.

type MessagesClientEnqueueResponse

type MessagesClientEnqueueResponse struct {
	// Date contains the information returned from the Date header response.
	Date *time.Time `xml:"Date"`

	// The object returned when calling Put Message on a Queue
	Messages []*EnqueuedMessage `xml:"QueueMessage"`

	// RequestID contains the information returned from the x-ms-request-id header response.
	RequestID *string `xml:"RequestID"`

	// Version contains the information returned from the x-ms-version header response.
	Version *string `xml:"Version"`
}

MessagesClientEnqueueResponse contains the response from method MessagesClient.Enqueue.

type MessagesClientPeekOptions

type MessagesClientPeekOptions struct {
	// Optional. A nonzero integer value that specifies the number of messages to retrieve from the queue, up to a maximum of
	// 32. If fewer are visible, the visible messages are returned. By default, a single
	// message is retrieved from the queue with this operation.
	NumberOfMessages *int32
	// Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage
	// analytics logging is enabled.
	RequestID *string
	// The The timeout parameter is expressed in seconds. For more information, see
	Timeout *int32
}

MessagesClientPeekOptions contains the optional parameters for the MessagesClient.Peek method.

type MessagesClientPeekResponse

type MessagesClientPeekResponse struct {
	// Date contains the information returned from the Date header response.
	Date *time.Time `xml:"Date"`

	// The object returned when calling Peek Messages on a Queue
	Messages []*PeekedMessage `xml:"QueueMessage"`

	// RequestID contains the information returned from the x-ms-request-id header response.
	RequestID *string `xml:"RequestID"`

	// Version contains the information returned from the x-ms-version header response.
	Version *string `xml:"Version"`
}

MessagesClientPeekResponse contains the response from method MessagesClient.Peek.

type Metrics

type Metrics struct {
	// REQUIRED; Indicates whether metrics are enabled for the Queue service.
	Enabled *bool `xml:"Enabled"`

	// Indicates whether metrics should generate summary statistics for called API operations.
	IncludeAPIs *bool `xml:"IncludeAPIs"`

	// the retention policy
	RetentionPolicy *RetentionPolicy `xml:"RetentionPolicy"`

	// The version of Storage Analytics to configure.
	Version *string `xml:"Version"`
}

Metrics - a summary of request statistics grouped by API in hour or minute aggregates for queues

type PeekedMessage

type PeekedMessage struct {
	// REQUIRED; The number of times the message has been dequeued.
	DequeueCount *int64 `xml:"DequeueCount"`

	// REQUIRED; The time that the Message will expire and be automatically deleted.
	ExpirationTime *time.Time `xml:"ExpirationTime"`

	// REQUIRED; The time the Message was inserted into the Queue.
	InsertionTime *time.Time `xml:"InsertionTime"`

	// REQUIRED; The Id of the Message.
	MessageID *string `xml:"MessageId"`

	// REQUIRED; The content of the Message.
	MessageText *string `xml:"MessageText"`
}

PeekedMessage - The object returned in the QueueMessageList array when calling Peek Messages on a Queue

func (PeekedMessage) MarshalXML

func (p PeekedMessage) MarshalXML(enc *xml.Encoder, start xml.StartElement) error

MarshalXML implements the xml.Marshaller interface for type PeekedMessage.

func (*PeekedMessage) UnmarshalXML

func (p *PeekedMessage) UnmarshalXML(dec *xml.Decoder, start xml.StartElement) error

UnmarshalXML implements the xml.Unmarshaller interface for type PeekedMessage.

type Queue

type Queue struct {
	// REQUIRED; The name of the Queue.
	Name *string `xml:"Name"`

	// Dictionary of
	Metadata map[string]*string `xml:"Metadata"`
}

Queue - An Azure Storage Queue.

func (*Queue) UnmarshalXML

func (q *Queue) UnmarshalXML(dec *xml.Decoder, start xml.StartElement) error

UnmarshalXML implements the xml.Unmarshaller interface for type Queue.

type QueueClient

type QueueClient struct {
	// contains filtered or unexported fields
}

QueueClient contains the methods for the Queue group. Don't use this type directly, use NewQueueClient() instead.

func NewQueueClient

func NewQueueClient(endpoint string, pl runtime.Pipeline) *QueueClient

NewQueueClient creates a new instance of QueueClient with the specified values.

  • endpoint - The URL of the service account, queue or message that is the target of the desired operation.
  • pl - the pipeline used for sending requests and handling responses.

func (*QueueClient) Create

Create - creates a new queue under the given account. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2018-03-28

  • options - QueueClientCreateOptions contains the optional parameters for the QueueClient.Create method.

func (*QueueClient) Delete

Delete - operation permanently deletes the specified queue If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2018-03-28

  • options - QueueClientDeleteOptions contains the optional parameters for the QueueClient.Delete method.

func (*QueueClient) Endpoint

func (client *QueueClient) Endpoint() string

func (*QueueClient) GetAccessPolicy

GetAccessPolicy - returns details about any stored access policies specified on the queue that may be used with Shared Access Signatures. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2018-03-28

  • options - QueueClientGetAccessPolicyOptions contains the optional parameters for the QueueClient.GetAccessPolicy method.

func (*QueueClient) GetProperties

GetProperties - Retrieves user-defined metadata and queue properties on the specified queue. Metadata is associated with the queue as name-values pairs. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2018-03-28

  • options - QueueClientGetPropertiesOptions contains the optional parameters for the QueueClient.GetProperties method.

func (*QueueClient) Pipeline

func (client *QueueClient) Pipeline() runtime.Pipeline

func (*QueueClient) SetAccessPolicy

SetAccessPolicy - sets stored access policies for the queue that may be used with Shared Access Signatures If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2018-03-28

  • queueACL - the acls for the queue
  • options - QueueClientSetAccessPolicyOptions contains the optional parameters for the QueueClient.SetAccessPolicy method.

func (*QueueClient) SetMetadata

SetMetadata - sets user-defined metadata on the specified queue. Metadata is associated with the queue as name-value pairs. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2018-03-28

  • options - QueueClientSetMetadataOptions contains the optional parameters for the QueueClient.SetMetadata method.

type QueueClientCreateOptions

type QueueClientCreateOptions struct {
	// Optional. Include this parameter to specify that the queue's metadata be returned as part of the response body. Note that
	// metadata requested with this parameter must be stored in accordance with the
	// naming restrictions imposed by the 2009-09-19 version of the Queue service. Beginning with this version, all metadata names
	// must adhere to the naming conventions for C# identifiers.
	Metadata map[string]*string
	// Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage
	// analytics logging is enabled.
	RequestID *string
	// The The timeout parameter is expressed in seconds. For more information, see
	Timeout *int32
}

QueueClientCreateOptions contains the optional parameters for the QueueClient.Create method.

type QueueClientCreateResponse

type QueueClientCreateResponse struct {
	// Date contains the information returned from the Date header response.
	Date *time.Time

	// RequestID contains the information returned from the x-ms-request-id header response.
	RequestID *string

	// Version contains the information returned from the x-ms-version header response.
	Version *string
}

QueueClientCreateResponse contains the response from method QueueClient.Create.

type QueueClientDeleteOptions

type QueueClientDeleteOptions struct {
	// Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage
	// analytics logging is enabled.
	RequestID *string
	// The The timeout parameter is expressed in seconds. For more information, see
	Timeout *int32
}

QueueClientDeleteOptions contains the optional parameters for the QueueClient.Delete method.

type QueueClientDeleteResponse

type QueueClientDeleteResponse struct {
	// Date contains the information returned from the Date header response.
	Date *time.Time

	// RequestID contains the information returned from the x-ms-request-id header response.
	RequestID *string

	// Version contains the information returned from the x-ms-version header response.
	Version *string
}

QueueClientDeleteResponse contains the response from method QueueClient.Delete.

type QueueClientGetAccessPolicyOptions

type QueueClientGetAccessPolicyOptions struct {
	// Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage
	// analytics logging is enabled.
	RequestID *string
	// The The timeout parameter is expressed in seconds. For more information, see
	Timeout *int32
}

QueueClientGetAccessPolicyOptions contains the optional parameters for the QueueClient.GetAccessPolicy method.

type QueueClientGetAccessPolicyResponse

type QueueClientGetAccessPolicyResponse struct {
	// Date contains the information returned from the Date header response.
	Date *time.Time `xml:"Date"`

	// RequestID contains the information returned from the x-ms-request-id header response.
	RequestID *string `xml:"RequestID"`

	// a collection of signed identifiers
	SignedIdentifiers []*SignedIdentifier `xml:"SignedIdentifier"`

	// Version contains the information returned from the x-ms-version header response.
	Version *string `xml:"Version"`
}

QueueClientGetAccessPolicyResponse contains the response from method QueueClient.GetAccessPolicy.

type QueueClientGetPropertiesOptions

type QueueClientGetPropertiesOptions struct {
	// Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage
	// analytics logging is enabled.
	RequestID *string
	// The The timeout parameter is expressed in seconds. For more information, see
	Timeout *int32
}

QueueClientGetPropertiesOptions contains the optional parameters for the QueueClient.GetProperties method.

type QueueClientGetPropertiesResponse

type QueueClientGetPropertiesResponse struct {
	// ApproximateMessagesCount contains the information returned from the x-ms-approximate-messages-count header response.
	ApproximateMessagesCount *int32

	// Date contains the information returned from the Date header response.
	Date *time.Time

	// Metadata contains the information returned from the x-ms-meta header response.
	Metadata map[string]*string

	// RequestID contains the information returned from the x-ms-request-id header response.
	RequestID *string

	// Version contains the information returned from the x-ms-version header response.
	Version *string
}

QueueClientGetPropertiesResponse contains the response from method QueueClient.GetProperties.

type QueueClientSetAccessPolicyOptions

type QueueClientSetAccessPolicyOptions struct {
	// Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage
	// analytics logging is enabled.
	RequestID *string
	// The The timeout parameter is expressed in seconds. For more information, see
	Timeout *int32
}

QueueClientSetAccessPolicyOptions contains the optional parameters for the QueueClient.SetAccessPolicy method.

type QueueClientSetAccessPolicyResponse

type QueueClientSetAccessPolicyResponse struct {
	// Date contains the information returned from the Date header response.
	Date *time.Time

	// RequestID contains the information returned from the x-ms-request-id header response.
	RequestID *string

	// Version contains the information returned from the x-ms-version header response.
	Version *string
}

QueueClientSetAccessPolicyResponse contains the response from method QueueClient.SetAccessPolicy.

type QueueClientSetMetadataOptions

type QueueClientSetMetadataOptions struct {
	// Optional. Include this parameter to specify that the queue's metadata be returned as part of the response body. Note that
	// metadata requested with this parameter must be stored in accordance with the
	// naming restrictions imposed by the 2009-09-19 version of the Queue service. Beginning with this version, all metadata names
	// must adhere to the naming conventions for C# identifiers.
	Metadata map[string]*string
	// Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage
	// analytics logging is enabled.
	RequestID *string
	// The The timeout parameter is expressed in seconds. For more information, see
	Timeout *int32
}

QueueClientSetMetadataOptions contains the optional parameters for the QueueClient.SetMetadata method.

type QueueClientSetMetadataResponse

type QueueClientSetMetadataResponse struct {
	// Date contains the information returned from the Date header response.
	Date *time.Time

	// RequestID contains the information returned from the x-ms-request-id header response.
	RequestID *string

	// Version contains the information returned from the x-ms-version header response.
	Version *string
}

QueueClientSetMetadataResponse contains the response from method QueueClient.SetMetadata.

type QueueMessage

type QueueMessage struct {
	// REQUIRED; The content of the message
	MessageText *string `xml:"MessageText"`
}

QueueMessage - A Message object which can be stored in a Queue

type RetentionPolicy

type RetentionPolicy struct {
	// REQUIRED; Indicates whether a retention policy is enabled for the storage service
	Enabled *bool `xml:"Enabled"`

	// Indicates the number of days that metrics or logging or soft-deleted data should be retained. All data older than this
	// value will be deleted
	Days *int32 `xml:"Days"`
}

RetentionPolicy - the retention policy

type ServiceClient

type ServiceClient struct {
	// contains filtered or unexported fields
}

ServiceClient contains the methods for the Service group. Don't use this type directly, use NewServiceClient() instead.

func NewServiceClient

func NewServiceClient(endpoint string, pl runtime.Pipeline) *ServiceClient

NewServiceClient creates a new instance of ServiceClient with the specified values.

  • endpoint - The URL of the service account, queue or message that is the target of the desired operation.
  • pl - the pipeline used for sending requests and handling responses.

func (*ServiceClient) Endpoint

func (client *ServiceClient) Endpoint() string

func (*ServiceClient) GetProperties

GetProperties - gets the properties of a storage account's Queue service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2018-03-28

  • options - ServiceClientGetPropertiesOptions contains the optional parameters for the ServiceClient.GetProperties method.

func (*ServiceClient) GetStatistics

GetStatistics - Retrieves statistics related to replication for the Queue service. It is only available on the secondary location endpoint when read-access geo-redundant replication is enabled for the storage account. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2018-03-28

  • options - ServiceClientGetStatisticsOptions contains the optional parameters for the ServiceClient.GetStatistics method.

func (*ServiceClient) ListQueuesSegmentCreateRequest

func (client *ServiceClient) ListQueuesSegmentCreateRequest(ctx context.Context, options *ServiceClientListQueuesSegmentOptions) (*policy.Request, error)

NewListQueuesSegmentPager - The List Queues Segment operation returns a list of the queues under the specified account

Generated from API version 2018-03-28

  • options - ServiceClientListQueuesSegmentOptions contains the optional parameters for the ServiceClient.NewListQueuesSegmentPager method.

ListQueuesSegmentCreateRequest creates the ListQueuesFlatSegment ListQueuesSegment.

func (*ServiceClient) ListQueuesSegmentHandleResponse

func (client *ServiceClient) ListQueuesSegmentHandleResponse(resp *http.Response) (ServiceClientListQueuesSegmentResponse, error)

listQueuesSegmentHandleResponse handles the ListQueuesSegment response.

func (*ServiceClient) Pipeline

func (client *ServiceClient) Pipeline() runtime.Pipeline

func (*ServiceClient) SetProperties

SetProperties - Sets properties for a storage account's Queue service endpoint, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2018-03-28

  • storageServiceProperties - The StorageService properties.
  • options - ServiceClientSetPropertiesOptions contains the optional parameters for the ServiceClient.SetProperties method.

type ServiceClientGetPropertiesOptions

type ServiceClientGetPropertiesOptions struct {
	// Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage
	// analytics logging is enabled.
	RequestID *string
	// The The timeout parameter is expressed in seconds. For more information, see
	Timeout *int32
}

ServiceClientGetPropertiesOptions contains the optional parameters for the ServiceClient.GetProperties method.

type ServiceClientGetPropertiesResponse

type ServiceClientGetPropertiesResponse struct {
	StorageServiceProperties
	// RequestID contains the information returned from the x-ms-request-id header response.
	RequestID *string `xml:"RequestID"`

	// Version contains the information returned from the x-ms-version header response.
	Version *string `xml:"Version"`
}

ServiceClientGetPropertiesResponse contains the response from method ServiceClient.GetProperties.

type ServiceClientGetStatisticsOptions

type ServiceClientGetStatisticsOptions struct {
	// Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage
	// analytics logging is enabled.
	RequestID *string
	// The The timeout parameter is expressed in seconds. For more information, see
	Timeout *int32
}

ServiceClientGetStatisticsOptions contains the optional parameters for the ServiceClient.GetStatistics method.

type ServiceClientGetStatisticsResponse

type ServiceClientGetStatisticsResponse struct {
	StorageServiceStats
	// Date contains the information returned from the Date header response.
	Date *time.Time `xml:"Date"`

	// RequestID contains the information returned from the x-ms-request-id header response.
	RequestID *string `xml:"RequestID"`

	// Version contains the information returned from the x-ms-version header response.
	Version *string `xml:"Version"`
}

ServiceClientGetStatisticsResponse contains the response from method ServiceClient.GetStatistics.

type ServiceClientListQueuesSegmentOptions

type ServiceClientListQueuesSegmentOptions struct {
	// Include this parameter to specify that the queues' metadata be returned as part of the response body.
	Include []string
	// A string value that identifies the portion of the list of queues to be returned with the next listing operation. The operation
	// returns the NextMarker value within the response body if the listing
	// operation did not return all queues remaining to be listed with the current page. The NextMarker value can be used as the
	// value for the marker parameter in a subsequent call to request the next page
	// of list items. The marker value is opaque to the client.
	Marker *string
	// Specifies the maximum number of queues to return. If the request does not specify maxresults, or specifies a value greater
	// than 5000, the server will return up to 5000 items. Note that if the listing
	// operation crosses a partition boundary, then the service will return a continuation token for retrieving the remainder
	// of the results. For this reason, it is possible that the service will return
	// fewer results than specified by maxresults, or than the default of 5000.
	Maxresults *int32
	// Filters the results to return only queues whose name begins with the specified prefix.
	Prefix *string
	// Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage
	// analytics logging is enabled.
	RequestID *string
	// The The timeout parameter is expressed in seconds. For more information, see
	Timeout *int32
}

ServiceClientListQueuesSegmentOptions contains the optional parameters for the ServiceClient.NewListQueuesSegmentPager method.

type ServiceClientListQueuesSegmentResponse

type ServiceClientListQueuesSegmentResponse struct {
	ListQueuesSegmentResponse
	// Date contains the information returned from the Date header response.
	Date *time.Time `xml:"Date"`

	// RequestID contains the information returned from the x-ms-request-id header response.
	RequestID *string `xml:"RequestID"`

	// Version contains the information returned from the x-ms-version header response.
	Version *string `xml:"Version"`
}

ServiceClientListQueuesSegmentResponse contains the response from method ServiceClient.NewListQueuesSegmentPager.

type ServiceClientSetPropertiesOptions

type ServiceClientSetPropertiesOptions struct {
	// Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage
	// analytics logging is enabled.
	RequestID *string
	// The The timeout parameter is expressed in seconds. For more information, see
	Timeout *int32
}

ServiceClientSetPropertiesOptions contains the optional parameters for the ServiceClient.SetProperties method.

type ServiceClientSetPropertiesResponse

type ServiceClientSetPropertiesResponse struct {
	// RequestID contains the information returned from the x-ms-request-id header response.
	RequestID *string

	// Version contains the information returned from the x-ms-version header response.
	Version *string
}

ServiceClientSetPropertiesResponse contains the response from method ServiceClient.SetProperties.

type SignedIdentifier

type SignedIdentifier struct {
	// REQUIRED; The access policy
	AccessPolicy *AccessPolicy `xml:"AccessPolicy"`

	// REQUIRED; a unique id
	ID *string `xml:"Id"`
}

SignedIdentifier - signed identifier

type StorageError

type StorageError struct {
	Message *string `json:"Message,omitempty"`
}

func (StorageError) MarshalJSON

func (s StorageError) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type StorageError.

func (*StorageError) UnmarshalJSON

func (s *StorageError) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type StorageError.

type StorageErrorCode

type StorageErrorCode string

StorageErrorCode - Error codes returned by the service

const (
	StorageErrorCodeAccountAlreadyExists                 StorageErrorCode = "AccountAlreadyExists"
	StorageErrorCodeAccountBeingCreated                  StorageErrorCode = "AccountBeingCreated"
	StorageErrorCodeAccountIsDisabled                    StorageErrorCode = "AccountIsDisabled"
	StorageErrorCodeAuthenticationFailed                 StorageErrorCode = "AuthenticationFailed"
	StorageErrorCodeAuthorizationFailure                 StorageErrorCode = "AuthorizationFailure"
	StorageErrorCodeAuthorizationPermissionMismatch      StorageErrorCode = "AuthorizationPermissionMismatch"
	StorageErrorCodeAuthorizationProtocolMismatch        StorageErrorCode = "AuthorizationProtocolMismatch"
	StorageErrorCodeAuthorizationResourceTypeMismatch    StorageErrorCode = "AuthorizationResourceTypeMismatch"
	StorageErrorCodeAuthorizationServiceMismatch         StorageErrorCode = "AuthorizationServiceMismatch"
	StorageErrorCodeAuthorizationSourceIPMismatch        StorageErrorCode = "AuthorizationSourceIPMismatch"
	StorageErrorCodeConditionHeadersNotSupported         StorageErrorCode = "ConditionHeadersNotSupported"
	StorageErrorCodeConditionNotMet                      StorageErrorCode = "ConditionNotMet"
	StorageErrorCodeEmptyMetadataKey                     StorageErrorCode = "EmptyMetadataKey"
	StorageErrorCodeFeatureVersionMismatch               StorageErrorCode = "FeatureVersionMismatch"
	StorageErrorCodeInsufficientAccountPermissions       StorageErrorCode = "InsufficientAccountPermissions"
	StorageErrorCodeInternalError                        StorageErrorCode = "InternalError"
	StorageErrorCodeInvalidAuthenticationInfo            StorageErrorCode = "InvalidAuthenticationInfo"
	StorageErrorCodeInvalidHTTPVerb                      StorageErrorCode = "InvalidHttpVerb"
	StorageErrorCodeInvalidHeaderValue                   StorageErrorCode = "InvalidHeaderValue"
	StorageErrorCodeInvalidInput                         StorageErrorCode = "InvalidInput"
	StorageErrorCodeInvalidMD5                           StorageErrorCode = "InvalidMd5"
	StorageErrorCodeInvalidMarker                        StorageErrorCode = "InvalidMarker"
	StorageErrorCodeInvalidMetadata                      StorageErrorCode = "InvalidMetadata"
	StorageErrorCodeInvalidQueryParameterValue           StorageErrorCode = "InvalidQueryParameterValue"
	StorageErrorCodeInvalidRange                         StorageErrorCode = "InvalidRange"
	StorageErrorCodeInvalidResourceName                  StorageErrorCode = "InvalidResourceName"
	StorageErrorCodeInvalidURI                           StorageErrorCode = "InvalidUri"
	StorageErrorCodeInvalidXMLDocument                   StorageErrorCode = "InvalidXmlDocument"
	StorageErrorCodeInvalidXMLNodeValue                  StorageErrorCode = "InvalidXmlNodeValue"
	StorageErrorCodeMD5Mismatch                          StorageErrorCode = "Md5Mismatch"
	StorageErrorCodeMessageNotFound                      StorageErrorCode = "MessageNotFound"
	StorageErrorCodeMessageTooLarge                      StorageErrorCode = "MessageTooLarge"
	StorageErrorCodeMetadataTooLarge                     StorageErrorCode = "MetadataTooLarge"
	StorageErrorCodeMissingContentLengthHeader           StorageErrorCode = "MissingContentLengthHeader"
	StorageErrorCodeMissingRequiredHeader                StorageErrorCode = "MissingRequiredHeader"
	StorageErrorCodeMissingRequiredQueryParameter        StorageErrorCode = "MissingRequiredQueryParameter"
	StorageErrorCodeMissingRequiredXMLNode               StorageErrorCode = "MissingRequiredXmlNode"
	StorageErrorCodeMultipleConditionHeadersNotSupported StorageErrorCode = "MultipleConditionHeadersNotSupported"
	StorageErrorCodeOperationTimedOut                    StorageErrorCode = "OperationTimedOut"
	StorageErrorCodeOutOfRangeInput                      StorageErrorCode = "OutOfRangeInput"
	StorageErrorCodeOutOfRangeQueryParameterValue        StorageErrorCode = "OutOfRangeQueryParameterValue"
	StorageErrorCodePopReceiptMismatch                   StorageErrorCode = "PopReceiptMismatch"
	StorageErrorCodeQueueAlreadyExists                   StorageErrorCode = "QueueAlreadyExists"
	StorageErrorCodeQueueBeingDeleted                    StorageErrorCode = "QueueBeingDeleted"
	StorageErrorCodeQueueDisabled                        StorageErrorCode = "QueueDisabled"
	StorageErrorCodeQueueNotEmpty                        StorageErrorCode = "QueueNotEmpty"
	StorageErrorCodeQueueNotFound                        StorageErrorCode = "QueueNotFound"
	StorageErrorCodeRequestBodyTooLarge                  StorageErrorCode = "RequestBodyTooLarge"
	StorageErrorCodeRequestURLFailedToParse              StorageErrorCode = "RequestUrlFailedToParse"
	StorageErrorCodeResourceAlreadyExists                StorageErrorCode = "ResourceAlreadyExists"
	StorageErrorCodeResourceNotFound                     StorageErrorCode = "ResourceNotFound"
	StorageErrorCodeResourceTypeMismatch                 StorageErrorCode = "ResourceTypeMismatch"
	StorageErrorCodeServerBusy                           StorageErrorCode = "ServerBusy"
	StorageErrorCodeUnsupportedHTTPVerb                  StorageErrorCode = "UnsupportedHttpVerb"
	StorageErrorCodeUnsupportedHeader                    StorageErrorCode = "UnsupportedHeader"
	StorageErrorCodeUnsupportedQueryParameter            StorageErrorCode = "UnsupportedQueryParameter"
	StorageErrorCodeUnsupportedXMLNode                   StorageErrorCode = "UnsupportedXmlNode"
)

func PossibleStorageErrorCodeValues

func PossibleStorageErrorCodeValues() []StorageErrorCode

PossibleStorageErrorCodeValues returns the possible values for the StorageErrorCode const type.

type StorageServiceProperties

type StorageServiceProperties struct {
	// The set of CORS rules.
	CORS []*CORSRule `xml:"Cors>CorsRule"`

	// A summary of request statistics grouped by API in hourly aggregates for queues
	HourMetrics *Metrics `xml:"HourMetrics"`

	// Azure Analytics Logging settings
	Logging *Logging `xml:"Logging"`

	// a summary of request statistics grouped by API in minute aggregates for queues
	MinuteMetrics *Metrics `xml:"MinuteMetrics"`
}

StorageServiceProperties - Storage Service Properties.

func (StorageServiceProperties) MarshalXML

func (s StorageServiceProperties) MarshalXML(enc *xml.Encoder, start xml.StartElement) error

MarshalXML implements the xml.Marshaller interface for type StorageServiceProperties.

type StorageServiceStats

type StorageServiceStats struct {
	// Geo-Replication information for the Secondary Storage Service
	GeoReplication *GeoReplication `xml:"GeoReplication"`
}

StorageServiceStats - Stats for the storage service.

Jump to

Keyboard shortcuts

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