com.azure.resourcemanager.storage.models.BlobContainer Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of azure-resourcemanager-storage Show documentation
This package contains Microsoft Azure Storage Management SDK.
There is a newer version: 2.45.0
Show newest version
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.

package com.azure.resourcemanager.storage.models;

import com.azure.core.annotation.Fluent;
import com.azure.resourcemanager.resources.fluentcore.arm.models.HasManager;
import com.azure.resourcemanager.resources.fluentcore.model.Appliable;
import com.azure.resourcemanager.resources.fluentcore.model.Creatable;
import com.azure.resourcemanager.resources.fluentcore.model.HasInnerModel;
import com.azure.resourcemanager.resources.fluentcore.model.Indexable;
import com.azure.resourcemanager.resources.fluentcore.model.Updatable;
import com.azure.resourcemanager.storage.StorageManager;
import com.azure.resourcemanager.storage.fluent.models.BlobContainerInner;
import java.time.OffsetDateTime;
import java.util.Map;

/** Type representing BlobContainer. */
@Fluent
public interface BlobContainer
    extends HasInnerModel, Indexable, Updatable, HasManager {
    /** @return the etag value. */
    String etag();

    /** @return the hasImmutabilityPolicy value. */
    Boolean hasImmutabilityPolicy();

    /** @return the hasLegalHold value. */
    Boolean hasLegalHold();

    /** @return the id value. */
    String id();

    /** @return the immutabilityPolicy value. */
    ImmutabilityPolicyProperties immutabilityPolicy();

    /** @return the lastModifiedTime value. */
    OffsetDateTime lastModifiedTime();

    /** @return the leaseDuration value. */
    LeaseDuration leaseDuration();

    /** @return the leaseState value. */
    LeaseState leaseState();

    /** @return the leaseStatus value. */
    LeaseStatus leaseStatus();

    /** @return the legalHold value. */
    LegalHoldProperties legalHold();

    /** @return the metadata value. */
    Map metadata();

    /** @return the name value. */
    String name();

    /** @return the publicAccess value. */
    PublicAccess publicAccess();

    /** @return the type value. */
    String type();

    /** The entirety of the BlobContainer definition. */
    interface Definition
        extends DefinitionStages.Blank,
            DefinitionStages.WithBlobService,
            DefinitionStages.WithPublicAccess,
            DefinitionStages.WithMetadata,
            DefinitionStages.WithCreate {
    }

    /** Grouping of BlobContainer definition stages. */
    interface DefinitionStages {
        /** The first stage of a BlobContainer definition. */
        interface Blank extends WithBlobService {
        }

        /** The stage of the blobcontainer definition allowing to specify BlobService. */
        interface WithBlobService {
            /**
             * Specifies resourceGroupName, accountName.
             *
             * @deprecated use {@link #withExistingStorageAccount(String, String)}
             *
             * @param resourceGroupName The name of the resource group within the user's subscription. The name is case
             *     insensitive
             * @param accountName The name of the storage account within the specified resource group. Storage account
             *     names must be between 3 and 24 characters in length and use numbers and lower-case letters only
             * @return the next definition stage
             */
            @Deprecated
            WithPublicAccess withExistingBlobService(String resourceGroupName, String accountName);

            /**
             * Specifies resourceGroupName, accountName.
             *
             * @param resourceGroupName The name of the resource group within the user's subscription. The name is case
             *     insensitive
             * @param accountName The name of the storage account within the specified resource group. Storage account
             *     names must be between 3 and 24 characters in length and use numbers and lower-case letters only
             * @return the next definition stage
             */
            WithPublicAccess withExistingStorageAccount(String resourceGroupName, String accountName);

            /**
             * Specifies resourceGroupName, accountName.
             *
             * @param storageAccount the storage account.
             * @return the next definition stage
             */
            WithPublicAccess withExistingStorageAccount(StorageAccount storageAccount);
        }

        /** The stage of the blobcontainer definition allowing to specify PublicAccess. */
        interface WithPublicAccess {
            /**
             * Specifies publicAccess.
             *
             * @param publicAccess Specifies whether data in the container may be accessed publicly and the level of
             *     access. Possible values include: 'Container', 'Blob', 'None'
             * @return the next definition stage
             */
            WithCreate withPublicAccess(PublicAccess publicAccess);
        }

        /** The stage of the blobcontainer definition allowing to specify Metadata. */
        interface WithMetadata {
            /**
             * Specifies metadata.
             *
             * @param metadata A name-value pair to associate with the container as metadata
             * @return the next definition stage
             */
            WithCreate withMetadata(Map metadata);

            /**
             * Specifies a singluar instance of metadata.
             *
             * @param name A name to associate with the container as metadata
             * @param value A value to associate with the container as metadata
             * @return the next definition stage
             */
            WithCreate withMetadata(String name, String value);
        }

        /**
         * The stage of the definition which contains all the minimum required inputs for the resource to be created
         * (via {@link WithCreate#create()}), but also allows for any other optional settings to be specified.
         */
        interface WithCreate extends WithMetadata, Creatable {
        }
    }

    /** The template for a BlobContainer update operation, containing all the settings that can be modified. */
    interface Update extends Appliable, UpdateStages.WithPublicAccess, UpdateStages.WithMetadata {
    }

    /** Grouping of BlobContainer update stages. */
    interface UpdateStages {
        /** The stage of the blobcontainer update allowing to specify PublicAccess. */
        interface WithPublicAccess {
            /**
             * Specifies publicAccess.
             *
             * @param publicAccess Specifies whether data in the container may be accessed publicly and the level of
             *     access. Possible values include: 'Container', 'Blob', 'None'
             * @return the next update stage
             */
            Update withPublicAccess(PublicAccess publicAccess);
        }

        /** The stage of the blobcontainer update allowing to specify Metadata. */
        interface WithMetadata {
            /**
             * Specifies metadata.
             *
             * @param metadata A name-value pair to associate with the container as metadata
             * @return the next update stage
             */
            Update withMetadata(Map metadata);

            /**
             * Specifies a singluar instance of metadata.
             *
             * @param name A name to associate with the container as metadata
             * @param value A value to associate with the container as metadata
             * @return the next definition stage
             */
            Update withMetadata(String name, String value);
        }
    }
}