software.amazon.awssdk.services.secretsmanager.model

Class UpdateSecretVersionStageRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.secretsmanager.model.SecretsManagerRequest

software.amazon.awssdk.services.secretsmanager.model.UpdateSecretVersionStageRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateSecretVersionStageRequest.Builder,UpdateSecretVersionStageRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpdateSecretVersionStageRequest.Builder

Method Summary

Modifier and Type	Method and Description
static UpdateSecretVersionStageRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	moveToVersionId() The ID of the version to add the staging label to.
String	removeFromVersionId() The ID of the version that the staging label is to be removed from.
List<SdkField<?>>	sdkFields()
String	secretId() The ARN or the name of the secret with the version and staging labelsto modify.
static Class<? extends UpdateSecretVersionStageRequest.Builder>	serializableBuilderClass()
UpdateSecretVersionStageRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	versionStage() The staging label to add to this version.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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

public UpdateSecretVersionStageRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateSecretVersionStageRequest.Builder,UpdateSecretVersionStageRequest>

Specified by:

toBuilder in class SecretsManagerRequest

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo