class Azure::ServiceBus::Mgmt::V2015_08_01::Models::QueueResource

Description of queue Resource.

Attributes

accessed_at[RW]

@return [DateTime] Last time a message was sent, or the last time there was a receive request to this queue.

auto_delete_on_idle[RW]

@return [String] the TimeSpan idle interval after which the queue is automatically deleted. The minimum duration is 5 minutes.

count_details[RW]

@return [MessageCountDetails]

created_at[RW]

@return [DateTime] The exact time the message was created.

dead_lettering_on_message_expiration[RW]

@return [Boolean] A value that indicates whether this queue has dead letter support when a message expires.

default_message_time_to_live[RW]

@return [String] The default message time to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself.

duplicate_detection_history_time_window[RW]

@return [String] TimeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.

enable_batched_operations[RW]

@return [Boolean] A value that indicates whether server-side batched operations are enabled.

enable_express[RW]

@return [Boolean] A value that indicates whether Express Entities are enabled. An express queue holds a message in memory temporarily before writing it to persistent storage.

enable_partitioning[RW]

@return [Boolean] A value that indicates whether the queue is to be partitioned across multiple message brokers.

entity_availability_status[RW]

@return [EntityAvailabilityStatus] Entity availability status for the queue. Possible values include: 'Available', 'Limited', 'Renaming', 'Restoring', 'Unknown'

is_anonymous_accessible[RW]

@return [Boolean] A value that indicates whether the message is accessible anonymously.

lock_duration[RW]

@return [String] The duration of a peek-lock; that is, the amount of time that the message is locked for other receivers. The maximum value for LockDuration is 5 minutes; the default value is 1 minute.

max_delivery_count[RW]

@return [Integer] The maximum delivery count. A message is automatically deadlettered after this number of deliveries.

max_size_in_megabytes[RW]

@return [Integer] The maximum size of the queue in megabytes, which is the size of memory allocated for the queue.

message_count[RW]

@return [Integer] The number of messages in the queue.

requires_duplicate_detection[RW]

@return [Boolean] A value indicating if this queue requires duplicate detection.

requires_session[RW]

@return [Boolean] A value that indicates whether the queue supports the concept of sessions.

size_in_bytes[RW]

@return [Integer] The size of the queue, in bytes.

status[RW]

@return [EntityStatus] Enumerates the possible values for the status of a messaging entity. Possible values include: 'Active', 'Creating', 'Deleting', 'Disabled', 'ReceiveDisabled', 'Renaming', 'Restoring', 'SendDisabled', 'Unknown'

support_ordering[RW]

@return [Boolean] A value that indicates whether the queue supports ordering.

updated_at[RW]

@return [DateTime] The exact time the message was updated.

Public Class Methods

mapper() click to toggle source

Mapper for QueueResource class as Ruby Hash. This will be used for serialization/deserialization.

# File lib/2015-08-01/generated/azure_mgmt_service_bus/models/queue_resource.rb, line 110
def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'QueueResource',
    type: {
      name: 'Composite',
      class_name: 'QueueResource',
      model_properties: {
        id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'id',
          type: {
            name: 'String'
          }
        },
        name: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'name',
          type: {
            name: 'String'
          }
        },
        location: {
          client_side_validation: true,
          required: false,
          serialized_name: 'location',
          type: {
            name: 'String'
          }
        },
        type: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'type',
          type: {
            name: 'String'
          }
        },
        lock_duration: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.lockDuration',
          type: {
            name: 'String'
          }
        },
        accessed_at: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.accessedAt',
          type: {
            name: 'DateTime'
          }
        },
        auto_delete_on_idle: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.autoDeleteOnIdle',
          type: {
            name: 'String'
          }
        },
        entity_availability_status: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.entityAvailabilityStatus',
          type: {
            name: 'Enum',
            module: 'EntityAvailabilityStatus'
          }
        },
        created_at: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.createdAt',
          type: {
            name: 'DateTime'
          }
        },
        default_message_time_to_live: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.defaultMessageTimeToLive',
          type: {
            name: 'String'
          }
        },
        duplicate_detection_history_time_window: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.duplicateDetectionHistoryTimeWindow',
          type: {
            name: 'String'
          }
        },
        enable_batched_operations: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.enableBatchedOperations',
          type: {
            name: 'Boolean'
          }
        },
        dead_lettering_on_message_expiration: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.deadLetteringOnMessageExpiration',
          type: {
            name: 'Boolean'
          }
        },
        enable_express: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.enableExpress',
          type: {
            name: 'Boolean'
          }
        },
        enable_partitioning: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.enablePartitioning',
          type: {
            name: 'Boolean'
          }
        },
        is_anonymous_accessible: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.isAnonymousAccessible',
          type: {
            name: 'Boolean'
          }
        },
        max_delivery_count: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.maxDeliveryCount',
          type: {
            name: 'Number'
          }
        },
        max_size_in_megabytes: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.maxSizeInMegabytes',
          type: {
            name: 'Number'
          }
        },
        message_count: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.messageCount',
          type: {
            name: 'Number'
          }
        },
        count_details: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.countDetails',
          type: {
            name: 'Composite',
            class_name: 'MessageCountDetails'
          }
        },
        requires_duplicate_detection: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.requiresDuplicateDetection',
          type: {
            name: 'Boolean'
          }
        },
        requires_session: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.requiresSession',
          type: {
            name: 'Boolean'
          }
        },
        size_in_bytes: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.sizeInBytes',
          type: {
            name: 'Number'
          }
        },
        status: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.status',
          type: {
            name: 'Enum',
            module: 'EntityStatus'
          }
        },
        support_ordering: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.supportOrdering',
          type: {
            name: 'Boolean'
          }
        },
        updated_at: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.updatedAt',
          type: {
            name: 'DateTime'
          }
        }
      }
    }
  }
end