com.microsoft.windowsazure.services.serviceBus.models.QueueInfo Maven / Gradle / Ivy
/**
* Copyright Microsoft Corporation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.microsoft.windowsazure.services.serviceBus.models;
import javax.ws.rs.core.MediaType;
import javax.xml.datatype.Duration;
import com.microsoft.windowsazure.services.serviceBus.implementation.Content;
import com.microsoft.windowsazure.services.serviceBus.implementation.Entry;
import com.microsoft.windowsazure.services.serviceBus.implementation.EntryModel;
import com.microsoft.windowsazure.services.serviceBus.implementation.QueueDescription;
/**
* Represents a queue.
*/
public class QueueInfo extends EntryModel {
/**
* Creates an instance of the Queue class.
*/
public QueueInfo() {
super(new Entry(), new QueueDescription());
getEntry().setContent(new Content());
getEntry().getContent().setType(MediaType.APPLICATION_XML);
getEntry().getContent().setQueueDescription(getModel());
}
/**
* Creates an instance of the Queue class using the specified entry.
*
* @param entry
* An Entry object.
*/
public QueueInfo(Entry entry) {
super(entry, entry.getContent().getQueueDescription());
}
/**
* Creates an instance of the Queue class using the specified name.
*
* @param path
* A String object that represents the name of the queue.
*/
public QueueInfo(String path) {
this();
setPath(path);
}
/**
* Returns the name of the queue.
*
* @return A String object that represents the name of the queue.
*/
public String getPath() {
return getEntry().getTitle();
}
/**
* Sets the name of the queue.
*
* @param value
* A String that represents the name of the queue.
*
* @return A Queue object that represents the updated queue.
*/
public QueueInfo setPath(String value) {
getEntry().setTitle(value);
return this;
}
/**
* Returns the duration of the lock.
*
* @return A Duration object that represents the duration of the lock.
*/
public Duration getLockDuration() {
return getModel().getLockDuration();
}
/**
* Sets the duration of the lock.
*
* @param value
* The duration, in seconds, of the lock.
*
* @return A Queue object that represents the updated queue.
*/
public QueueInfo setLockDuration(Duration value) {
getModel().setLockDuration(value);
return this;
}
/**
* Returns the maximum size of the queue.
*
* @return The maximum size, in megabytes, of the queue.
*/
public Long getMaxSizeInMegabytes() {
return getModel().getMaxSizeInMegabytes();
}
/**
* Sets the maximum size of the queue.
*
* @param value
* The maximum size, in megabytes, of the queue.
*
* @return A Queue object that represents the updated queue.
*/
public QueueInfo setMaxSizeInMegabytes(Long value) {
getModel().setMaxSizeInMegabytes(value);
return this;
}
/**
* Indicates whether duplicate message detection is required.
*
* @return true if duplicate message detection is required; otherwise, false.
*/
public Boolean isRequiresDuplicateDetection() {
return getModel().isRequiresDuplicateDetection();
}
/**
* Specifies whether duplicate message detection is required.
*
* @param value
* true if duplicate message detection is required; otherwise, false.
*
* @return A Queue object that represents the updated queue.
*/
public QueueInfo setRequiresDuplicateDetection(Boolean value) {
getModel().setRequiresDuplicateDetection(value);
return this;
}
/**
* Indicates whether the queue is session-aware.
*
* @return true if the queue is session aware; otherwise, false.
*/
public Boolean isRequiresSession() {
return getModel().isRequiresSession();
}
/**
* Specifies whether the queue is session-aware.
*
* @param value
* true if the queue is session aware; otherwise, false.
*
* @return A Queue object that represents the updated queue.
*/
public QueueInfo setRequiresSession(Boolean value) {
getModel().setRequiresSession(value);
return this;
}
/**
* Returns the default message time-to-live (TTL). This applies when dead
* lettering is in effect.
*
* @return A Duration object that represents the default message TTL.
*/
public Duration getDefaultMessageTimeToLive() {
return getModel().getDefaultMessageTimeToLive();
}
/**
* Sets the default message time-to-live (TTL). This applies when dead lettering is in effect.
*
* @param value
* A Duration object that represents the default message TTL.
*
* @return A Queue object that represents the updated queue.
*/
public QueueInfo setDefaultMessageTimeToLive(Duration value) {
getModel().setDefaultMessageTimeToLive(value);
return this;
}
/**
* Indicates whether dead lettering is in effect upon message expiration.
*
* @return true if dead lettering is in effect; otherwise, false.
*/
public Boolean isDeadLetteringOnMessageExpiration() {
return getModel().isDeadLetteringOnMessageExpiration();
}
/**
* Specifies whether dead lettering is in effect upon message expiration.
*
* @param value
* true if dead lettering is in effect; otherwise, false.
*
* @return A Queue object that represents the updated queue.
*/
public QueueInfo setDeadLetteringOnMessageExpiration(Boolean value) {
getModel().setDeadLetteringOnMessageExpiration(value);
return this;
}
/**
* Returns the time span during which the service bus will detect message duplication. This applies when duplicate
* message detection is in effect.
*
* @return A Duration object that represents the time span for
* detecting message duplication.
*/
public Duration getDuplicateDetectionHistoryTimeWindow() {
return getModel().getDuplicateDetectionHistoryTimeWindow();
}
/**
* Sets the time span during which the service bus will detect message duplication. This applies when duplicate
* message detection is in effect.
*
* @param value
* A Duration object that represents the time span for detecting message duplication.
*
* @return A Queue object that represents the updated queue.
*/
public QueueInfo setDuplicateDetectionHistoryTimeWindow(Duration value) {
getModel().setDuplicateDetectionHistoryTimeWindow(value);
return this;
}
/**
* Returns the maximum delivery count for the queue.
*
* @return The maximum delivery count.
*/
public Integer getMaxDeliveryCount() {
return getModel().getMaxDeliveryCount();
}
/**
* Sets the maximum delivery count for the queue.
*
* @param value
* The maximum delivery count for the queue.
*
* @return A Queue object that represents the updated queue.
*/
public QueueInfo setMaxDeliveryCount(Integer value) {
getModel().setMaxDeliveryCount(value);
return this;
}
/**
* Indicates whether batch operations are enabled.
*
* @return true if batch operations are enabled; otherwise, false.
*/
public Boolean isEnableBatchedOperations() {
return getModel().isEnableBatchedOperations();
}
/**
* Specifies whether batch operations are enabled.
*
* @param value
* true if batch operations are enabled; otherwise, false.
*
* @return A Queue object that represents the updated queue.
*/
public QueueInfo setEnableBatchedOperations(Boolean value) {
getModel().setEnableBatchedOperations(value);
return this;
}
/**
* Returns the size of the queue.
*
* @return The size, in bytes, of the queue.
*/
public Long getSizeInBytes() {
return getModel().getSizeInBytes();
}
/**
* Returns the number of messages in the queue.
*
* @return The number of messages in the queue.
*/
public Long getMessageCount() {
return getModel().getMessageCount();
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy