Record Class PlanStep

java.lang.Object

java.lang.Record

com.eqixiac.equinix.design.plan.PlanStep

Record Components:

key - the stable logical key

kind - the element kind

name - the planned resource name

dependsOn - keys of the steps that must exist first

notExecutableReason - why the SDK will not create the element, or null when it will

public record PlanStep(String key, ResourceKind kind, String name, List<String> dependsOn, String notExecutableReason)
extends Record

One element of a plan in its uniform, dependency-ordered form: what PlanSteps.of(DeploymentPlan) derives from a DeploymentPlan for execution, reconcile, drift detection and checkpoints.

Constructor Summary

Constructors

Constructor	Description
PlanStep(String key, ResourceKind kind, String name, List<String> dependsOn, String notExecutableReason)	Makes dependsOn immutable and non-null.

Method Summary

Modifier and Type	Method	Description
List<String>	dependsOn()	Returns the value of the dependsOn record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
boolean	executable()	Whether the SDK creates this element.
final int	hashCode()	Returns a hash code value for this object.
String	key()	Returns the value of the key record component.
ResourceKind	kind()	Returns the value of the kind record component.
String	name()	Returns the value of the name record component.
String	notExecutableReason()	Returns the value of the notExecutableReason record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Constructor Details

PlanStep

public PlanStep(String key,
 ResourceKind kind,
 String name,
 List<String> dependsOn,
 String notExecutableReason)

Makes dependsOn immutable and non-null.

Method Details

executable

public boolean executable()

Whether the SDK creates this element.

Returns:

true when there is no not-executable reason

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

key

public String key()

Returns the value of the key record component.

Returns:

the value of the key record component

kind

public ResourceKind kind()

Returns the value of the kind record component.

Returns:

the value of the kind record component

name

public String name()

Returns the value of the name record component.

Returns:

the value of the name record component

dependsOn

public List<String> dependsOn()

Returns the value of the dependsOn record component.

Returns:

the value of the dependsOn record component

notExecutableReason

public String notExecutableReason()

Returns the value of the notExecutableReason record component.

Returns:

the value of the notExecutableReason record component