com.azure.storage.blob.options.BlockBlobSeekableByteChannelWriteOptions Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of azure-storage-blob Show documentation
This module contains client library for Microsoft Azure Blob Storage.
There is a newer version: 12.29.0
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
package com.azure.storage.blob.options;

import com.azure.core.util.ExpandableStringEnum;
import com.azure.core.util.logging.ClientLogger;
import com.azure.storage.blob.models.AccessTier;
import com.azure.storage.blob.models.BlobHttpHeaders;
import com.azure.storage.blob.models.BlobRequestConditions;
import com.fasterxml.jackson.annotation.JsonCreator;

import java.util.Collection;
import java.util.Map;
import java.util.Objects;

/**
 * Options for obtaining a {@link java.nio.channels.SeekableByteChannel} backed by an Azure Storage Share File.
 */
public final class BlockBlobSeekableByteChannelWriteOptions {
    private static final ClientLogger LOGGER = new ClientLogger(BlockBlobSeekableByteChannelWriteOptions.class);

    /**
     * Mode to open the channel for writing.
     */
    public static final class WriteMode extends ExpandableStringEnum {
        /**
         * Replaces the existing block blob, if any, with the newly written contents. Creates a new blob if none exists.
         */
        public static final WriteMode OVERWRITE = fromString("Overwrite");

        /**
         * Creates or finds a AccessTier from its string representation.
         *
         * @param name a name to look for.
         * @return the corresponding AccessTier.
         */
        @JsonCreator
        public static WriteMode fromString(String name) {
            return fromString(name, WriteMode.class);
        }

        /**
         * Gets known WriteMode values.
         *
         * @return known WriteMode values.
         */
        public static Collection values() {
            return values(WriteMode.class);
        }
    }

    private final WriteMode writeMode;
    private Long blockSizeInBytes;
    private BlobHttpHeaders headers;
    private Map metadata;
    private Map tags;
    private AccessTier tier;
    private BlobRequestConditions conditions;

    /**
     * Options constructor.
     * @param mode What usage mode to open the channel in.
     */
    public BlockBlobSeekableByteChannelWriteOptions(WriteMode mode) {
        writeMode = Objects.requireNonNull(mode, "'mode' cannot be null.");
    }

    /**
     * @return Usage mode to be used by the resulting channel.
     */
    public WriteMode getWriteMode() {
        return writeMode;
    }

    /**
     * @return The size of individual writes to the service.
     */
    public Long getBlockSizeInBytes() {
        return blockSizeInBytes;
    }

    /**
     * @param blockSizeInBytes The size of individual writes to the service.
     * @return The updated instance.
     */
    public BlockBlobSeekableByteChannelWriteOptions setBlockSizeInBytes(Long blockSizeInBytes) {
        this.blockSizeInBytes = blockSizeInBytes;
        return this;
    }

    /**
     * @return Blob HTTP headers to write.
     */
    public BlobHttpHeaders getHeaders() {
        return headers;
    }

    /**
     * @param headers Blob HTTP headers to write.
     * @return The updated instance.
     */
    public BlockBlobSeekableByteChannelWriteOptions setHeaders(BlobHttpHeaders headers) {
        this.headers = headers;
        return this;
    }

    /**
     * @return Blob metadata to write.
     */
    public Map getMetadata() {
        return metadata;
    }

    /**
     * @param metadata Blob metadata to write.
     * @return The updated instance.
     */
    public BlockBlobSeekableByteChannelWriteOptions setMetadata(Map metadata) {
        this.metadata = metadata;
        return this;
    }

    /**
     * @return Blob tags to write.
     */
    public Map getTags() {
        return tags;
    }

    /**
     * @param tags Blob tags to write.
     * @return The updated instance.
     */
    public BlockBlobSeekableByteChannelWriteOptions setTags(Map tags) {
        this.tags = tags;
        return this;
    }

    /**
     * @return Access tier for the target blob.
     */
    public AccessTier getTier() {
        return tier;
    }

    /**
     * @param tier Access tier for the target blob.
     * @return The updated instance.
     */
    public BlockBlobSeekableByteChannelWriteOptions setTier(AccessTier tier) {
        this.tier = tier;
        return this;
    }

    /**
     * @return Request conditions for writing to the blob.
     */
    public BlobRequestConditions getRequestConditions() {
        return conditions;
    }

    /**
     * @param conditions Request conditions for writing to the blob.
     * @return The updated instance.
     */
    public BlockBlobSeekableByteChannelWriteOptions setRequestConditions(BlobRequestConditions conditions) {
        this.conditions = conditions;
        return this;
    }

}