com.amazonaws.services.networkfirewall.model

Class ListRuleGroupsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.networkfirewall.model.ListRuleGroupsRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

Method Summary

Modifier and Type	Method and Description
ListRuleGroupsRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getManagedType() Indicates the general category of the Amazon Web Services managed rule group.
Integer	getMaxResults() The maximum number of objects that you want Network Firewall to return for this request.
String	getNextToken() When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response.
String	getScope() The scope of the request.
String	getType() Indicates whether the rule group is stateless or stateful.
int	hashCode()
void	setManagedType(String managedType) Indicates the general category of the Amazon Web Services managed rule group.
void	setMaxResults(Integer maxResults) The maximum number of objects that you want Network Firewall to return for this request.
void	setNextToken(String nextToken) When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response.
void	setScope(String scope) The scope of the request.
void	setType(String type) Indicates whether the rule group is stateless or stateful.
String	toString() Returns a string representation of this object.
ListRuleGroupsRequest	withManagedType(ResourceManagedType managedType) Indicates the general category of the Amazon Web Services managed rule group.
ListRuleGroupsRequest	withManagedType(String managedType) Indicates the general category of the Amazon Web Services managed rule group.
ListRuleGroupsRequest	withMaxResults(Integer maxResults) The maximum number of objects that you want Network Firewall to return for this request.
ListRuleGroupsRequest	withNextToken(String nextToken) When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response.
ListRuleGroupsRequest	withScope(ResourceManagedStatus scope) The scope of the request.
ListRuleGroupsRequest	withScope(String scope) The scope of the request.
ListRuleGroupsRequest	withType(RuleGroupType type) Indicates whether the rule group is stateless or stateful.
ListRuleGroupsRequest	withType(String type) Indicates whether the rule group is stateless or stateful.

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

ListRuleGroupsRequest

public ListRuleGroupsRequest()

Method Detail

setNextToken

public void setNextToken(String nextToken)

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

Parameters:

nextToken - When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

getNextToken

public String getNextToken()

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

Returns:

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

withNextToken

public ListRuleGroupsRequest withNextToken(String nextToken)

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

Parameters:

nextToken - When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

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 objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

Parameters:

maxResults - The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

getMaxResults

public Integer getMaxResults()

The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

Returns:

The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

withMaxResults

public ListRuleGroupsRequest withMaxResults(Integer maxResults)

The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

Parameters:

maxResults - The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

Returns:

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

setScope

public void setScope(String scope)

The scope of the request. The default setting of ACCOUNT or a setting of NULL returns all of the rule groups in your account. A setting of MANAGED returns all available managed rule groups.

Parameters:

scope - The scope of the request. The default setting of ACCOUNT or a setting of NULL returns all of the rule groups in your account. A setting of MANAGED returns all available managed rule groups.

See Also:

ResourceManagedStatus

getScope

public String getScope()

The scope of the request. The default setting of ACCOUNT or a setting of NULL returns all of the rule groups in your account. A setting of MANAGED returns all available managed rule groups.

Returns:

The scope of the request. The default setting of ACCOUNT or a setting of NULL returns all of the rule groups in your account. A setting of MANAGED returns all available managed rule groups.

See Also:

ResourceManagedStatus

withScope

public ListRuleGroupsRequest withScope(String scope)

The scope of the request. The default setting of ACCOUNT or a setting of NULL returns all of the rule groups in your account. A setting of MANAGED returns all available managed rule groups.

Parameters:

scope - The scope of the request. The default setting of ACCOUNT or a setting of NULL returns all of the rule groups in your account. A setting of MANAGED returns all available managed rule groups.

Returns:

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

See Also:

ResourceManagedStatus

withScope

public ListRuleGroupsRequest withScope(ResourceManagedStatus scope)

The scope of the request. The default setting of ACCOUNT or a setting of NULL returns all of the rule groups in your account. A setting of MANAGED returns all available managed rule groups.

Parameters:

scope - The scope of the request. The default setting of ACCOUNT or a setting of NULL returns all of the rule groups in your account. A setting of MANAGED returns all available managed rule groups.

Returns:

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

See Also:

ResourceManagedStatus

setManagedType

public void setManagedType(String managedType)

Indicates the general category of the Amazon Web Services managed rule group.

Parameters:

managedType - Indicates the general category of the Amazon Web Services managed rule group.

See Also:

ResourceManagedType

getManagedType

public String getManagedType()

Indicates the general category of the Amazon Web Services managed rule group.

Returns:

Indicates the general category of the Amazon Web Services managed rule group.

See Also:

ResourceManagedType

withManagedType

public ListRuleGroupsRequest withManagedType(String managedType)

Indicates the general category of the Amazon Web Services managed rule group.

Parameters:

managedType - Indicates the general category of the Amazon Web Services managed rule group.

Returns:

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

See Also:

ResourceManagedType

withManagedType

public ListRuleGroupsRequest withManagedType(ResourceManagedType managedType)

Indicates the general category of the Amazon Web Services managed rule group.

Parameters:

managedType - Indicates the general category of the Amazon Web Services managed rule group.

Returns:

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

See Also:

ResourceManagedType

setType

public void setType(String type)

Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.

Parameters:

type - Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.

See Also:

RuleGroupType

getType

public String getType()

Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.

Returns:

Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.

See Also:

RuleGroupType

withType

public ListRuleGroupsRequest withType(String type)

Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.

Parameters:

type - Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.

Returns:

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

See Also:

RuleGroupType

withType

public ListRuleGroupsRequest withType(RuleGroupType type)

Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.

Parameters:

type - Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.

Returns:

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

See Also:

RuleGroupType

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 ListRuleGroupsRequest 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()