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.compute;

import com.microsoft.azure.PagedList;
import com.microsoft.azure.management.apigeneration.Fluent;
import com.microsoft.azure.management.compute.implementation.ComputeManager;
import com.microsoft.azure.management.compute.implementation.GalleryInner;
import com.microsoft.azure.management.resources.fluentcore.arm.models.GroupableResource;
import com.microsoft.azure.management.resources.fluentcore.arm.models.HasManager;
import com.microsoft.azure.management.resources.fluentcore.arm.models.HasResourceGroup;
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.HasInner;
import com.microsoft.azure.management.resources.fluentcore.model.Refreshable;
import com.microsoft.azure.management.resources.fluentcore.model.Updatable;
import rx.Observable;

An immutable client-side representation of an Azure gallery.
/**
 * An immutable client-side representation of an Azure gallery.
 */
@Fluent
public interface Gallery extends HasInner<GalleryInner>,
        Resource,
        GroupableResource<ComputeManager, GalleryInner>,
        HasResourceGroup,
        Refreshable<Gallery>,
        Updatable<Gallery.Update>,
        HasManager<ComputeManager> {
    
Returns:
description for the gallery resource./**
     * @return description for the gallery resource.
     */
    String description();

    
Returns:
the unique name of the gallery resource./**
     * @return the unique name of the gallery resource.
     */
    String uniqueName();

    
Returns:
the provisioning state of the gallery resource./**
     * @return the provisioning state of the gallery resource.
     */
    String provisioningState();

    
Retrieves information about an image in the gallery.
Params:
imageName – The name of the image.
Throws:
IllegalArgumentException – thrown if parameters fail the validation
Returns:
the observable for the request/**
     * Retrieves information about an image in the gallery.
     *
     * @param imageName The name of the image.
     * @throws IllegalArgumentException thrown if parameters fail the validation
     * @return the observable for the request
     */
    Observable<GalleryImage> getImageAsync(String imageName);

    
Retrieves information about an image in the gallery.
Params:
imageName – The name of the image.
Throws:
IllegalArgumentException – thrown if parameters fail the validation
Returns:
the gallery image/**
     * Retrieves information about an image in the gallery.
     *
     * @param imageName The name of the image.
     * @throws IllegalArgumentException thrown if parameters fail the validation
     * @return the gallery image
     */
    GalleryImage getImage(String imageName);

    
List images in the gallery.
Returns:
the observable for the request/**
     * List images in the gallery.
     *
     * @return the observable for the request
     */
    Observable<GalleryImage> listImagesAsync();

    
List images in the gallery.
Returns:
the list of images in the gallery/**
     * List images in the gallery.
     *
     * @return the list of images in the gallery
     */
    PagedList<GalleryImage> listImages();

    
The entirety of the gallery definition.
/**
     * The entirety of the gallery definition.
     */
    interface Definition extends DefinitionStages.Blank, DefinitionStages.WithGroup, DefinitionStages.WithCreate {
    }

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

        
The stage of the gallery definition allowing to specify the resource group.
/**
         * The stage of the gallery definition allowing to specify the resource group.
         */
        interface WithGroup extends GroupableResource.DefinitionStages.WithGroup<WithCreate> {
        }

        
The stage of the gallery definition allowing to specify description.
/**
         * The stage of the gallery definition allowing to specify description.
         */
        interface WithDescription {
            
Specifies description for the gallery.
Params:
description – The description
Returns:
the next definition stage/**
             * Specifies description for the gallery.
             *
             * @param description The description
             * @return the next definition stage
             */
            WithCreate withDescription(String description);
        }

        
The stage of the definition which contains all the minimum required inputs for the resource to be created (via Creatable<Gallery>.create()), 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 (via {@link WithCreate#create()}), but also allows
         * for any other optional settings to be specified.
         */
        interface WithCreate extends Creatable<Gallery>,
                Resource.DefinitionWithTags<WithCreate>,
                DefinitionStages.WithDescription {
        }
    }
    
The template for a Gallery update operation, containing all the settings that can be modified.
/**
     * The template for a Gallery update operation, containing all the settings that can be modified.
     */
    interface Update extends Appliable<Gallery>,
            Resource.UpdateWithTags<Update>,
            UpdateStages.WithDescription {
    }

    
Grouping of gallery update stages.
/**
     * Grouping of gallery update stages.
     */
    interface UpdateStages {
        
The stage of the gallery update allowing to specify description.
/**
         * The stage of the gallery update allowing to specify description.
         */
        interface WithDescription {
            
Specifies description for the gallery.
Params:
description – The description
Returns:
the next update stage/**
             * Specifies description for the gallery.
             * @param description The description
             * @return the next update stage
             */
            Update withDescription(String description);
        }
    }
}