software.amazon.awssdk.services.networkfirewall.model

Class ListRuleGroupsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.networkfirewall.model.NetworkFirewallRequest

software.amazon.awssdk.services.networkfirewall.model.ListRuleGroupsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListRuleGroupsRequest.Builder,ListRuleGroupsRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class ListRuleGroupsRequest
extends NetworkFirewallRequest
implements ToCopyableBuilder<ListRuleGroupsRequest.Builder,ListRuleGroupsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ListRuleGroupsRequest.Builder

Method Summary

Modifier and Type	Method and Description
static ListRuleGroupsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
ResourceManagedType	managedType() Indicates the general category of the Amazon Web Services managed rule group.
String	managedTypeAsString() Indicates the general category of the Amazon Web Services managed rule group.
Integer	maxResults() The maximum number of objects that you want Network Firewall to return for this request.
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.
ResourceManagedStatus	scope() The scope of the request.
String	scopeAsString() The scope of the request.
List<SdkField<?>>	sdkFields()
static Class<? extends ListRuleGroupsRequest.Builder>	serializableBuilderClass()
ListRuleGroupsRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
RuleGroupType	type() Indicates whether the rule group is stateless or stateful.
String	typeAsString() Indicates whether the rule group is stateless or stateful.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

nextToken

public final 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.

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.

maxResults

public final 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.

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.

scope

public final 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.

If the service returns an enum value that is not available in the current SDK version, scope will return ResourceManagedStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from scopeAsString().

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

scopeAsString

public final String scopeAsString()

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.

If the service returns an enum value that is not available in the current SDK version, scope will return ResourceManagedStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from scopeAsString().

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

managedType

public final ResourceManagedType managedType()

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

If the service returns an enum value that is not available in the current SDK version, managedType will return ResourceManagedType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from managedTypeAsString().

Returns:

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

See Also:

ResourceManagedType

managedTypeAsString

public final String managedTypeAsString()

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

If the service returns an enum value that is not available in the current SDK version, managedType will return ResourceManagedType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from managedTypeAsString().

Returns:

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

See Also:

ResourceManagedType

type

public final 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.

If the service returns an enum value that is not available in the current SDK version, type will return RuleGroupType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

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

typeAsString

public final String typeAsString()

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.

If the service returns an enum value that is not available in the current SDK version, type will return RuleGroupType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

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

toBuilder

public ListRuleGroupsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListRuleGroupsRequest.Builder,ListRuleGroupsRequest>

Specified by:

toBuilder in class NetworkFirewallRequest

builder

public static ListRuleGroupsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ListRuleGroupsRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo