com.amazonaws.services.secretsmanager.model

Class UpdateSecretVersionStageRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.secretsmanager.model.UpdateSecretVersionStageRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UpdateSecretVersionStageRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
UpdateSecretVersionStageRequest()

Method Summary

Modifier and Type	Method and Description
UpdateSecretVersionStageRequest	clone()
boolean	equals(Object obj)
String	getMoveToVersionId() (Optional) The secret version ID that you want to add the staging labels to.
String	getRemoveFromVersionId() (Optional) Specifies the secret version ID of the version that the staging labels are to be removed from.
String	getSecretId() Specifies the secret with the version whose list of staging labels you want to modify.
String	getVersionStage() The list of staging labels to add to this version.
int	hashCode()
void	setMoveToVersionId(String moveToVersionId) (Optional) The secret version ID that you want to add the staging labels to.
void	setRemoveFromVersionId(String removeFromVersionId) (Optional) Specifies the secret version ID of the version that the staging labels are to be removed from.
void	setSecretId(String secretId) Specifies the secret with the version whose list of staging labels you want to modify.
void	setVersionStage(String versionStage) The list of staging labels to add to this version.
String	toString() Returns a string representation of this object; useful for testing and debugging.
UpdateSecretVersionStageRequest	withMoveToVersionId(String moveToVersionId) (Optional) The secret version ID that you want to add the staging labels to.
UpdateSecretVersionStageRequest	withRemoveFromVersionId(String removeFromVersionId) (Optional) Specifies the secret version ID of the version that the staging labels are to be removed from.
UpdateSecretVersionStageRequest	withSecretId(String secretId) Specifies the secret with the version whose list of staging labels you want to modify.
UpdateSecretVersionStageRequest	withVersionStage(String versionStage) The list of staging labels to add to this version.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

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

Constructor Detail

UpdateSecretVersionStageRequest

public UpdateSecretVersionStageRequest()

Method Detail

setSecretId

public void setSecretId(String secretId)

Specifies the secret with the version whose list of staging labels you want to modify. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

Parameters:

secretId - Specifies the secret with the version whose list of staging labels you want to modify. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

getSecretId

public String getSecretId()

Specifies the secret with the version whose list of staging labels you want to modify. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

Returns:

Specifies the secret with the version whose list of staging labels you want to modify. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

withSecretId

public UpdateSecretVersionStageRequest withSecretId(String secretId)

Specifies the secret with the version whose list of staging labels you want to modify. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

Parameters:

secretId - Specifies the secret with the version whose list of staging labels you want to modify. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

Returns:

Returns a reference to this object so that method calls can be chained together.

setVersionStage

public void setVersionStage(String versionStage)

The list of staging labels to add to this version.

Parameters:

versionStage - The list of staging labels to add to this version.

getVersionStage

public String getVersionStage()

The list of staging labels to add to this version.

Returns:

The list of staging labels to add to this version.

withVersionStage

public UpdateSecretVersionStageRequest withVersionStage(String versionStage)

The list of staging labels to add to this version.

Parameters:

versionStage - The list of staging labels to add to this version.

Returns:

Returns a reference to this object so that method calls can be chained together.

setRemoveFromVersionId

public void setRemoveFromVersionId(String removeFromVersionId)

(Optional) Specifies the secret version ID of the version that the staging labels are to be removed from.

If you want to move a label to a new version, you do not have to explicitly remove it with this parameter. Adding a label using the MoveToVersionId parameter automatically removes it from the old version. However, if you do include both the "MoveTo" and "RemoveFrom" parameters, then the move is successful only if the staging labels are actually present on the "RemoveFrom" version. If a staging label was on a different version than "RemoveFrom", then the request fails.

Parameters:

removeFromVersionId - (Optional) Specifies the secret version ID of the version that the staging labels are to be removed from.

If you want to move a label to a new version, you do not have to explicitly remove it with this parameter. Adding a label using the MoveToVersionId parameter automatically removes it from the old version. However, if you do include both the "MoveTo" and "RemoveFrom" parameters, then the move is successful only if the staging labels are actually present on the "RemoveFrom" version. If a staging label was on a different version than "RemoveFrom", then the request fails.

getRemoveFromVersionId

public String getRemoveFromVersionId()

(Optional) Specifies the secret version ID of the version that the staging labels are to be removed from.

If you want to move a label to a new version, you do not have to explicitly remove it with this parameter. Adding a label using the MoveToVersionId parameter automatically removes it from the old version. However, if you do include both the "MoveTo" and "RemoveFrom" parameters, then the move is successful only if the staging labels are actually present on the "RemoveFrom" version. If a staging label was on a different version than "RemoveFrom", then the request fails.

Returns:

(Optional) Specifies the secret version ID of the version that the staging labels are to be removed from.

If you want to move a label to a new version, you do not have to explicitly remove it with this parameter. Adding a label using the MoveToVersionId parameter automatically removes it from the old version. However, if you do include both the "MoveTo" and "RemoveFrom" parameters, then the move is successful only if the staging labels are actually present on the "RemoveFrom" version. If a staging label was on a different version than "RemoveFrom", then the request fails.

withRemoveFromVersionId

public UpdateSecretVersionStageRequest withRemoveFromVersionId(String removeFromVersionId)

(Optional) Specifies the secret version ID of the version that the staging labels are to be removed from.

If you want to move a label to a new version, you do not have to explicitly remove it with this parameter. Adding a label using the MoveToVersionId parameter automatically removes it from the old version. However, if you do include both the "MoveTo" and "RemoveFrom" parameters, then the move is successful only if the staging labels are actually present on the "RemoveFrom" version. If a staging label was on a different version than "RemoveFrom", then the request fails.

Parameters:

removeFromVersionId - (Optional) Specifies the secret version ID of the version that the staging labels are to be removed from.

If you want to move a label to a new version, you do not have to explicitly remove it with this parameter. Adding a label using the MoveToVersionId parameter automatically removes it from the old version. However, if you do include both the "MoveTo" and "RemoveFrom" parameters, then the move is successful only if the staging labels are actually present on the "RemoveFrom" version. If a staging label was on a different version than "RemoveFrom", then the request fails.

Returns:

Returns a reference to this object so that method calls can be chained together.

setMoveToVersionId

public void setMoveToVersionId(String moveToVersionId)

(Optional) The secret version ID that you want to add the staging labels to.

If any of the staging labels are already attached to a different version of the secret, then they are removed from that version before adding them to this version.

Parameters:

moveToVersionId - (Optional) The secret version ID that you want to add the staging labels to.

If any of the staging labels are already attached to a different version of the secret, then they are removed from that version before adding them to this version.

getMoveToVersionId

public String getMoveToVersionId()

(Optional) The secret version ID that you want to add the staging labels to.

If any of the staging labels are already attached to a different version of the secret, then they are removed from that version before adding them to this version.

Returns:

(Optional) The secret version ID that you want to add the staging labels to.

If any of the staging labels are already attached to a different version of the secret, then they are removed from that version before adding them to this version.

withMoveToVersionId

public UpdateSecretVersionStageRequest withMoveToVersionId(String moveToVersionId)

(Optional) The secret version ID that you want to add the staging labels to.

If any of the staging labels are already attached to a different version of the secret, then they are removed from that version before adding them to this version.

Parameters:

moveToVersionId - (Optional) The secret version ID that you want to add the staging labels to.

If any of the staging labels are already attached to a different version of the secret, then they are removed from that version before adding them to this version.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public UpdateSecretVersionStageRequest clone()

Overrides:

clone in class AmazonWebServiceRequest