com.amazonaws.services.proton.model

Class ListServiceInstancesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.proton.model.ListServiceInstancesRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ListServiceInstancesRequest
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
ListServiceInstancesRequest()

Method Summary

Modifier and Type	Method and Description
ListServiceInstancesRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
List<ListServiceInstancesFilter>	getFilters() An array of filtering criteria that scope down the result list.
Integer	getMaxResults() The maximum number of service instances to list.
String	getNextToken() A token that indicates the location of the next service in the array of service instances, after the list of service instances that was previously requested.
String	getServiceName() The name of the service that the service instance belongs to.
String	getSortBy() The field that the result list is sorted by.
String	getSortOrder() Result list sort order.
int	hashCode()
void	setFilters(Collection<ListServiceInstancesFilter> filters) An array of filtering criteria that scope down the result list.
void	setMaxResults(Integer maxResults) The maximum number of service instances to list.
void	setNextToken(String nextToken) A token that indicates the location of the next service in the array of service instances, after the list of service instances that was previously requested.
void	setServiceName(String serviceName) The name of the service that the service instance belongs to.
void	setSortBy(String sortBy) The field that the result list is sorted by.
void	setSortOrder(String sortOrder) Result list sort order.
String	toString() Returns a string representation of this object.
ListServiceInstancesRequest	withFilters(Collection<ListServiceInstancesFilter> filters) An array of filtering criteria that scope down the result list.
ListServiceInstancesRequest	withFilters(ListServiceInstancesFilter... filters) An array of filtering criteria that scope down the result list.
ListServiceInstancesRequest	withMaxResults(Integer maxResults) The maximum number of service instances to list.
ListServiceInstancesRequest	withNextToken(String nextToken) A token that indicates the location of the next service in the array of service instances, after the list of service instances that was previously requested.
ListServiceInstancesRequest	withServiceName(String serviceName) The name of the service that the service instance belongs to.
ListServiceInstancesRequest	withSortBy(ListServiceInstancesSortBy sortBy) The field that the result list is sorted by.
ListServiceInstancesRequest	withSortBy(String sortBy) The field that the result list is sorted by.
ListServiceInstancesRequest	withSortOrder(SortOrder sortOrder) Result list sort order.
ListServiceInstancesRequest	withSortOrder(String sortOrder) Result list sort order.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, 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

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListServiceInstancesRequest

public ListServiceInstancesRequest()

Method Detail

getFilters

public List<ListServiceInstancesFilter> getFilters()

An array of filtering criteria that scope down the result list. By default, all service instances in the Amazon Web Services account are returned.

Returns:

An array of filtering criteria that scope down the result list. By default, all service instances in the Amazon Web Services account are returned.

setFilters

public void setFilters(Collection<ListServiceInstancesFilter> filters)

An array of filtering criteria that scope down the result list. By default, all service instances in the Amazon Web Services account are returned.

Parameters:

filters - An array of filtering criteria that scope down the result list. By default, all service instances in the Amazon Web Services account are returned.

withFilters

public ListServiceInstancesRequest withFilters(ListServiceInstancesFilter... filters)

An array of filtering criteria that scope down the result list. By default, all service instances in the Amazon Web Services account are returned.

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

Parameters:

filters - An array of filtering criteria that scope down the result list. By default, all service instances in the Amazon Web Services account are returned.

Returns:

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

withFilters

public ListServiceInstancesRequest withFilters(Collection<ListServiceInstancesFilter> filters)

An array of filtering criteria that scope down the result list. By default, all service instances in the Amazon Web Services account are returned.

Parameters:

filters - An array of filtering criteria that scope down the result list. By default, all service instances in the Amazon Web Services account are returned.

Returns:

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

setMaxResults

public void setMaxResults(Integer maxResults)

The maximum number of service instances to list.

Parameters:

maxResults - The maximum number of service instances to list.

getMaxResults

public Integer getMaxResults()

The maximum number of service instances to list.

Returns:

The maximum number of service instances to list.

withMaxResults

public ListServiceInstancesRequest withMaxResults(Integer maxResults)

The maximum number of service instances to list.

Parameters:

maxResults - The maximum number of service instances to list.

Returns:

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

setNextToken

public void setNextToken(String nextToken)

A token that indicates the location of the next service in the array of service instances, after the list of service instances that was previously requested.

Parameters:

nextToken - A token that indicates the location of the next service in the array of service instances, after the list of service instances that was previously requested.

getNextToken

public String getNextToken()

A token that indicates the location of the next service in the array of service instances, after the list of service instances that was previously requested.

Returns:

A token that indicates the location of the next service in the array of service instances, after the list of service instances that was previously requested.

withNextToken

public ListServiceInstancesRequest withNextToken(String nextToken)

A token that indicates the location of the next service in the array of service instances, after the list of service instances that was previously requested.

Parameters:

nextToken - A token that indicates the location of the next service in the array of service instances, after the list of service instances that was previously requested.

Returns:

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

setServiceName

public void setServiceName(String serviceName)

The name of the service that the service instance belongs to.

Parameters:

serviceName - The name of the service that the service instance belongs to.

getServiceName

public String getServiceName()

The name of the service that the service instance belongs to.

Returns:

The name of the service that the service instance belongs to.

withServiceName

public ListServiceInstancesRequest withServiceName(String serviceName)

The name of the service that the service instance belongs to.

Parameters:

serviceName - The name of the service that the service instance belongs to.

Returns:

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

setSortBy

public void setSortBy(String sortBy)

The field that the result list is sorted by.

When you choose to sort by serviceName, service instances within each service are sorted by service instance name.

Default: serviceName

Parameters:

sortBy - The field that the result list is sorted by.

When you choose to sort by serviceName, service instances within each service are sorted by service instance name.

Default: serviceName

See Also:

ListServiceInstancesSortBy

getSortBy

public String getSortBy()

The field that the result list is sorted by.

When you choose to sort by serviceName, service instances within each service are sorted by service instance name.

Default: serviceName

Returns:

The field that the result list is sorted by.

When you choose to sort by serviceName, service instances within each service are sorted by service instance name.

Default: serviceName

See Also:

ListServiceInstancesSortBy

withSortBy

public ListServiceInstancesRequest withSortBy(String sortBy)

The field that the result list is sorted by.

When you choose to sort by serviceName, service instances within each service are sorted by service instance name.

Default: serviceName

Parameters:

sortBy - The field that the result list is sorted by.

When you choose to sort by serviceName, service instances within each service are sorted by service instance name.

Default: serviceName

Returns:

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

See Also:

ListServiceInstancesSortBy

withSortBy

public ListServiceInstancesRequest withSortBy(ListServiceInstancesSortBy sortBy)

The field that the result list is sorted by.

When you choose to sort by serviceName, service instances within each service are sorted by service instance name.

Default: serviceName

Parameters:

sortBy - The field that the result list is sorted by.

When you choose to sort by serviceName, service instances within each service are sorted by service instance name.

Default: serviceName

Returns:

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

See Also:

ListServiceInstancesSortBy

setSortOrder

public void setSortOrder(String sortOrder)

Result list sort order.

Default: ASCENDING

Parameters:

sortOrder - Result list sort order.

Default: ASCENDING

See Also:

SortOrder

getSortOrder

public String getSortOrder()

Result list sort order.

Default: ASCENDING

Returns:

Result list sort order.

Default: ASCENDING

See Also:

SortOrder

withSortOrder

public ListServiceInstancesRequest withSortOrder(String sortOrder)

Result list sort order.

Default: ASCENDING

Parameters:

sortOrder - Result list sort order.

Default: ASCENDING

Returns:

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

See Also:

SortOrder

withSortOrder

public ListServiceInstancesRequest withSortOrder(SortOrder sortOrder)

Result list sort order.

Default: ASCENDING

Parameters:

sortOrder - Result list sort order.

Default: ASCENDING

Returns:

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

See Also:

SortOrder

toString

public 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

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

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()