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.Beta;
import com.microsoft.azure.management.apigeneration.Fluent;
import com.microsoft.azure.management.resources.fluentcore.model.Attachable;
import com.microsoft.azure.management.resources.fluentcore.model.HasInner;
import com.microsoft.azure.management.resources.fluentcore.model.Settable;

import java.util.List;
import java.util.Map;

An immutable client-side representation of an Azure RegistryDockerTaskStep registry task.
/**
 * An immutable client-side representation of an Azure RegistryDockerTaskStep registry task.
 */
@Fluent()
@Beta(Beta.SinceVersion.V1_17_0)
public interface RegistryDockerTaskStep extends
        HasInner<DockerTaskStep>,
        RegistryTaskStep {
    
Returns:
the image names of this Docker task step/**
     * @return the image names of this Docker task step
     */
    List<String> imageNames();

    
Returns:
whether push is enabled for this Docker task step/**
     * @return whether push is enabled for this Docker task step
     */
    boolean isPushEnabled();

    
Returns:
whether there is no cache for this Docker task step/**
     * @return whether there is no cache for this Docker task step
     */
    boolean noCache();

    
Returns:
Docker file path for this Docker task step/**
     * @return Docker file path for this Docker task step
     */
    String dockerFilePath();

    
Returns:
the arguments this Docker task step/**
     * @return the arguments this Docker task step
     */
    List<Argument> arguments();

    
Container interface for all the definitions related to a RegistryDockerTaskStep.
/**
     * Container interface for all the definitions related to a RegistryDockerTaskStep.
     */
    interface Definition extends
            RegistryDockerTaskStep.DefinitionStages.Blank,
            RegistryDockerTaskStep.DefinitionStages.DockerFilePath,
            RegistryDockerTaskStep.DefinitionStages.DockerTaskStepAttachable {
    }

    
Container interface for all the updates related to a RegistryDockerTaskStep.
/**
     * Container interface for all the updates related to a RegistryDockerTaskStep.
     */
    interface Update extends
            RegistryDockerTaskStep.UpdateStages.DockerFilePath,
            RegistryDockerTaskStep.UpdateStages.ImageNames,
            RegistryDockerTaskStep.UpdateStages.Push,
            RegistryDockerTaskStep.UpdateStages.Cache,
            RegistryDockerTaskStep.UpdateStages.OverridingArgumentUpdate,
            Settable<RegistryTask.Update> {
    }

    
Grouping of registry Docker task definition stages.
/**
     * Grouping of registry Docker task definition stages.
     */
    interface DefinitionStages {

        
The first stage of a DockerFileTaskStep definition.
/**
         * The first stage of a DockerFileTaskStep definition.
         */
        interface Blank extends DockerFilePath {
        }

        
The stage of the container registry DockerTaskStep definition allowing to specify the path to the Docker file.
/**
         * The stage of the container registry DockerTaskStep definition allowing to specify the path to the Docker file.
         */
        interface DockerFilePath {
            
The function that specifies the path to the Docker file.
Params:
path – the path to the Docker file.
Returns:
the next stage of the container registry DockerTaskStep definition./**
             * The function that specifies the path to the Docker file.
             *
             * @param path the path to the Docker file.
             * @return the next stage of the container registry DockerTaskStep definition.
             */
            DockerTaskStepAttachable withDockerFilePath(String path);
        }

        
The stage of the definition which contains all the minimum required inputs for the resource to be attached,
 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 attached,
         *  but also allows for any other optional settings to be specified.
         */
        interface DockerTaskStepAttachable extends Attachable<RegistryTask.DefinitionStages.SourceTriggerDefinition> {
            
The function that specifies the list of image names.
Params:
imageNames – the image names.
Returns:
the next step of the container registry DockerTaskStep definition./**
             * The function that specifies the list of image names.
             *
             * @param imageNames the image names.
             * @return the next step of the container registry DockerTaskStep definition.
             */
            DockerTaskStepAttachable withImageNames(List<String> imageNames);

            
The function that enables push depending on user input parameter.
Params:
enabled – whether push will be enabled
Returns:
the next step of the container registry DockerTaskStep definition./**
             * The function that enables push depending on user input parameter.
             *
             * @param enabled whether push will be enabled
             * @return the next step of the container registry DockerTaskStep definition.
             */
            DockerTaskStepAttachable withPushEnabled(boolean enabled);

            
The function that specifies the use of a cache based on user input parameter.
Params:
enabled – whether caching will be enabled.
Returns:
the next step of the container registry DockerTaskStep definition./**
             * The function that specifies the use of a cache based on user input parameter.
             *
             * @param enabled whether caching will be enabled.
             * @return the next step of the container registry DockerTaskStep definition.
             */
            DockerTaskStepAttachable withCacheEnabled(boolean enabled);

            
The function that specifies the overriding arguments and what they will override.
Params:
overridingArguments – map with key of the name of the value to be overridden and value OverridingArgument specifying the content of the overriding argument.
Returns:
the next stage of the container Docker task step definition./**
             * The function that specifies the overriding arguments and what they will override.
             *
             * @param overridingArguments map with key of the name of the value to be overridden and value OverridingArgument specifying the content of the overriding argument.
             * @return the next stage of the container Docker task step definition.
             */
            DockerTaskStepAttachable withOverridingArguments(Map<String, OverridingArgument> overridingArguments);

            
The function that specifies the overriding argument and what it will override.
Params:
name – the name of the value to be overridden.
overridingArgument – the content of the overriding argument.
Returns:
the next stage of the container Docker task step definition./**
             * The function that specifies the overriding argument and what it will override.
             *
             * @param name the name of the value to be overridden.
             * @param overridingArgument the content of the overriding argument.
             * @return the next stage of the container Docker task step definition.
             */
            DockerTaskStepAttachable withOverridingArgument(String name, OverridingArgument overridingArgument);

        }
    }

    
Grouping of registry Docker task update stages.
/**
     * Grouping of registry Docker task update stages.
     */
    interface UpdateStages {
        
The stage of the container registry DockerTaskStep update allowing to specify the Docker file path.
/**
         * The stage of the container registry DockerTaskStep update allowing to specify the Docker file path.
         */
        interface DockerFilePath {
            
The function that specifies the path to the Docker file.
Params:
path – the path to the Docker file.
Returns:
the next stage of the container registry DockerTaskStep update./**
             * The function that specifies the path to the Docker file.
             *
             * @param path the path to the Docker file.
             * @return the next stage of the container registry DockerTaskStep update.
             */
            Update withDockerFilePath(String path);
        }

        
The stage of the container registry DockerTaskStep update allowing to specify the image names.
/**
         * The stage of the container registry DockerTaskStep update allowing to specify the image names.
         */
        interface ImageNames {
            
The function that specifies the image names.
Params:
imageNames – the list of the names of the images.
Returns:
the next stage of the container registry DockerTaskStep update./**
             * The function that specifies the image names.
             *
             * @param imageNames the list of the names of the images.
             * @return the next stage of the container registry DockerTaskStep update.
             */
            Update withImageNames(List<String> imageNames);
        }

        
The stage of the container registry DockerTaskStep update allowing to specify whether push is enabled or not.
/**
         * The stage of the container registry DockerTaskStep update allowing to specify whether push is enabled or not.
         */
        interface Push {
            
The function that specifies push is enabled.
Params:
enabled – whether push is enabled.
Returns:
the next stage of the container registry DockerTaskStep update./**
             * The function that specifies push is enabled.
             *
             * @param enabled whether push is enabled.
             * @return the next stage of the container registry DockerTaskStep update.
             */
            Update withPushEnabled(boolean enabled);
        }

        
The stage of the container registry DockerTaskStep update allowing to specify whether to have a cache or not.
/**
         * The stage of the container registry DockerTaskStep update allowing to specify whether to have a cache or not.
         */
        interface Cache {
            
The function that specifies the task has a cache.
Params:
enabled – whether caching is enabled.
Returns:
the next stage of the container registry DockerTaskStep update./**
             * The function that specifies the task has a cache.
             *
             * @param enabled whether caching is enabled.
             * @return the next stage of the container registry DockerTaskStep update.
             */
            Update withCacheEnabled(boolean enabled);

        }

        
The stage of the container registry DockerTaskStep update allowing to specify any overriding arguments.
/**
         * The stage of the container registry DockerTaskStep update allowing to specify any overriding arguments.
         */
        interface OverridingArgumentUpdate {
            
The function that specifies the overriding arguments and what they will override.
Params:
overridingArguments – map with key of the name of the value to be overridden and value OverridingArgument specifying the content of the overriding argument.
Returns:
the next stage of the container Docker task step update./**
             * The function that specifies the overriding arguments and what they will override.
             *
             * @param overridingArguments map with key of the name of the value to be overridden and value OverridingArgument specifying the content of the overriding argument.
             * @return the next stage of the container Docker task step update.
             */
            Update withOverridingArguments(Map<String, OverridingArgument> overridingArguments);

            
The function that specifies the overriding argument and what it will override.
Params:
name – the name of the value to be overridden.
overridingArgument – the content of the overriding argument.
Returns:
the next stage of the container Docker task step update./**
             * The function that specifies the overriding argument and what it will override.
             *
             * @param name the name of the value to be overridden.
             * @param overridingArgument the content of the overriding argument.
             * @return the next stage of the container Docker task step update.
             */
            Update withOverridingArgument(String name, OverridingArgument overridingArgument);
        }
    }
}