Package com.oracle.bmc.devops.model

Class OkeHelmChartDeployStage

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.devops.model.DeployStage

com.oracle.bmc.devops.model.OkeHelmChartDeployStage

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20210630")
public final class OkeHelmChartDeployStage
extends DeployStage

Specifies the OKE cluster deployment stage using helm charts.
Note: Objects should always be created or deserialized using the OkeHelmChartDeployStage.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the OkeHelmChartDeployStage.Builder, which maintain a set of all explicitly set fields called OkeHelmChartDeployStage.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OkeHelmChartDeployStage.Builder
static class	OkeHelmChartDeployStage.Purpose	The purpose of running this Helm stage

Nested classes/interfaces inherited from class com.oracle.bmc.devops.model.DeployStage

DeployStage.DeployStageType, DeployStage.LifecycleState

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor

Description

OkeHelmChartDeployStage(String id, String description, String displayName, String projectId, String deployPipelineId, String compartmentId, Date timeCreated, Date timeUpdated, DeployStage.LifecycleState lifecycleState, String lifecycleDetails, DeployStagePredecessorCollection deployStagePredecessorCollection, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, Map<String,Map<String,Object>> systemTags, String okeClusterDeployEnvironmentId, String helmChartDeployArtifactId, List<String> valuesArtifactIds, String releaseName, Boolean isUninstallOnStageDelete, List<String> helmCommandArtifactIds, OkeHelmChartDeployStage.Purpose purpose, String namespace, Integer timeoutInSeconds, DeployStageRollbackPolicy rollbackPolicy, HelmSetValueCollection setValues, HelmSetValueCollection setString, Boolean areHooksEnabled, Boolean shouldReuseValues, Boolean shouldResetValues, Boolean isForceEnabled, Boolean shouldCleanupOnFail, Integer maxHistory, Boolean shouldSkipCrds, Boolean shouldSkipRenderSubchartNotes, Boolean shouldNotWait, Boolean isDebugEnabled)

Deprecated.

Method Summary

Modifier and Type	Method	Description
static OkeHelmChartDeployStage.Builder	builder()	Create a new builder.
boolean	equals(Object o)
Boolean	getAreHooksEnabled()	Disable pre/post upgrade hooks.
String	getHelmChartDeployArtifactId()	Helm chart artifact OCID.
List<String>	getHelmCommandArtifactIds()	List of Helm command artifact OCIDs.
Boolean	getIsDebugEnabled()	Enables helm –debug option to stream output to tf stdout.
Boolean	getIsForceEnabled()	Force resource update through delete; or if required, recreate.
Boolean	getIsUninstallOnStageDelete()	Uninstall the Helm chart release on deleting the stage.
Integer	getMaxHistory()	Limit the maximum number of revisions saved per release.
String	getNamespace()	Default namespace to be used for Kubernetes deployment when not specified in the manifest.
String	getOkeClusterDeployEnvironmentId()	Kubernetes cluster environment OCID for deployment.
OkeHelmChartDeployStage.Purpose	getPurpose()	The purpose of running this Helm stage
String	getReleaseName()	Release name of the Helm chart.
DeployStageRollbackPolicy	getRollbackPolicy()
HelmSetValueCollection	getSetString()
HelmSetValueCollection	getSetValues()
Boolean	getShouldCleanupOnFail()	Allow deletion of new resources created during when an upgrade fails.
Boolean	getShouldNotWait()	Waits until all the resources are in a ready state to mark the release as successful.
Boolean	getShouldResetValues()	During upgrade, reset the values to the ones built into the chart.
Boolean	getShouldReuseValues()	During upgrade, reuse the values of the last release and merge overrides from the command line.
Boolean	getShouldSkipCrds()	If set, no CRDs are installed.
Boolean	getShouldSkipRenderSubchartNotes()	If set, renders subchart notes along with the parent.
Integer	getTimeoutInSeconds()	Time to wait for execution of a helm stage.
List<String>	getValuesArtifactIds()	List of values.yaml file artifact OCIDs.
int	hashCode()
OkeHelmChartDeployStage.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.devops.model.DeployStage

getCompartmentId, getDefinedTags, getDeployPipelineId, getDeployStagePredecessorCollection, getDescription, getDisplayName, getFreeformTags, getId, getLifecycleDetails, getLifecycleState, getProjectId, getSystemTags, getTimeCreated, getTimeUpdated

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

OkeHelmChartDeployStage

@Deprecated
public OkeHelmChartDeployStage(String id,
                               String description,
                               String displayName,
                               String projectId,
                               String deployPipelineId,
                               String compartmentId,
                               Date timeCreated,
                               Date timeUpdated,
                               DeployStage.LifecycleState lifecycleState,
                               String lifecycleDetails,
                               DeployStagePredecessorCollection deployStagePredecessorCollection,
                               Map<String,String> freeformTags,
                               Map<String,Map<String,Object>> definedTags,
                               Map<String,Map<String,Object>> systemTags,
                               String okeClusterDeployEnvironmentId,
                               String helmChartDeployArtifactId,
                               List<String> valuesArtifactIds,
                               String releaseName,
                               Boolean isUninstallOnStageDelete,
                               List<String> helmCommandArtifactIds,
                               OkeHelmChartDeployStage.Purpose purpose,
                               String namespace,
                               Integer timeoutInSeconds,
                               DeployStageRollbackPolicy rollbackPolicy,
                               HelmSetValueCollection setValues,
                               HelmSetValueCollection setString,
                               Boolean areHooksEnabled,
                               Boolean shouldReuseValues,
                               Boolean shouldResetValues,
                               Boolean isForceEnabled,
                               Boolean shouldCleanupOnFail,
                               Integer maxHistory,
                               Boolean shouldSkipCrds,
                               Boolean shouldSkipRenderSubchartNotes,
                               Boolean shouldNotWait,
                               Boolean isDebugEnabled)

Deprecated.

Method Detail

builder

public static OkeHelmChartDeployStage.Builder builder()

Create a new builder.

toBuilder

public OkeHelmChartDeployStage.Builder toBuilder()

getOkeClusterDeployEnvironmentId

public String getOkeClusterDeployEnvironmentId()

Kubernetes cluster environment OCID for deployment.

Returns:

the value

getHelmChartDeployArtifactId

public String getHelmChartDeployArtifactId()

Helm chart artifact OCID.

Returns:

the value

getValuesArtifactIds

public List<String> getValuesArtifactIds()

List of values.yaml file artifact OCIDs.

Returns:

the value

getReleaseName

public String getReleaseName()

Release name of the Helm chart.

Returns:

the value

getIsUninstallOnStageDelete

public Boolean getIsUninstallOnStageDelete()

Uninstall the Helm chart release on deleting the stage.

Returns:

the value

getHelmCommandArtifactIds

public List<String> getHelmCommandArtifactIds()

List of Helm command artifact OCIDs.

Returns:

the value

getPurpose

public OkeHelmChartDeployStage.Purpose getPurpose()

The purpose of running this Helm stage

Returns:

the value

getNamespace

public String getNamespace()

Default namespace to be used for Kubernetes deployment when not specified in the manifest.

Returns:

the value

getTimeoutInSeconds

public Integer getTimeoutInSeconds()

Time to wait for execution of a helm stage.

Defaults to 300 seconds.

Returns:

the value

getRollbackPolicy

public DeployStageRollbackPolicy getRollbackPolicy()

getSetValues

public HelmSetValueCollection getSetValues()

getSetString

public HelmSetValueCollection getSetString()

getAreHooksEnabled

public Boolean getAreHooksEnabled()

Disable pre/post upgrade hooks.

Set to false by default.

Returns:

the value

getShouldReuseValues

public Boolean getShouldReuseValues()

During upgrade, reuse the values of the last release and merge overrides from the command line.

Set to false by default.

Returns:

the value

getShouldResetValues

public Boolean getShouldResetValues()

During upgrade, reset the values to the ones built into the chart.

It overrides shouldReuseValues. Set to false by default.

Returns:

the value

getIsForceEnabled

public Boolean getIsForceEnabled()

Force resource update through delete; or if required, recreate.

Set to false by default.

Returns:

the value

getShouldCleanupOnFail

public Boolean getShouldCleanupOnFail()

Allow deletion of new resources created during when an upgrade fails.

Set to false by default.

Returns:

the value

getMaxHistory

public Integer getMaxHistory()

Limit the maximum number of revisions saved per release.

Use 0 for no limit. Set to 10 by default

Returns:

the value

getShouldSkipCrds

public Boolean getShouldSkipCrds()

If set, no CRDs are installed.

By default, CRDs are installed only if they are not present already. Set to false by default.

Returns:

the value

getShouldSkipRenderSubchartNotes

public Boolean getShouldSkipRenderSubchartNotes()

If set, renders subchart notes along with the parent.

Set to false by default.

Returns:

the value

getShouldNotWait

public Boolean getShouldNotWait()

Waits until all the resources are in a ready state to mark the release as successful.

Set to false by default.

Returns:

the value

getIsDebugEnabled

public Boolean getIsDebugEnabled()

Enables helm –debug option to stream output to tf stdout.

Set to false by default.

Returns:

the value

toString

public String toString()

Overrides:

toString in class DeployStage

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Overrides:

toString in class DeployStage

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class DeployStage

hashCode

public int hashCode()

Overrides:

hashCode in class DeployStage