Partager via


DeployOptions Class

  • java.lang.Object
    • com.azure.resourcemanager.appservice.models.DeployOptions

public class DeployOptions

The options for OneDeploy.

Constructor Summary

Constructor Description
DeployOptions()

Creates a new instance of DeployOptions.

Method Summary

Modifier and Type Method and Description
Boolean cleanDeployment()

Check whether to perform clean deployment.

String path()

Gets the path for deploy.

Boolean restartSite()

Check whether to restart site after deployment.

Boolean trackDeployment()

Check whether to track deployment progress.

DeployOptions withCleanDeployment(Boolean cleanDeployment)

Specifies whether to perform clean deployment.

DeployOptions withPath(String path)

Specifies the path for deploy.

DeployOptions withRestartSite(Boolean restartSite)

Specifies whether to restart site after deployment.

DeployOptions withTrackDeployment(Boolean trackDeployment)

Specifies whether to have deploymentId() to track deployment progress.

Methods inherited from java.lang.Object

Constructor Details

DeployOptions

public DeployOptions()

Creates a new instance of DeployOptions.

Method Details

cleanDeployment

public Boolean cleanDeployment()

Check whether to perform clean deployment.

Returns:

whether to perform clean deployment

path

public String path()

Gets the path for deploy.

Returns:

the path for deploy

restartSite

public Boolean restartSite()

Check whether to restart site after deployment.

Returns:

whether to restart site after deployment

trackDeployment

public Boolean trackDeployment()

Check whether to track deployment progress.

Returns:

whether to track deployment progress

withCleanDeployment

public DeployOptions withCleanDeployment(Boolean cleanDeployment)

Specifies whether to perform clean deployment.

By default type=zip and type=war&path=webapps/ performs clean deployment. All other types of artifacts will be deployed incrementally. The default behavior for any artifact type can be changed by this option. A clean deployment removes the default directory associated with the type of artifact being deployed.

Parameters:

cleanDeployment - whether to perform clean deployment

Returns:

the DeployOptions object

withPath

public DeployOptions withPath(String path)

Specifies the path for deploy. Some some deploy type, path is required.

Parameters:

path - the path for deploy

Returns:

the DeployOptions object

withRestartSite

public DeployOptions withRestartSite(Boolean restartSite)

Specifies whether to restart site after deployment.

By default, any OneDeploy call will restart the site. This behavior can be altered by this option.

Parameters:

restartSite - whether to restart side after deployment

Returns:

the DeployOptions object

withTrackDeployment

public DeployOptions withTrackDeployment(Boolean trackDeployment)

Specifies whether to have deploymentId() to track deployment progress.

This option only takes effect when used in SupportsOneDeploy#pushDeploy(DeployType, java.io.File, DeployOptions).

Parameters:

trackDeployment - whether to track deployment progress

Returns:

the DeployOptions object

Applies to