Record Class DeployOptions

java.lang.Object
java.lang.Record
com.cloudforgeci.api.deploy.DeployOptions
public record DeployOptions(boolean replaceSameApplication, boolean persistCatalog, Path catalogDirectory, List<String> managerVolumeRoots, software.amazon.awssdk.auth.credentials.AwsCredentialsProvider credentialsOverride) extends Record
Optional post-deploy behavior for CloudForgeDeployment.

  • Constructor Summary

    Constructors
    Constructor
    Description
    DeployOptions(boolean replaceSameApplication, boolean persistCatalog, Path catalogDirectory, List<String> managerVolumeRoots, software.amazon.awssdk.auth.credentials.AwsCredentialsProvider credentialsOverride)
    Creates an instance of a DeployOptions record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    Path
    catalogDirectory()
    Returns the value of the catalogDirectory record component.
    software.amazon.awssdk.auth.credentials.AwsCredentialsProvider
    credentialsOverride()
    Returns the value of the credentialsOverride record component.
    static DeployOptions
    defaults()
     
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    List<String>
    managerVolumeRoots()
    Returns the value of the managerVolumeRoots record component.
    boolean
    persistCatalog()
    Returns the value of the persistCatalog record component.
    boolean
    replaceSameApplication()
    Returns the value of the replaceSameApplication record component.
    final String
    toString()
    Returns a string representation of this record class.
    DeployOptions
    withCredentialsOverride(software.amazon.awssdk.auth.credentials.AwsCredentialsProvider credentialsOverride)
    Credentials to use instead of the default chain for real-AWS calls — any caller needing to act as a different principal (e.g.
    DeployOptions
    withoutCatalog()
     

    Methods inherited from class Object

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

  • Constructor Details

    • DeployOptions

      public DeployOptions(boolean replaceSameApplication, boolean persistCatalog, Path catalogDirectory, List<String> managerVolumeRoots, software.amazon.awssdk.auth.credentials.AwsCredentialsProvider credentialsOverride)
      Creates an instance of a DeployOptions record class.
      Parameters:
      replaceSameApplication - the value for the replaceSameApplication record component
      persistCatalog - the value for the persistCatalog record component
      catalogDirectory - the value for the catalogDirectory record component
      managerVolumeRoots - the value for the managerVolumeRoots record component
      credentialsOverride - the value for the credentialsOverride record component

  • Method Details

    • defaults

      public static DeployOptions defaults()

    • withoutCatalog

      public DeployOptions withoutCatalog()

    • withCredentialsOverride

      public DeployOptions withCredentialsOverride(software.amazon.awssdk.auth.credentials.AwsCredentialsProvider credentialsOverride)
      Credentials to use instead of the default chain for real-AWS calls — any caller needing to act as a different principal (e.g. an assumed cross-account role) can supply one. Ignored for local-emulator targets (LocalStack/MiniStack always use their fixed test credentials — see AwsDirectDeployer.resolveLocalEmulatorEndpoint()).

    • 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.
      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.

    • replaceSameApplication

      public boolean replaceSameApplication()
      Returns the value of the replaceSameApplication record component.
      Returns:
      the value of the replaceSameApplication record component

    • persistCatalog

      public boolean persistCatalog()
      Returns the value of the persistCatalog record component.
      Returns:
      the value of the persistCatalog record component

    • catalogDirectory

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

    • managerVolumeRoots

      public List<String> managerVolumeRoots()
      Returns the value of the managerVolumeRoots record component.
      Returns:
      the value of the managerVolumeRoots record component

    • credentialsOverride

      public software.amazon.awssdk.auth.credentials.AwsCredentialsProvider credentialsOverride()
      Returns the value of the credentialsOverride record component.
      Returns:
      the value of the credentialsOverride record component