https://github.com/Azure/azure-sdk-for-java: This package contains Microsoft BatchAI Management SDK. A new set of management libraries are now Generally Available. For documentation on how to use the new libraries, please see https://aka.ms/azsdk/java/mgmt
  • Microsoft 
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.batchai;

import com.microsoft.azure.management.apigeneration.Beta;
import com.microsoft.azure.management.apigeneration.Fluent;
import com.microsoft.azure.management.resources.fluentcore.arm.models.HasParent;
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.Indexable;


A client-side representation of a mode setup task of a Batch AI cluster.

/**
 * A client-side representation of a mode setup task of a Batch AI cluster.
 */
@Fluent
@Beta(Beta.SinceVersion.V1_6_0)
public interface NodeSetupTask extends
        HasInner<SetupTask>,
        Indexable,
        HasParent<BatchAICluster> {
    
Grouping of node setup definition stages.

/**
     * Grouping of node setup definition stages.
     */
    interface DefinitionStages {
        
The first stage of the node setup definition.

Type parameters:
  • <ParentT> – the stage of the parent definition to return to after attaching this definition
/**
         * The first stage of the node setup definition.
         * @param <ParentT> the stage of the parent definition to return to after attaching this definition
         */
        interface Blank<ParentT> extends WithCommandLine<ParentT> {
        }

        
The stage of the setup task definition allowing to specify the command line instructions.

Type parameters:
  • <ParentT> – the stage of the parent definition to return to after attaching this definition
/**
         * The stage of the setup task definition allowing to specify the command line instructions.
         * @param <ParentT> the stage of the parent definition to return to after attaching this definition
         */
        interface WithCommandLine<ParentT> {
            
Params:
  • commandLine – command Line to start Setup process
Returns:the next stage of the definition
/**
             * @param commandLine command Line to start Setup process
             * @return the next stage of the definition
             */
            WithStdOutErrPath<ParentT> withCommandLine(String commandLine);
        }

        
The stage of the setup task definition allowing to specify where Batch AI will upload stdout and stderr of the setup task.

Type parameters:
  • <ParentT> – the stage of the parent definition to return to after attaching this definition
/**
         * The stage of the setup task definition allowing to specify where Batch AI will upload stdout and stderr of the setup task.
         * @param <ParentT> the stage of the parent definition to return to after attaching this definition
         */
        interface WithStdOutErrPath<ParentT> {
            
Params:
  • stdOutErrPathPrefix – the path where the Batch AI service will upload the stdout and stderror of setup task
Returns:the next stage of the definition
/**
             * @param stdOutErrPathPrefix the path where the Batch AI service will upload the stdout and stderror of setup task
             * @return the next stage of the definition
             */
            WithAttach<ParentT> withStdOutErrPath(String stdOutErrPathPrefix);
        }

        
The stage of the setup task definition allowing to specify environment variables.

Type parameters:
  • <ParentT> – the stage of the parent definition to return to after attaching this definition
/**
         * The stage of the setup task definition allowing to specify environment variables.
         * @param <ParentT> the stage of the parent definition to return to after attaching this definition
         */
        interface WithEnvironmentVariable<ParentT> {
            
Params:
  • name – name of the variable to set
  • value – value of the variable to set
Returns:the next stage of the definition
/**
             * @param name name of the variable to set
             * @param value value of the variable to set
             * @return the next stage of the definition
             */
            WithAttach<ParentT> withEnvironmentVariable(String name, String value);
        }

        
The stage of the setup task definition allowing to specify environment variables with secrets.

Type parameters:
  • <ParentT> – the stage of the parent definition to return to after attaching this definition
/**
         * The stage of the setup task definition allowing to specify environment variables with secrets.
         * @param <ParentT> the stage of the parent definition to return to after attaching this definition
         */
        interface WithEnvironmentVariableSecretValue<ParentT> {
            
Sets the value of the environment variable. This value will never be reported
back by Batch AI.

Params:
  • name – name of the variable to set
  • value – value of the variable to set
Returns:the next stage of the definition
/**
             * Sets the value of the environment variable. This value will never be reported
             * back by Batch AI.
             * @param name name of the variable to set
             * @param value value of the variable to set
             * @return the next stage of the definition
             */
            WithAttach<ParentT> withEnvironmentVariableSecretValue(String name, String value);

            
Specifies KeyVault Store and Secret which contains the value for the
environment variable.

Params:
  • name – name of the variable to set
  • keyVaultId – fully qualified resource Id for the Key Vault
  • secretUrl – the URL referencing a secret in a Key Vault
Returns:the next stage of the definition
/**
             * Specifies KeyVault Store and Secret which contains the value for the
             * environment variable.
             * @param name name of the variable to set
             * @param keyVaultId fully qualified resource Id for the Key Vault
             * @param secretUrl the URL referencing a secret in a Key Vault
             * @return the next stage of the definition
             */
            WithAttach<ParentT> withEnvironmentVariableSecretValue(String name, String keyVaultId, String secretUrl);
        }

        
The final stage of the setup task definition.
At this stage, any remaining optional settings can be specified, or the setup task definition
can be attached to the parent cluster definition.

Type parameters:
  • <ParentT> – the stage of the parent definition to return to after attaching this definition
/** The final stage of the setup task definition.
         * At this stage, any remaining optional settings can be specified, or the setup task definition
         * can be attached to the parent cluster definition.
         * @param <ParentT> the stage of the parent definition to return to after attaching this definition
         */
        interface WithAttach<ParentT> extends
                Attachable.InDefinition<ParentT>,
                WithEnvironmentVariable<ParentT>,
                WithEnvironmentVariableSecretValue<ParentT> {
        }
    }

    
The entirety of a setup task definition.

Type parameters:
  • <ParentT> – the stage of the parent definition to return to after attaching this definition
/** The entirety of a setup task definition.
     * @param <ParentT> the stage of the parent definition to return to after attaching this definition
     */
    interface Definition<ParentT> extends
            DefinitionStages.Blank<ParentT>,
            DefinitionStages.WithStdOutErrPath<ParentT>,
            DefinitionStages.WithEnvironmentVariable<ParentT>,
            DefinitionStages.WithAttach<ParentT> {
    }
}