Class UpdateSecretVersionStageRequest

All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdateSecretVersionStageRequest.Builder,UpdateSecretVersionStageRequest>

@Generated("software.amazon.awssdk:codegen") public final class UpdateSecretVersionStageRequest extends SecretsManagerRequest implements ToCopyableBuilder<UpdateSecretVersionStageRequest.Builder,UpdateSecretVersionStageRequest>
  • Method Details

    • secretId

      public final String secretId()

      The ARN or the name of the secret with the version and staging labelsto modify.

      For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.

      Returns:
      The ARN or the name of the secret with the version and staging labelsto modify.

      For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.

    • versionStage

      public final String versionStage()

      The staging label to add to this version.

      Returns:
      The staging label to add to this version.
    • removeFromVersionId

      public final String removeFromVersionId()

      The ID of the version that the staging label is to be removed from. If the staging label you are trying to attach to one version is already attached to a different version, then you must include this parameter and specify the version that the label is to be removed from. If the label is attached and you either do not specify this parameter, or the version ID does not match, then the operation fails.

      Returns:
      The ID of the version that the staging label is to be removed from. If the staging label you are trying to attach to one version is already attached to a different version, then you must include this parameter and specify the version that the label is to be removed from. If the label is attached and you either do not specify this parameter, or the version ID does not match, then the operation fails.
    • moveToVersionId

      public final String moveToVersionId()

      The ID of the version to add the staging label to. To remove a label from a version, then do not specify this parameter.

      If the staging label is already attached to a different version of the secret, then you must also specify the RemoveFromVersionId parameter.

      Returns:
      The ID of the version to add the staging label to. To remove a label from a version, then do not specify this parameter.

      If the staging label is already attached to a different version of the secret, then you must also specify the RemoveFromVersionId parameter.

    • toBuilder

      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<UpdateSecretVersionStageRequest.Builder,UpdateSecretVersionStageRequest>
      Specified by:
      toBuilder in class SecretsManagerRequest
      Returns:
      a builder for type T
    • builder

      public static UpdateSecretVersionStageRequest.Builder builder()
    • serializableBuilderClass

      public static Class<? extends UpdateSecretVersionStageRequest.Builder> serializableBuilderClass()
    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest
    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest
    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.
    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object
    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value
    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.