Record Class DeploymentRequest

java.lang.Object
java.lang.Record
com.cloudforgeci.api.deploy.DeploymentRequest
public record DeploymentRequest(DeploymentConfig config, DeploymentTarget target, DeployMode mode, Path canonicalTemplate, Path outputDirectory, DeployOptions options) extends Record
Inputs for CloudForgeDeployment.

  • Constructor Details

    • DeploymentRequest

      public DeploymentRequest(DeploymentConfig config, DeploymentTarget target, DeployMode mode, Path canonicalTemplate, Path outputDirectory, DeployOptions options)
      Creates an instance of a DeploymentRequest record class.
      Parameters:
      config - the value for the config record component
      target - the value for the target record component
      mode - the value for the mode record component
      canonicalTemplate - the value for the canonicalTemplate record component
      outputDirectory - the value for the outputDirectory record component
      options - the value for the options record component

  • Method Details

    • deploy

      public static DeploymentRequest deploy(DeploymentConfig config, DeploymentTarget target, Path canonicalTemplate, Path outputDirectory)

    • dryRun

      public static DeploymentRequest dryRun(DeploymentConfig config, DeploymentTarget target, Path canonicalTemplate, Path outputDirectory)

    • verify

      public static DeploymentRequest verify(DeploymentConfig config, DeploymentTarget target)

    • 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.

    • config

      public DeploymentConfig config()
      Returns the value of the config record component.
      Returns:
      the value of the config record component

    • target

      public DeploymentTarget target()
      Returns the value of the target record component.
      Returns:
      the value of the target record component

    • mode

      public DeployMode mode()
      Returns the value of the mode record component.
      Returns:
      the value of the mode record component

    • canonicalTemplate

      public Path canonicalTemplate()
      Returns the value of the canonicalTemplate record component.
      Returns:
      the value of the canonicalTemplate record component

    • outputDirectory

      public Path outputDirectory()
      Returns the value of the outputDirectory record component.
      Returns:
      the value of the outputDirectory record component

    • options

      public DeployOptions options()
      Returns the value of the options record component.
      Returns:
      the value of the options record component