StaticSiteBuildProperties Class

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

Implements

public final class StaticSiteBuildProperties
implements JsonSerializable<StaticSiteBuildProperties>

Build properties for the static site.

Constructor Summary

Constructor Description
StaticSiteBuildProperties()

Creates an instance of StaticSiteBuildProperties class.

Method Summary

Modifier and Type Method and Description
String apiBuildCommand()

Get the apiBuildCommand property: A custom command to run during deployment of the Azure Functions API application.

String apiLocation()

Get the apiLocation property: The path to the api code within the repository.

String appArtifactLocation()

Get the appArtifactLocation property: Deprecated: The path of the app artifacts after building (deprecated in favor of OutputLocation).

String appBuildCommand()

Get the appBuildCommand property: A custom command to run during deployment of the static content application.

String appLocation()

Get the appLocation property: The path to the app code within the repository.

static StaticSiteBuildProperties fromJson(JsonReader jsonReader)

Reads an instance of StaticSiteBuildProperties from the JsonReader.

String githubActionSecretNameOverride()

Get the githubActionSecretNameOverride property: Github Action secret name override.

String outputLocation()

Get the outputLocation property: The output path of the app after building.

Boolean skipGithubActionWorkflowGeneration()

Get the skipGithubActionWorkflowGeneration property: Skip Github Action workflow generation.

JsonWriter toJson(JsonWriter jsonWriter)
void validate()

Validates the instance.

StaticSiteBuildProperties withApiBuildCommand(String apiBuildCommand)

Set the apiBuildCommand property: A custom command to run during deployment of the Azure Functions API application.

StaticSiteBuildProperties withApiLocation(String apiLocation)

Set the apiLocation property: The path to the api code within the repository.

StaticSiteBuildProperties withAppArtifactLocation(String appArtifactLocation)

Set the appArtifactLocation property: Deprecated: The path of the app artifacts after building (deprecated in favor of OutputLocation).

StaticSiteBuildProperties withAppBuildCommand(String appBuildCommand)

Set the appBuildCommand property: A custom command to run during deployment of the static content application.

StaticSiteBuildProperties withAppLocation(String appLocation)

Set the appLocation property: The path to the app code within the repository.

StaticSiteBuildProperties withGithubActionSecretNameOverride(String githubActionSecretNameOverride)

Set the githubActionSecretNameOverride property: Github Action secret name override.

StaticSiteBuildProperties withOutputLocation(String outputLocation)

Set the outputLocation property: The output path of the app after building.

StaticSiteBuildProperties withSkipGithubActionWorkflowGeneration(Boolean skipGithubActionWorkflowGeneration)

Set the skipGithubActionWorkflowGeneration property: Skip Github Action workflow generation.

Methods inherited from java.lang.Object

Constructor Details

StaticSiteBuildProperties

public StaticSiteBuildProperties()

Creates an instance of StaticSiteBuildProperties class.

Method Details

apiBuildCommand

public String apiBuildCommand()

Get the apiBuildCommand property: A custom command to run during deployment of the Azure Functions API application.

Returns:

the apiBuildCommand value.

apiLocation

public String apiLocation()

Get the apiLocation property: The path to the api code within the repository.

Returns:

the apiLocation value.

appArtifactLocation

public String appArtifactLocation()

Get the appArtifactLocation property: Deprecated: The path of the app artifacts after building (deprecated in favor of OutputLocation).

Returns:

the appArtifactLocation value.

appBuildCommand

public String appBuildCommand()

Get the appBuildCommand property: A custom command to run during deployment of the static content application.

Returns:

the appBuildCommand value.

appLocation

public String appLocation()

Get the appLocation property: The path to the app code within the repository.

Returns:

the appLocation value.

fromJson

public static StaticSiteBuildProperties fromJson(JsonReader jsonReader)

Reads an instance of StaticSiteBuildProperties from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of StaticSiteBuildProperties if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If an error occurs while reading the StaticSiteBuildProperties.

githubActionSecretNameOverride

public String githubActionSecretNameOverride()

Get the githubActionSecretNameOverride property: Github Action secret name override.

Returns:

the githubActionSecretNameOverride value.

outputLocation

public String outputLocation()

Get the outputLocation property: The output path of the app after building.

Returns:

the outputLocation value.

skipGithubActionWorkflowGeneration

public Boolean skipGithubActionWorkflowGeneration()

Get the skipGithubActionWorkflowGeneration property: Skip Github Action workflow generation.

Returns:

the skipGithubActionWorkflowGeneration value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

validate

public void validate()

Validates the instance.

withApiBuildCommand

public StaticSiteBuildProperties withApiBuildCommand(String apiBuildCommand)

Set the apiBuildCommand property: A custom command to run during deployment of the Azure Functions API application.

Parameters:

apiBuildCommand - the apiBuildCommand value to set.

Returns:

the StaticSiteBuildProperties object itself.

withApiLocation

public StaticSiteBuildProperties withApiLocation(String apiLocation)

Set the apiLocation property: The path to the api code within the repository.

Parameters:

apiLocation - the apiLocation value to set.

Returns:

the StaticSiteBuildProperties object itself.

withAppArtifactLocation

public StaticSiteBuildProperties withAppArtifactLocation(String appArtifactLocation)

Set the appArtifactLocation property: Deprecated: The path of the app artifacts after building (deprecated in favor of OutputLocation).

Parameters:

appArtifactLocation - the appArtifactLocation value to set.

Returns:

the StaticSiteBuildProperties object itself.

withAppBuildCommand

public StaticSiteBuildProperties withAppBuildCommand(String appBuildCommand)

Set the appBuildCommand property: A custom command to run during deployment of the static content application.

Parameters:

appBuildCommand - the appBuildCommand value to set.

Returns:

the StaticSiteBuildProperties object itself.

withAppLocation

public StaticSiteBuildProperties withAppLocation(String appLocation)

Set the appLocation property: The path to the app code within the repository.

Parameters:

appLocation - the appLocation value to set.

Returns:

the StaticSiteBuildProperties object itself.

withGithubActionSecretNameOverride

public StaticSiteBuildProperties withGithubActionSecretNameOverride(String githubActionSecretNameOverride)

Set the githubActionSecretNameOverride property: Github Action secret name override.

Parameters:

githubActionSecretNameOverride - the githubActionSecretNameOverride value to set.

Returns:

the StaticSiteBuildProperties object itself.

withOutputLocation

public StaticSiteBuildProperties withOutputLocation(String outputLocation)

Set the outputLocation property: The output path of the app after building.

Parameters:

outputLocation - the outputLocation value to set.

Returns:

the StaticSiteBuildProperties object itself.

withSkipGithubActionWorkflowGeneration

public StaticSiteBuildProperties withSkipGithubActionWorkflowGeneration(Boolean skipGithubActionWorkflowGeneration)

Set the skipGithubActionWorkflowGeneration property: Skip Github Action workflow generation.

Parameters:

skipGithubActionWorkflowGeneration - the skipGithubActionWorkflowGeneration value to set.

Returns:

the StaticSiteBuildProperties object itself.

Applies to