DeploymentSettings Class

Package:

com.azure.resourcemanager.appplatform.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-appplatform:2.45.0

• java.lang.Object
• • com.azure.resourcemanager.appplatform.models.DeploymentSettings

Implements

JsonSerializable<DeploymentSettings>

public final class DeploymentSettings
implements JsonSerializable<DeploymentSettings>

Deployment settings payload.

Constructor Summary

Constructor	Description
DeploymentSettings()	Creates an instance of DeploymentSettings class.

Method Summary

Modifier and Type	Method and Description
Map<String,Map<String,Object>>	addonConfigs() Get the addonConfigs property: Collection of addons.
List<ApmReference>	apms() Get the apms property: Collection of ApmReferences.
ContainerProbeSettings	containerProbeSettings() Get the containerProbeSettings property: Container liveness and readiness probe settings.
Map<String,String>	environmentVariables() Get the environmentVariables property: Collection of environment variables.
static DeploymentSettings	fromJson(JsonReader jsonReader) Reads an instance of DeploymentSettings from the JsonReader.
Probe	livenessProbe() Get the livenessProbe property: Periodic probe of App Instance liveness.
Probe	readinessProbe() Get the readinessProbe property: Periodic probe of App Instance service readiness.
ResourceRequests	resourceRequests() Get the resourceRequests property: The requested resource quantity for required CPU and Memory.
Probe	startupProbe() Get the startupProbe property: StartupProbe indicates that the App Instance has successfully initialized.
Integer	terminationGracePeriodSeconds() Get the terminationGracePeriodSeconds property: Optional duration in seconds the App Instance needs to terminate gracefully.
JsonWriter	toJson(JsonWriter jsonWriter)
void	validate() Validates the instance.
DeploymentSettings	withAddonConfigs(Map<String,Map<String,Object>> addonConfigs) Set the addonConfigs property: Collection of addons.
DeploymentSettings	withApms(List<ApmReference> apms) Set the apms property: Collection of ApmReferences.
DeploymentSettings	withContainerProbeSettings(ContainerProbeSettings containerProbeSettings) Set the containerProbeSettings property: Container liveness and readiness probe settings.
DeploymentSettings	withEnvironmentVariables(Map<String,String> environmentVariables) Set the environmentVariables property: Collection of environment variables.
DeploymentSettings	withLivenessProbe(Probe livenessProbe) Set the livenessProbe property: Periodic probe of App Instance liveness.
DeploymentSettings	withReadinessProbe(Probe readinessProbe) Set the readinessProbe property: Periodic probe of App Instance service readiness.
DeploymentSettings	withResourceRequests(ResourceRequests resourceRequests) Set the resourceRequests property: The requested resource quantity for required CPU and Memory.
DeploymentSettings	withStartupProbe(Probe startupProbe) Set the startupProbe property: StartupProbe indicates that the App Instance has successfully initialized.
DeploymentSettings	withTerminationGracePeriodSeconds(Integer terminationGracePeriodSeconds) Set the terminationGracePeriodSeconds property: Optional duration in seconds the App Instance needs to terminate gracefully.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

DeploymentSettings

public DeploymentSettings()

Creates an instance of DeploymentSettings class.

Method Details

addonConfigs

public Map> addonConfigs()

Get the addonConfigs property: Collection of addons.

Returns:

the addonConfigs value.

apms

public List apms()

Get the apms property: Collection of ApmReferences.

Returns:

the apms value.

containerProbeSettings

public ContainerProbeSettings containerProbeSettings()

Get the containerProbeSettings property: Container liveness and readiness probe settings.

Returns:

the containerProbeSettings value.

environmentVariables

public Map environmentVariables()

Get the environmentVariables property: Collection of environment variables.

Returns:

the environmentVariables value.

fromJson

public static DeploymentSettings fromJson(JsonReader jsonReader)

Reads an instance of DeploymentSettings from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of DeploymentSettings 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 DeploymentSettings.

livenessProbe

public Probe livenessProbe()

Get the livenessProbe property: Periodic probe of App Instance liveness. App Instance will be restarted if the probe fails. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle\#container-probes.

Returns:

the livenessProbe value.

readinessProbe

public Probe readinessProbe()

Get the readinessProbe property: Periodic probe of App Instance service readiness. App Instance will be removed from service endpoints if the probe fails. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle\#container-probes.

Returns:

the readinessProbe value.

resourceRequests

public ResourceRequests resourceRequests()

Get the resourceRequests property: The requested resource quantity for required CPU and Memory. It is recommended that using this field to represent the required CPU and Memory, the old field cpu and memoryInGB will be deprecated later.

Returns:

the resourceRequests value.

startupProbe

public Probe startupProbe()

Get the startupProbe property: StartupProbe indicates that the App Instance has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a App Instance's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle\#container-probes.

Returns:

the startupProbe value.

terminationGracePeriodSeconds

public Integer terminationGracePeriodSeconds()

Get the terminationGracePeriodSeconds property: Optional duration in seconds the App Instance needs to terminate gracefully. May be decreased in delete request. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). If this value is nil, the default grace period will be used instead. The grace period is the duration in seconds after the processes running in the App Instance are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. Defaults to 90 seconds.

Returns:

the terminationGracePeriodSeconds value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

validate

public void validate()

Validates the instance.

withAddonConfigs

public DeploymentSettings withAddonConfigs(Map> addonConfigs)

Set the addonConfigs property: Collection of addons.

Parameters:

addonConfigs - the addonConfigs value to set.

Returns:

the DeploymentSettings object itself.

withApms

public DeploymentSettings withApms(List apms)

Set the apms property: Collection of ApmReferences.

Parameters:

apms - the apms value to set.

Returns:

the DeploymentSettings object itself.

withContainerProbeSettings

public DeploymentSettings withContainerProbeSettings(ContainerProbeSettings containerProbeSettings)

Set the containerProbeSettings property: Container liveness and readiness probe settings.

Parameters:

containerProbeSettings - the containerProbeSettings value to set.

Returns:

the DeploymentSettings object itself.

withEnvironmentVariables

public DeploymentSettings withEnvironmentVariables(Map environmentVariables)

Set the environmentVariables property: Collection of environment variables.

Parameters:

environmentVariables - the environmentVariables value to set.

Returns:

the DeploymentSettings object itself.

withLivenessProbe

public DeploymentSettings withLivenessProbe(Probe livenessProbe)

Set the livenessProbe property: Periodic probe of App Instance liveness. App Instance will be restarted if the probe fails. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle\#container-probes.

Parameters:

livenessProbe - the livenessProbe value to set.

Returns:

the DeploymentSettings object itself.

withReadinessProbe

public DeploymentSettings withReadinessProbe(Probe readinessProbe)

Set the readinessProbe property: Periodic probe of App Instance service readiness. App Instance will be removed from service endpoints if the probe fails. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle\#container-probes.

Parameters:

readinessProbe - the readinessProbe value to set.

Returns:

the DeploymentSettings object itself.

withResourceRequests

public DeploymentSettings withResourceRequests(ResourceRequests resourceRequests)

Set the resourceRequests property: The requested resource quantity for required CPU and Memory. It is recommended that using this field to represent the required CPU and Memory, the old field cpu and memoryInGB will be deprecated later.

Parameters:

resourceRequests - the resourceRequests value to set.

Returns:

the DeploymentSettings object itself.

withStartupProbe

public DeploymentSettings withStartupProbe(Probe startupProbe)

Set the startupProbe property: StartupProbe indicates that the App Instance has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a App Instance's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle\#container-probes.

Parameters:

startupProbe - the startupProbe value to set.

Returns:

the DeploymentSettings object itself.

withTerminationGracePeriodSeconds

public DeploymentSettings withTerminationGracePeriodSeconds(Integer terminationGracePeriodSeconds)

Set the terminationGracePeriodSeconds property: Optional duration in seconds the App Instance needs to terminate gracefully. May be decreased in delete request. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). If this value is nil, the default grace period will be used instead. The grace period is the duration in seconds after the processes running in the App Instance are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. Defaults to 90 seconds.

Parameters:

terminationGracePeriodSeconds - the terminationGracePeriodSeconds value to set.

Returns:

the DeploymentSettings object itself.