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

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


An immutable client-side representation of an Azure registry Docker task run request.
/**
 * An immutable client-side representation of an Azure registry Docker task run request.
 */
@Fluent()
@Beta(SinceVersion.V1_17_0)
public interface RegistryDockerTaskRunRequest {
    
Returns:
the length of the timeout./**
     * @return the length of the timeout.
     */
    int timeout();

    
Returns:
the properties of the platform./**
     * @return the properties of the platform.
     */
    PlatformProperties platform();

    
Returns:
the number of CPUs./**
     * @return the number of CPUs.
     */
    int cpuCount();

    
Returns:
the location of the source control./**
     * @return the location of the source control.
     */
    String sourceLocation();

    
Returns:
whether archive is enabled./**
     * @return whether archive is enabled.
     */
    boolean isArchiveEnabled();

    
Container interface for all the definitions related to a registry Docker task run request.
/**
     * Container interface for all the definitions related to a registry Docker task run request.
     */
    interface Definition extends
            DefinitionStages.Blank,
            DefinitionStages.DockerFilePath,
            DefinitionStages.DockerTaskRunRequestStepAttachable {
    }

    
Grouping of registry Docker task run request definition stages.
/**
     * Grouping of registry Docker task run request definition stages.
     */
    interface DefinitionStages {
        
The first stage of a container registry Docker task run request definition.
/**
         * The first stage of a container registry Docker task run request definition.
         */
        interface Blank {
            
The function that begins the definition of the Docker task step in the task run request.
Returns:
the next stage of the container Docker task run request definition./**
             * The function that begins the definition of the Docker task step in the task run request.
             *
             * @return the next stage of the container Docker task run request definition.
             */
            DockerFilePath defineDockerTaskStep();
        }

        
The stage of the container Docker task run request definition that specifies the path to the Docker file.
/**
         * The stage of the container Docker task run request definition that specifies 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 Docker task run request 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 Docker task run request definition.
             */
            DockerTaskRunRequestStepAttachable 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 DockerTaskRunRequestStepAttachable extends Attachable<RegistryTaskRun.DefinitionStages.RunRequestExecutableWithSourceLocation> {
            
The function that specifies the list of image names.
Params:
imageNames – the list of image names.
Returns:
the next stage of the container Docker task run request definition./**
             * The function that specifies the list of image names.
             *
             * @param imageNames the list of image names.
             * @return the next stage of the container Docker task run request definition.
             */
            DockerTaskRunRequestStepAttachable withImageNames(List<String> imageNames);

            
The function that specifies push is enabled or not.
Params:
enabled – whether push is enabled.
Returns:
the next stage of the container Docker task run request definition./**
             * The function that specifies push is enabled or not.
             *
             * @param enabled whether push is enabled.
             * @return the next stage of the container Docker task run request definition.
             */
            DockerTaskRunRequestStepAttachable withPushEnabled(boolean enabled);

            
The function that specifies a cache will be used or not.
Params:
enabled – whether caching is enabled or not.
Returns:
the next stage of the container Docker task run request definition./**
             * The function that specifies a cache will be used or not.
             *
             * @param enabled whether caching is enabled or not.
             * @return the next stage of the container Docker task run request definition.
             */
            DockerTaskRunRequestStepAttachable 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 argument to be overridden and value OverridingArgument specifying the content of the overriding argument.
Returns:
the next stage of the container Docker task run request definition./**
             * The function that specifies the overriding arguments and what they will override.
             *
             * @param overridingArguments map with key of the name of the argument to be overridden and value OverridingArgument specifying the content of the overriding argument.
             * @return the next stage of the container Docker task run request definition.
             */
            DockerTaskRunRequestStepAttachable 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 run request 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 run request definition.
             */
            DockerTaskRunRequestStepAttachable withOverridingArgument(String name, OverridingArgument overridingArgument);
        }
    }
}