com.amazonaws.services.codedeploy.model

Class ListOnPremisesInstancesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.codedeploy.model.ListOnPremisesInstancesRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class ListOnPremisesInstancesRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the ListOnPremisesInstances operation.

Gets a list of one or more on-premises instance names.

Unless otherwise specified, both registered and deregistered on-premises instance names will be listed. To list only registered or deregistered on-premises instance names, use the registration status parameter.

See Also:

AmazonCodeDeploy.listOnPremisesInstances(ListOnPremisesInstancesRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ListOnPremisesInstancesRequest()

Method Summary

Methods

Modifier and Type	Method and Description
ListOnPremisesInstancesRequest	clone()
boolean	equals(Object obj)
String	getNextToken() An identifier that was returned from the previous list on-premises instances call, which can be used to return the next set of on-premises instances in the list.
String	getRegistrationStatus() The on-premises instances registration status: Deregistered: Include in the resulting list deregistered on-premises instances. Registered: Include in the resulting list registered on-premises instances.
List<TagFilter>	getTagFilters() The on-premises instance tags that will be used to restrict the corresponding on-premises instance names that are returned.
int	hashCode()
void	setNextToken(String nextToken) An identifier that was returned from the previous list on-premises instances call, which can be used to return the next set of on-premises instances in the list.
void	setRegistrationStatus(RegistrationStatus registrationStatus) The on-premises instances registration status: Deregistered: Include in the resulting list deregistered on-premises instances. Registered: Include in the resulting list registered on-premises instances.
void	setRegistrationStatus(String registrationStatus) The on-premises instances registration status: Deregistered: Include in the resulting list deregistered on-premises instances. Registered: Include in the resulting list registered on-premises instances.
void	setTagFilters(Collection<TagFilter> tagFilters) The on-premises instance tags that will be used to restrict the corresponding on-premises instance names that are returned.
String	toString() Returns a string representation of this object; useful for testing and debugging.
ListOnPremisesInstancesRequest	withNextToken(String nextToken) An identifier that was returned from the previous list on-premises instances call, which can be used to return the next set of on-premises instances in the list.
ListOnPremisesInstancesRequest	withRegistrationStatus(RegistrationStatus registrationStatus) The on-premises instances registration status: Deregistered: Include in the resulting list deregistered on-premises instances. Registered: Include in the resulting list registered on-premises instances.
ListOnPremisesInstancesRequest	withRegistrationStatus(String registrationStatus) The on-premises instances registration status: Deregistered: Include in the resulting list deregistered on-premises instances. Registered: Include in the resulting list registered on-premises instances.
ListOnPremisesInstancesRequest	withTagFilters(Collection<TagFilter> tagFilters) The on-premises instance tags that will be used to restrict the corresponding on-premises instance names that are returned.
ListOnPremisesInstancesRequest	withTagFilters(TagFilter... tagFilters) The on-premises instance tags that will be used to restrict the corresponding on-premises instance names that are returned.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, copyPrivateRequestParameters, 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

ListOnPremisesInstancesRequest

public ListOnPremisesInstancesRequest()

Method Detail

getRegistrationStatus

public String getRegistrationStatus()

The on-premises instances registration status:

• Deregistered: Include in the resulting list deregistered on-premises instances.
• Registered: Include in the resulting list registered on-premises instances.

Constraints:
Allowed Values: Registered, Deregistered

Returns:

The on-premises instances registration status:

• Deregistered: Include in the resulting list deregistered on-premises instances.
• Registered: Include in the resulting list registered on-premises instances.

See Also:

RegistrationStatus

setRegistrationStatus

public void setRegistrationStatus(String registrationStatus)

The on-premises instances registration status:

• Deregistered: Include in the resulting list deregistered on-premises instances.
• Registered: Include in the resulting list registered on-premises instances.

Constraints:
Allowed Values: Registered, Deregistered

Parameters:

registrationStatus - The on-premises instances registration status:

• Deregistered: Include in the resulting list deregistered on-premises instances.
• Registered: Include in the resulting list registered on-premises instances.

See Also:

RegistrationStatus

withRegistrationStatus

public ListOnPremisesInstancesRequest withRegistrationStatus(String registrationStatus)

The on-premises instances registration status:

• Deregistered: Include in the resulting list deregistered on-premises instances.
• Registered: Include in the resulting list registered on-premises instances.

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

Constraints:
Allowed Values: Registered, Deregistered

Parameters:

registrationStatus - The on-premises instances registration status:

• Deregistered: Include in the resulting list deregistered on-premises instances.
• Registered: Include in the resulting list registered on-premises instances.

Returns:

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

See Also:

RegistrationStatus

setRegistrationStatus

public void setRegistrationStatus(RegistrationStatus registrationStatus)

The on-premises instances registration status:

• Deregistered: Include in the resulting list deregistered on-premises instances.
• Registered: Include in the resulting list registered on-premises instances.

Constraints:
Allowed Values: Registered, Deregistered

Parameters:

registrationStatus - The on-premises instances registration status:

• Deregistered: Include in the resulting list deregistered on-premises instances.
• Registered: Include in the resulting list registered on-premises instances.

See Also:

RegistrationStatus

withRegistrationStatus

public ListOnPremisesInstancesRequest withRegistrationStatus(RegistrationStatus registrationStatus)

The on-premises instances registration status:

• Deregistered: Include in the resulting list deregistered on-premises instances.
• Registered: Include in the resulting list registered on-premises instances.

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

Constraints:
Allowed Values: Registered, Deregistered

Parameters:

registrationStatus - The on-premises instances registration status:

• Deregistered: Include in the resulting list deregistered on-premises instances.
• Registered: Include in the resulting list registered on-premises instances.

Returns:

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

See Also:

RegistrationStatus

getTagFilters

public List<TagFilter> getTagFilters()

The on-premises instance tags that will be used to restrict the corresponding on-premises instance names that are returned.

Returns:

The on-premises instance tags that will be used to restrict the corresponding on-premises instance names that are returned.

setTagFilters

public void setTagFilters(Collection<TagFilter> tagFilters)

The on-premises instance tags that will be used to restrict the corresponding on-premises instance names that are returned.

Parameters:

tagFilters - The on-premises instance tags that will be used to restrict the corresponding on-premises instance names that are returned.

withTagFilters

public ListOnPremisesInstancesRequest withTagFilters(TagFilter... tagFilters)

The on-premises instance tags that will be used to restrict the corresponding on-premises instance names that are returned.

NOTE: This method appends the values to the existing list (if any). Use setTagFilters(java.util.Collection) or withTagFilters(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.

Parameters:

tagFilters - The on-premises instance tags that will be used to restrict the corresponding on-premises instance names that are returned.

Returns:

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

withTagFilters

public ListOnPremisesInstancesRequest withTagFilters(Collection<TagFilter> tagFilters)

The on-premises instance tags that will be used to restrict the corresponding on-premises instance names that are returned.

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

Parameters:

tagFilters - The on-premises instance tags that will be used to restrict the corresponding on-premises instance names that are returned.

Returns:

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

getNextToken

public String getNextToken()

An identifier that was returned from the previous list on-premises instances call, which can be used to return the next set of on-premises instances in the list.

Returns:

An identifier that was returned from the previous list on-premises instances call, which can be used to return the next set of on-premises instances in the list.

setNextToken

public void setNextToken(String nextToken)

An identifier that was returned from the previous list on-premises instances call, which can be used to return the next set of on-premises instances in the list.

Parameters:

nextToken - An identifier that was returned from the previous list on-premises instances call, which can be used to return the next set of on-premises instances in the list.

withNextToken

public ListOnPremisesInstancesRequest withNextToken(String nextToken)

An identifier that was returned from the previous list on-premises instances call, which can be used to return the next set of on-premises instances in the list.

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

Parameters:

nextToken - An identifier that was returned from the previous list on-premises instances call, which can be used to return the next set of on-premises instances in the list.

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 ListOnPremisesInstancesRequest clone()

Overrides:

clone in class AmazonWebServiceRequest