com.amazonaws.services.workspaces.model

Class TerminateWorkspacesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.workspaces.model.TerminateWorkspacesRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class TerminateWorkspacesRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the TerminateWorkspaces operation.

Terminates the specified WorkSpaces.

Terminating a WorkSpace is a permanent action and cannot be undone. The user's data is not maintained and will be destroyed. If you need to archive any user data, contact Amazon Web Services before terminating the WorkSpace.

You can terminate a WorkSpace that is in any state except SUSPENDED .

NOTE: This operation is asynchronous and will return before the WorkSpaces have been completely terminated.

See Also:

AmazonWorkspaces.terminateWorkspaces(TerminateWorkspacesRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
TerminateWorkspacesRequest()

Method Summary

Methods

Modifier and Type	Method and Description
TerminateWorkspacesRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
List<TerminateRequest>	getTerminateWorkspaceRequests() An array of structures that specify the WorkSpaces to terminate.
int	hashCode()
void	setTerminateWorkspaceRequests(Collection<TerminateRequest> terminateWorkspaceRequests) An array of structures that specify the WorkSpaces to terminate.
String	toString() Returns a string representation of this object; useful for testing and debugging.
TerminateWorkspacesRequest	withTerminateWorkspaceRequests(Collection<TerminateRequest> terminateWorkspaceRequests) An array of structures that specify the WorkSpaces to terminate.
TerminateWorkspacesRequest	withTerminateWorkspaceRequests(TerminateRequest... terminateWorkspaceRequests) An array of structures that specify the WorkSpaces to terminate.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

TerminateWorkspacesRequest

public TerminateWorkspacesRequest()

Method Detail

getTerminateWorkspaceRequests

public List<TerminateRequest> getTerminateWorkspaceRequests()

An array of structures that specify the WorkSpaces to terminate.

Constraints:
Length: 1 - 25

Returns:

An array of structures that specify the WorkSpaces to terminate.

setTerminateWorkspaceRequests

public void setTerminateWorkspaceRequests(Collection<TerminateRequest> terminateWorkspaceRequests)

An array of structures that specify the WorkSpaces to terminate.

Constraints:
Length: 1 - 25

Parameters:

terminateWorkspaceRequests - An array of structures that specify the WorkSpaces to terminate.

withTerminateWorkspaceRequests

public TerminateWorkspacesRequest withTerminateWorkspaceRequests(TerminateRequest... terminateWorkspaceRequests)

An array of structures that specify the WorkSpaces to terminate.

NOTE: This method appends the values to the existing list (if any). Use setTerminateWorkspaceRequests(java.util.Collection) or withTerminateWorkspaceRequests(java.util.Collection) if you want to override the existing values.

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

Constraints:
Length: 1 - 25

Parameters:

terminateWorkspaceRequests - An array of structures that specify the WorkSpaces to terminate.

Returns:

A reference to this updated object so that method calls can be chained together.

withTerminateWorkspaceRequests

public TerminateWorkspacesRequest withTerminateWorkspaceRequests(Collection<TerminateRequest> terminateWorkspaceRequests)

An array of structures that specify the WorkSpaces to terminate.

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

Constraints:
Length: 1 - 25

Parameters:

terminateWorkspaceRequests - An array of structures that specify the WorkSpaces to terminate.

Returns:

A reference to this updated 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()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public TerminateWorkspacesRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()