com.microsoft.azure.storage.blob.TelemetryOptions Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of azure-storage-blob Show documentation

The Azure Storage Java Blob library.

The newest version!

// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.

package com.microsoft.azure.storage.blob;

/**
 * Options for configuring the {@link TelemetryFactory}. Please refer to the Factory for more information.
 */
public final class TelemetryOptions {

    private final String userAgentPrefix;

    public TelemetryOptions() {
        this(Constants.EMPTY_STRING);
    }

    /**
     * @param userAgentPrefix
     *         A string prepended to each request's User-Agent and sent to the service. The service records.
     *         the user-agent in logs for diagnostics and tracking of client requests.
     */
    public TelemetryOptions(String userAgentPrefix) {
        this.userAgentPrefix = userAgentPrefix;
    }

    /**
     * @return The user agent prefix.
     */
    public String userAgentPrefix() {
        return this.userAgentPrefix;
    }
}