Record Class GetSecretValueOptions

java.lang.Object
java.lang.Record
codes.grow.packages.awssecretsmanager.GetSecretValueOptions
Record Components:
versionId - Version id (VersionId).
versionStage - Stage label, e.g. AWSCURRENT, AWSPREVIOUS or a custom label.

public record GetSecretValueOptions(String versionId, String versionStage) extends Record
Options of getSecretValue and getJsonField: selects a version by id or by stage label (default AWSCURRENT).

Every component is optional: null means "not set" (the AWS default applies).

  • Constructor Details

    • GetSecretValueOptions

      public GetSecretValueOptions(String versionId, String versionStage)
      Creates an instance of a GetSecretValueOptions record class.
      Parameters:
      versionId - the value for the versionId record component
      versionStage - the value for the versionStage record component
  • Method Details

    • none

      public static GetSecretValueOptions none()
      Returns options with every field unset.
      Returns:
      empty options
    • builder

      public static GetSecretValueOptions.Builder builder()
      Starts a builder.
      Returns:
      a new builder
    • toBuilder

      public GetSecretValueOptions.Builder toBuilder()
      Returns a builder pre-filled with these options.
      Returns:
      a new builder
    • ofVersionId

      public static GetSecretValueOptions ofVersionId(String versionId)
      Selects a version by id.
      Parameters:
      versionId - the version id
      Returns:
      the options
    • ofVersionStage

      public static GetSecretValueOptions ofVersionStage(String versionStage)
      Selects a version by stage label.
      Parameters:
      versionStage - the stage label
      Returns:
      the options
    • 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.
    • versionId

      public String versionId()
      Returns the value of the versionId record component.
      Returns:
      the value of the versionId record component
    • versionStage

      public String versionStage()
      Returns the value of the versionStage record component.
      Returns:
      the value of the versionStage record component