Package software.amazon.awssdk.services.config.model

Class DescribeConfigRulesRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.config.model.ConfigRequest

software.amazon.awssdk.services.config.model.DescribeConfigRulesRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeConfigRulesRequest.Builder,DescribeConfigRulesRequest>

@Generated("software.amazon.awssdk:codegen")
public final class DescribeConfigRulesRequest
extends ConfigRequest
implements ToCopyableBuilder<DescribeConfigRulesRequest.Builder,DescribeConfigRulesRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeConfigRulesRequest.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeConfigRulesRequest.Builder	builder()
List<String>	configRuleNames()	The names of the Config rules for which you want details.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
DescribeConfigRulesFilters	filters()	Returns a list of Detective or Proactive Config rules.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasConfigRuleNames()	For responses, this returns true if the service returned a value for the ConfigRuleNames property.
int	hashCode()
String	nextToken()	The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeConfigRulesRequest.Builder>	serializableBuilderClass()
DescribeConfigRulesRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

hasConfigRuleNames

public final boolean hasConfigRuleNames()

For responses, this returns true if the service returned a value for the ConfigRuleNames property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

configRuleNames

public final List<String> configRuleNames()

The names of the Config rules for which you want details. If you do not specify any names, Config returns details for all your rules.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasConfigRuleNames() method.

Returns:

The names of the Config rules for which you want details. If you do not specify any names, Config returns details for all your rules.

nextToken

public final String nextToken()

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Returns:

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

filters

public final DescribeConfigRulesFilters filters()

Returns a list of Detective or Proactive Config rules. By default, this API returns an unfiltered list. For more information on Detective or Proactive Config rules, see Evaluation Mode in the Config Developer Guide.

Returns:

Returns a list of Detective or Proactive Config rules. By default, this API returns an unfiltered list. For more information on Detective or Proactive Config rules, see Evaluation Mode in the Config Developer Guide.

toBuilder

public DescribeConfigRulesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeConfigRulesRequest.Builder,DescribeConfigRulesRequest>

Specified by:

toBuilder in class ConfigRequest

builder

public static DescribeConfigRulesRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeConfigRulesRequest.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