Copyright (c) Microsoft Corporation. All rights reserved.
Licensed under the MIT License. See License.txt in the project root for
license information.
/**
 * Copyright (c) Microsoft Corporation. All rights reserved.
 * Licensed under the MIT License. See License.txt in the project root for
 * license information.
 */
package com.microsoft.azure.management.containerregistry;

import com.microsoft.azure.management.apigeneration.Fluent;
import com.microsoft.azure.management.apigeneration.Beta.SinceVersion;
import com.microsoft.azure.management.apigeneration.Beta;
import com.microsoft.azure.management.apigeneration.Method;
import com.microsoft.azure.management.containerregistry.implementation.ContainerRegistryManager;
import com.microsoft.azure.management.containerregistry.implementation.RegistryInner;
import com.microsoft.azure.management.resources.fluentcore.arm.models.GroupableResource;
import com.microsoft.azure.management.resources.fluentcore.arm.models.Resource;
import com.microsoft.azure.management.resources.fluentcore.model.Appliable;
import com.microsoft.azure.management.resources.fluentcore.model.Creatable;
import com.microsoft.azure.management.resources.fluentcore.model.Refreshable;
import com.microsoft.azure.management.resources.fluentcore.model.Updatable;
import com.microsoft.azure.management.storage.StorageAccount;
import org.joda.time.DateTime;
import rx.Observable;

import java.util.Collection;

An immutable client-side representation of an Azure registry.
/**
 * An immutable client-side representation of an Azure registry.
 */
@Fluent
@Beta(SinceVersion.V1_1_0)
public interface Registry extends
    GroupableResource<ContainerRegistryManager, RegistryInner>,
    Refreshable<Registry>,
    Updatable<Registry.Update> {

    
Returns:
the SKU of the container registry./**
     * @return the SKU of the container registry.
     */
    Sku sku();

    
Returns:
the URL that can be used to log into the container registry/**
     * @return the URL that can be used to log into the container registry
     */
    String loginServerUrl();

    
Returns:
the creation date of the container registry in ISO8601 format/**
     * @return the creation date of the container registry in ISO8601 format
     */
    DateTime creationDate();

    
Returns:
the value that indicates whether the admin user is enabled/**
     * @return the value that indicates whether the admin user is enabled
     */
    boolean adminUserEnabled();

    
Returns:
the name of the storage account for the container registry; 'null' if container register SKU a managed tier/**
     * @return the name of the storage account for the container registry; 'null' if container register SKU a managed tier
     */
    String storageAccountName();

    
Returns:
the ID of the storage account for the container registry; 'null' if container register SKU a managed tier/**
     * @return the ID of the storage account for the container registry; 'null' if container register SKU a managed tier
     */
    @Beta(SinceVersion.V1_4_0)
    String storageAccountId();

    
Returns:
the login credentials for the specified container registry/**
     * @return the login credentials for the specified container registry
     */
    @Beta(SinceVersion.V1_4_0)
    @Method
    RegistryCredentials getCredentials();

    
Returns:
a representation of the future computation of this call/**
     * @return a representation of the future computation of this call
     */
    @Beta(SinceVersion.V1_4_0)
    @Method
    Observable<RegistryCredentials> getCredentialsAsync();

    
Regenerates one of the login credentials for the specified container registry.
Params:
accessKeyType – the admin user access key name to regenerate the value for
Returns:
the result of the regeneration/**
     * Regenerates one of the login credentials for the specified container registry.
     * @param accessKeyType the admin user access key name to regenerate the value for
     * @return the result of the regeneration
     */
    @Beta(SinceVersion.V1_4_0)
    RegistryCredentials regenerateCredential(AccessKeyType accessKeyType);

    
Regenerates one of the login credentials for the specified container registry.
Params:
accessKeyType – the admin user access key name to regenerate the value for
Returns:
a representation of the future computation of this call/**
     * Regenerates one of the login credentials for the specified container registry.
     *
     * @param accessKeyType the admin user access key name to regenerate the value for
     * @return a representation of the future computation of this call
     */
    @Beta(SinceVersion.V1_4_0)
    Observable<RegistryCredentials> regenerateCredentialAsync(AccessKeyType accessKeyType);

    
Lists the quota usages for the specified container registry.
Returns:
the list of container registry's quota usages/**
     * Lists the quota usages for the specified container registry.
     *
     * @return the list of container registry's quota usages
     */
    @Beta(SinceVersion.V1_4_0)
    @Method
    Collection<RegistryUsage> listQuotaUsages();

    
Lists the quota usages for the specified container registry.
Returns:
a representation of the future computation of this call/**
     * Lists the quota usages for the specified container registry.
     *
     * @return a representation of the future computation of this call
     */
    @Beta(SinceVersion.V1_4_0)
    @Method
    Observable<RegistryUsage> listQuotaUsagesAsync();

    
Returns:
returns the upload location for the user to be able to upload the source./**
     * @return returns the upload location for the user to be able to upload the source.
     */
    @Beta(SinceVersion.V1_14_0)
    SourceUploadDefinition getBuildSourceUploadUrl();

    
Gets the upload location for the user to be able to upload the source asynchronously.
Returns:
a representation of the future computation of this call/**
     * Gets the upload location for the user to be able to upload the source asynchronously.
     *
     * @return a representation of the future computation of this call
     */
    @Beta(SinceVersion.V1_14_0)
    Observable<SourceUploadDefinition> getBuildSourceUploadUrlAsync();

    
Returns:
returns entry point to manage container registry webhooks./**
     * @return returns entry point to manage container registry webhooks.
     */
    WebhookOperations webhooks();

    /**
     * @return returns entry point to manage the builds such as queued quick builds and queued build tasks
     *   for the container registry.
     */
//    @Beta(SinceVersion.V1_14_0)
//    QueuedBuildOperations queuedBuilds();

    
Returns:
returns entry point to manage the build tasks for the container registry./**
     * @return returns entry point to manage the build tasks for the container registry.
     */
//    @Beta(SinceVersion.V1_14_0)
//    BuildTaskOperations buildTasks();


    RegistryTaskRun.DefinitionStages.BlankFromRegistry scheduleRun();

    
Container interface for all the definitions related to a registry.
/**
     * Container interface for all the definitions related to a registry.
     */
    interface Definition extends
        DefinitionStages.Blank,
        DefinitionStages.WithGroup,
        DefinitionStages.WithSku,
        DefinitionStages.WithStorageAccount,
        DefinitionStages.WithCreate {
    }

    
Grouping of registry definition stages.
/**
     * Grouping of registry definition stages.
     */
    interface DefinitionStages {
        
The first stage of a container registry definition.
/**
         * The first stage of a container registry definition.
         */
        interface Blank extends
                GroupableResource.DefinitionWithRegion<WithGroup> {
        }

        
The stage of the container service definition allowing to specify the resource group.
/**
         * The stage of the container service definition allowing to specify the resource group.
         */
        @Beta(SinceVersion.V1_4_0)
        interface WithGroup extends
                GroupableResource.DefinitionStages.WithGroup<WithSku> {
        }

        
The stage of the registry definition allowing to specify the SKU type.
/**
         * The stage of the registry definition allowing to specify the SKU type.
         */
        interface WithSku {
            
Creates a container registry with a 'Classic' SKU type.
Returns:
the next stage of the definition/**
             * Creates a container registry with a 'Classic' SKU type.
             * @return the next stage of the definition
             */
            @Beta(SinceVersion.V1_4_0)
            WithStorageAccount withClassicSku();

            
Creates a 'managed' registry with a 'Basic' SKU type.
Returns:
the next stage of the definition/**
             * Creates a 'managed' registry with a 'Basic' SKU type.
             * @return the next stage of the definition
             */
            @Beta(SinceVersion.V1_4_0)
            WithCreate withBasicSku();

            
Creates a 'managed' registry with a 'Standard' SKU type.
Returns:
the next stage of the definition/**
             * Creates a 'managed' registry with a 'Standard' SKU type.
             * @return the next stage of the definition
             */
            @Beta(SinceVersion.V1_4_0)
            WithCreate withStandardSku();

            
Creates a 'managed' registry with a 'Premium' SKU type.
Returns:
the next stage of the definition/**
             * Creates a 'managed' registry with a 'Premium' SKU type.
             * @return the next stage of the definition
             */
            @Beta(SinceVersion.V1_4_0)
            WithCreate withPremiumSku();
        }


        
The stage of the registry definition allowing to specify the storage account.
/**
         * The stage of the registry definition allowing to specify the storage account.
         */
        interface WithStorageAccount {
            
The parameters of a storage account for the container registry.

If specified, the storage account must be in the same physical location as the container registry.
Params:
storageAccount – the storage account
Returns:
the next stage/**
             * The parameters of a storage account for the container registry.
             * <p>
             * If specified, the storage account must be in the same physical location as the container registry.
             *
             * @param storageAccount the storage account
             * @return the next stage
             */
            WithCreate withExistingStorageAccount(StorageAccount storageAccount);

            
The ID of an existing storage account for the container registry.

If specified, the storage account must be in the same physical location as the container registry.
Params:
id – the resource ID of the storage account; must be in the same physical location as the container registry
Returns:
the next stage/**
             * The ID of an existing storage account for the container registry.
             * <p>
             * If specified, the storage account must be in the same physical location as the container registry.
             *
             * @param id the resource ID of the storage account; must be in the same physical location as the container registry
             * @return the next stage
             */
            @Beta(SinceVersion.V1_4_0)
            WithCreate withExistingStorageAccount(String id);

            
The parameters for a storage account for the container registry.

A new storage account with default setting and specified name will be created.
Params:
storageAccountName – the name of the storage account
Returns:
the next stage/**
             * The parameters for a storage account for the container registry.
             * <p>
             * A new storage account with default setting and specified name will be created.
             *
             * @param storageAccountName the name of the storage account
             * @return the next stage
             */
            @Beta(SinceVersion.V1_4_0)
            WithCreate withNewStorageAccount(String storageAccountName);

            
The parameters for a storage account for the container registry.

If specified, the storage account must be in the same physical location as the container registry.
Params:
creatable – the storage account to create
Returns:
the next stage/**
             * The parameters for a storage account for the container registry.
             * <p>
             * If specified, the storage account must be in the same physical location as the container registry.
             *
             * @param creatable the storage account to create
             * @return the next stage
             */
            WithCreate withNewStorageAccount(Creatable<StorageAccount> creatable);
        }

        
The stage of the registry definition allowing to enable admin user.
/**
         * The stage of the registry definition allowing to enable admin user.
         */
        interface WithAdminUserEnabled {
            
Enable admin user.
Returns:
the next stage of the definition/**
             * Enable admin user.
             * @return the next stage of the definition
             */
            WithCreate withRegistryNameAsAdminUser();
        }

        
The stage of the container registry definition allowing to add or remove a webhook.
/**
         * The stage of the container registry definition allowing to add or remove a webhook.
         */
        interface WithWebhook {
            
Begins the definition of a new webhook to be added to this container registry.
Params:
name – the name of the new webhook
Returns:
the first stage of the new webhook definition/**
             * Begins the definition of a new webhook to be added to this container registry.
             *
             * @param name the name of the new webhook
             * @return the first stage of the new webhook definition
             */
            Webhook.DefinitionStages.Blank<WithCreate> defineWebhook(String name);
        }

        
The stage of the definition which contains all the minimum required inputs for the resource to be created,
 but also allows for any other optional settings to be specified.
/**
         * The stage of the definition which contains all the minimum required inputs for the resource to be created,
         *  but also allows for any other optional settings to be specified.
         */
        interface WithCreate extends
                Creatable<Registry>,
                WithAdminUserEnabled,
                WithWebhook,
                Resource.DefinitionWithTags<WithCreate> {
        }
    }

    
The template for an update operation, containing all the settings that can be modified.
/**
     * The template for an update operation, containing all the settings that can be modified.
     */
    interface Update extends
            Resource.UpdateWithTags<Update>,
            Appliable<Registry>,
            UpdateStages.WithAdminUserEnabled,
            UpdateStages.WithSku,
            UpdateStages.WithWebhook {
    }

    
Grouping of container service update stages.
/**
     * Grouping of container service update stages.
     */
    interface UpdateStages {
        
The stage of the registry update allowing to enable admin user.
/**
         * The stage of the registry update allowing to enable admin user.
         */
        interface WithAdminUserEnabled {
            
Enable admin user.
Returns:
the next stage of the definition/**
             * Enable admin user.
             * @return the next stage of the definition
             */
            Update withRegistryNameAsAdminUser();

            
Disable admin user.
Returns:
the next stage of the definition/**
             * Disable admin user.
             * @return the next stage of the definition
             */
            Update withoutRegistryNameAsAdminUser();
        }

        
The stage of the registry definition allowing to specify the SKU type.
/**
         * The stage of the registry definition allowing to specify the SKU type.
         */
        interface WithSku {
            
Updates the current container registry to a 'managed' registry with a 'Basic' SKU type.
Returns:
the next stage of the definition/**
             * Updates the current container registry to a 'managed' registry with a 'Basic' SKU type.
             * @return the next stage of the definition
             */
            @Beta(SinceVersion.V1_4_0)
            Update withBasicSku();

            
Updates the current container registry to a 'managed' registry with a 'Standard' SKU type.
Returns:
the next stage of the definition/**
             * Updates the current container registry to a 'managed' registry with a 'Standard' SKU type.
             * @return the next stage of the definition
             */
            @Beta(SinceVersion.V1_4_0)
            Update withStandardSku();

            
Updates the current container registry to a 'managed' registry with a 'Premium' SKU type.
Returns:
the next stage of the definition/**
             * Updates the current container registry to a 'managed' registry with a 'Premium' SKU type.
             * @return the next stage of the definition
             */
            @Beta(SinceVersion.V1_4_0)
            Update withPremiumSku();
        }

        
The stage of the container registry update allowing to add or remove a webhook.
/**
         * The stage of the container registry update allowing to add or remove a webhook.
         */
        interface WithWebhook {
            
Begins the definition of a new webhook to be added to this container registry.
Params:
name – the name of the new webhook
Returns:
the first stage of the new webhook definition/**
             * Begins the definition of a new webhook to be added to this container registry.
             * @param name the name of the new webhook
             * @return the first stage of the new webhook definition
             */
            Webhook.UpdateDefinitionStages.Blank<Update> defineWebhook(String name);

            
Removes a webhook from the container registry.
Params:
name – name of the webhook to remove
Returns:
the next stage of the container registry update/**
             * Removes a webhook from the container registry.
             * @param name name of the webhook to remove
             * @return the next stage of the container registry update
             */
            Update withoutWebhook(String name);

            
Begins the description of an update of an existing webhook of this container registry.
Params:
name – the name of an existing webhook
Returns:
the first stage of the webhook update description/**
             * Begins the description of an update of an existing webhook of this container registry.
             * @param name the name of an existing webhook
             * @return the first stage of the webhook update description
             */
            Webhook.UpdateResourceStages.Blank<Update> updateWebhook(String name);
        }
    }

}