com.amazonaws.services.resourcegroups.model

Class ListGroupsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.resourcegroups.model.ListGroupsRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

Method Summary

Modifier and Type	Method and Description
ListGroupsRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
List<GroupFilter>	getFilters() Filters, formatted as GroupFilter objects, that you want to apply to a ListGroups operation.
Integer	getMaxResults() The total number of results that you want included on each page of the response.
String	getNextToken() The parameter for receiving additional results if you receive a NextToken response in a previous request.
int	hashCode()
void	setFilters(Collection<GroupFilter> filters) Filters, formatted as GroupFilter objects, that you want to apply to a ListGroups operation.
void	setMaxResults(Integer maxResults) The total number of results that you want included on each page of the response.
void	setNextToken(String nextToken) The parameter for receiving additional results if you receive a NextToken response in a previous request.
String	toString() Returns a string representation of this object.
ListGroupsRequest	withFilters(Collection<GroupFilter> filters) Filters, formatted as GroupFilter objects, that you want to apply to a ListGroups operation.
ListGroupsRequest	withFilters(GroupFilter... filters) Filters, formatted as GroupFilter objects, that you want to apply to a ListGroups operation.
ListGroupsRequest	withMaxResults(Integer maxResults) The total number of results that you want included on each page of the response.
ListGroupsRequest	withNextToken(String nextToken) The parameter for receiving additional results if you receive a NextToken response in a previous request.

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

ListGroupsRequest

public ListGroupsRequest()

Method Detail

getFilters

public List<GroupFilter> getFilters()

Filters, formatted as GroupFilter objects, that you want to apply to a ListGroups operation.

• resource-type - Filter the results to include only those resource groups that have the specified resource type in their ResourceTypeFilter. For example, AWS::EC2::Instance would return any resource group with a ResourceTypeFilter that includes AWS::EC2::Instance.

• configuration-type - Filter the results to include only those groups that have the specified configuration types attached. The current supported values are:

  • AWS::AppRegistry::Application

  • AWS::AppRegistry::ApplicationResourceGroups

  • AWS::CloudFormation::Stack

  • AWS::EC2::CapacityReservationPool

  • AWS::EC2::HostManagement

  • AWS::NetworkFirewall::RuleGroup

Returns:

Filters, formatted as GroupFilter objects, that you want to apply to a ListGroups operation.

• resource-type - Filter the results to include only those resource groups that have the specified resource type in their ResourceTypeFilter. For example, AWS::EC2::Instance would return any resource group with a ResourceTypeFilter that includes AWS::EC2::Instance.

• configuration-type - Filter the results to include only those groups that have the specified configuration types attached. The current supported values are:

  • AWS::AppRegistry::Application

  • AWS::AppRegistry::ApplicationResourceGroups

  • AWS::CloudFormation::Stack

  • AWS::EC2::CapacityReservationPool

  • AWS::EC2::HostManagement

  • AWS::NetworkFirewall::RuleGroup

setFilters

public void setFilters(Collection<GroupFilter> filters)

Filters, formatted as GroupFilter objects, that you want to apply to a ListGroups operation.

• resource-type - Filter the results to include only those resource groups that have the specified resource type in their ResourceTypeFilter. For example, AWS::EC2::Instance would return any resource group with a ResourceTypeFilter that includes AWS::EC2::Instance.

• configuration-type - Filter the results to include only those groups that have the specified configuration types attached. The current supported values are:

  • AWS::AppRegistry::Application

  • AWS::AppRegistry::ApplicationResourceGroups

  • AWS::CloudFormation::Stack

  • AWS::EC2::CapacityReservationPool

  • AWS::EC2::HostManagement

  • AWS::NetworkFirewall::RuleGroup

Parameters:

filters - Filters, formatted as GroupFilter objects, that you want to apply to a ListGroups operation.

• resource-type - Filter the results to include only those resource groups that have the specified resource type in their ResourceTypeFilter. For example, AWS::EC2::Instance would return any resource group with a ResourceTypeFilter that includes AWS::EC2::Instance.

• configuration-type - Filter the results to include only those groups that have the specified configuration types attached. The current supported values are:

  • AWS::AppRegistry::Application

  • AWS::AppRegistry::ApplicationResourceGroups

  • AWS::CloudFormation::Stack

  • AWS::EC2::CapacityReservationPool

  • AWS::EC2::HostManagement

  • AWS::NetworkFirewall::RuleGroup

withFilters

public ListGroupsRequest withFilters(GroupFilter... filters)

Filters, formatted as GroupFilter objects, that you want to apply to a ListGroups operation.

• resource-type - Filter the results to include only those resource groups that have the specified resource type in their ResourceTypeFilter. For example, AWS::EC2::Instance would return any resource group with a ResourceTypeFilter that includes AWS::EC2::Instance.

• configuration-type - Filter the results to include only those groups that have the specified configuration types attached. The current supported values are:

  • AWS::AppRegistry::Application

  • AWS::AppRegistry::ApplicationResourceGroups

  • AWS::CloudFormation::Stack

  • AWS::EC2::CapacityReservationPool

  • AWS::EC2::HostManagement

  • AWS::NetworkFirewall::RuleGroup

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 - Filters, formatted as GroupFilter objects, that you want to apply to a ListGroups operation.

• resource-type - Filter the results to include only those resource groups that have the specified resource type in their ResourceTypeFilter. For example, AWS::EC2::Instance would return any resource group with a ResourceTypeFilter that includes AWS::EC2::Instance.

• configuration-type - Filter the results to include only those groups that have the specified configuration types attached. The current supported values are:

  • AWS::AppRegistry::Application

  • AWS::AppRegistry::ApplicationResourceGroups

  • AWS::CloudFormation::Stack

  • AWS::EC2::CapacityReservationPool

  • AWS::EC2::HostManagement

  • AWS::NetworkFirewall::RuleGroup

Returns:

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

withFilters

public ListGroupsRequest withFilters(Collection<GroupFilter> filters)

Filters, formatted as GroupFilter objects, that you want to apply to a ListGroups operation.

• resource-type - Filter the results to include only those resource groups that have the specified resource type in their ResourceTypeFilter. For example, AWS::EC2::Instance would return any resource group with a ResourceTypeFilter that includes AWS::EC2::Instance.

• configuration-type - Filter the results to include only those groups that have the specified configuration types attached. The current supported values are:

  • AWS::AppRegistry::Application

  • AWS::AppRegistry::ApplicationResourceGroups

  • AWS::CloudFormation::Stack

  • AWS::EC2::CapacityReservationPool

  • AWS::EC2::HostManagement

  • AWS::NetworkFirewall::RuleGroup

Parameters:

filters - Filters, formatted as GroupFilter objects, that you want to apply to a ListGroups operation.

• resource-type - Filter the results to include only those resource groups that have the specified resource type in their ResourceTypeFilter. For example, AWS::EC2::Instance would return any resource group with a ResourceTypeFilter that includes AWS::EC2::Instance.

• configuration-type - Filter the results to include only those groups that have the specified configuration types attached. The current supported values are:

  • AWS::AppRegistry::Application

  • AWS::AppRegistry::ApplicationResourceGroups

  • AWS::CloudFormation::Stack

  • AWS::EC2::CapacityReservationPool

  • AWS::EC2::HostManagement

  • AWS::NetworkFirewall::RuleGroup

Returns:

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

setMaxResults

public void setMaxResults(Integer maxResults)

The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

Parameters:

maxResults - The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

getMaxResults

public Integer getMaxResults()

The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

Returns:

The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

withMaxResults

public ListGroupsRequest withMaxResults(Integer maxResults)

The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

Parameters:

maxResults - The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

Returns:

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

setNextToken

public void setNextToken(String nextToken)

The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value provided by a previous call's NextToken response to indicate where the output should continue from.

Parameters:

nextToken - The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value provided by a previous call's NextToken response to indicate where the output should continue from.

getNextToken

public String getNextToken()

The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value provided by a previous call's NextToken response to indicate where the output should continue from.

Returns:

The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value provided by a previous call's NextToken response to indicate where the output should continue from.

withNextToken

public ListGroupsRequest withNextToken(String nextToken)

The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value provided by a previous call's NextToken response to indicate where the output should continue from.

Parameters:

nextToken - The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value provided by a previous call's NextToken response to indicate where the output should continue from.

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. 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 ListGroupsRequest 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()