com.microsoft.windowsazure.services.queue.models.QueueServiceOptions Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of microsoft-windowsazure-api Show documentation

API for Microsoft Windows Azure Clients

There is a newer version: 0.4.6

Show newest version

/**
 * 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.queue.models;

import com.microsoft.windowsazure.services.queue.QueueContract;

/**
 * Represents the base class for options that may be set on Queue Service REST API operations invoked through the
 * {@link QueueContract} interface. This class defines a server request timeout, which can be applied to all operations.
 */
public class QueueServiceOptions {
    // Nullable because it is optional
    private Integer timeout;

    /**
     * Gets the current server request timeout value associated with this {@link QueueServiceOptions} instance.
     * 
     * The timeout value only affects calls made on methods where this {@link QueueServiceOptions} instance is passed as
     * a parameter.
     * 
     * @return
     *         The server request timeout value in milliseconds.
     */
    public Integer getTimeout() {
        return timeout;
    }

    /**
     * Sets the server request timeout value associated with this {@link QueueServiceOptions} instance.
     * 
     * The timeout value only affects calls made on methods where this {@link QueueServiceOptions} instance is passed as
     * a parameter.
     * 
     * @param timeout
     *            The server request timeout value to set in milliseconds.
     * @return
     *         A reference to this {@link QueueServiceOptions} instance.
     */
    public QueueServiceOptions setTimeout(Integer timeout) {
        this.timeout = timeout;
        return this;
    }
}