com.azure.resourcemanager.keyvault.models.Secret Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of azure-resourcemanager-keyvault Show documentation
This package contains Microsoft Azure Key Vault Management SDK. For documentation on how to use this package, please see https://aka.ms/azsdk/java/mgmt
The newest version!
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.

package com.azure.resourcemanager.keyvault.models;

import com.azure.core.annotation.Fluent;
import com.azure.core.http.rest.PagedFlux;
import com.azure.core.http.rest.PagedIterable;
import com.azure.resourcemanager.resources.fluentcore.arm.models.HasId;
import com.azure.resourcemanager.resources.fluentcore.arm.models.HasName;
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.security.keyvault.secrets.models.SecretProperties;
import java.util.Map;
import reactor.core.publisher.Mono;

/** An immutable client-side representation of an Azure Key Vault secret. */
@Fluent
public interface Secret extends Indexable, HasInnerModel, HasId, HasName, Updatable {
    /** @return the secret value when the secret is enabled */
    String getValue();

    /** @return the secret value when the secret is enabled */
    Mono getValueAsync();

    /** @return the secret management attributes */
    SecretProperties attributes();

    /** @return application specific metadata in the form of key-value pairs */
    Map tags();

    /** @return type of the secret value such as a password */
    String contentType();

    /** @return the corresponding key backing the KV certificate if this is a secret backing a KV certificate */
    String kid();

    /**
     * @return true if the secret's lifetime is managed by key vault. If this is a key backing a certificate, then
     *     managed will be true
     */
    boolean managed();

    /**
     * @return whether secret is enabled.
     */
    boolean enabled();

    /** @return a list of individual secret versions with the same secret name */
    PagedIterable listVersions();

    /** @return a list of individual secret versions with the same secret name */
    PagedFlux listVersionsAsync();

    /** Container interface for all the definitions. */
    interface Definition extends DefinitionStages.Blank, DefinitionStages.WithValue, DefinitionStages.WithCreate {
    }

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

        /** The stage of a secret definition allowing to specify the secret value. */
        interface WithValue {
            /**
             * Specifies the secret value.
             *
             * @param value the string value of the secret
             * @return the next stage of the definition
             */
            WithCreate withValue(String value);
        }

        /** The stage of a secret definition allowing to specify the secret content type. */
        interface WithContentType {
            /**
             * Specifies the secret content type.
             *
             * @param contentType the content type
             * @return the next stage of the definition
             */
            WithCreate withContentType(String contentType);
        }

        /** The stage of a secret definition allowing to specify the secret attributes. */
        interface WithAttributes {
            /**
             * Specifies the secret attributes.
             *
             * @param attributes the object attributes managed by Key Vault service
             * @return the next stage of the definition
             */
            WithCreate withAttributes(SecretProperties attributes);
        }

        /** The stage of a secret definition allowing to specify the tags. */
        interface WithTags {
            /**
             * Specifies the tags on the secret.
             *
             * @param tags the key value pair of the tags
             * @return the next stage of the definition
             */
            WithCreate withTags(Map tags);
        }

        /**
         * The stage of the secret definition which contains all the minimum required inputs for the secret to be
         * created but also allows for any optional settings to be specified.
         */
        interface WithCreate extends Creatable, WithContentType, WithAttributes, WithTags {
        }
    }

    /** Grouping of secret update stages. */
    interface UpdateStages {
        /** The stage of a secret update allowing to create a new version of the secret value. */
        interface WithValue {
            /**
             * Specifies the new version of the value to be added.
             *
             * @param value the value for the new version
             * @return the next stage of the secret update
             */
            Update withValue(String value);
        }

        /** The stage of a secret update allowing to set the content type of the secret. */
        interface WithContentType {
            /**
             * Specifies the secret content type.
             *
             * @param contentType the content type
             * @return the next stage of the update
             */
            Update withContentType(String contentType);
        }

        /** The stage of a secret update allowing to specify the secret attributes. */
        interface WithAttributes {
            /**
             * Specifies the secret attributes.
             *
             * @param attributes the object attributes managed by Key Vault service
             * @return the next stage of the update
             */
            Update withAttributes(SecretProperties attributes);
        }

        /** The stage of a secret update allowing to specify the tags. */
        interface WithTags {
            /**
             * Specifies the tags on the secret.
             *
             * @param tags the key value pair of the tags
             * @return the next stage of the update
             */
            Update withTags(Map tags);
        }
    }

    /** The template for a secret update operation, containing all the settings that can be modified. */
    interface Update
        extends Appliable,
            UpdateStages.WithValue,
            UpdateStages.WithAttributes,
            UpdateStages.WithContentType,
            UpdateStages.WithTags {
    }
}