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

Class GetComplianceDetailsByConfigRuleRequest

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.GetComplianceDetailsByConfigRuleRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetComplianceDetailsByConfigRuleRequest.Builder,GetComplianceDetailsByConfigRuleRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetComplianceDetailsByConfigRuleRequest.Builder

Method Summary

Modifier and Type	Method	Description
static GetComplianceDetailsByConfigRuleRequest.Builder	builder()
List<ComplianceType>	complianceTypes()	Filters the results by compliance.
List<String>	complianceTypesAsStrings()	Filters the results by compliance.
String	configRuleName()	The name of the Config rule for which you want compliance information.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasComplianceTypes()	For responses, this returns true if the service returned a value for the ComplianceTypes property.
int	hashCode()
Integer	limit()	The maximum number of evaluation results returned on each page.
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 GetComplianceDetailsByConfigRuleRequest.Builder>	serializableBuilderClass()
GetComplianceDetailsByConfigRuleRequest.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

configRuleName

public final String configRuleName()

The name of the Config rule for which you want compliance information.

Returns:

The name of the Config rule for which you want compliance information.

complianceTypes

public final List<ComplianceType> complianceTypes()

Filters the results by compliance.

INSUFFICIENT_DATA is a valid ComplianceType that is returned when an Config rule cannot be evaluated. However, INSUFFICIENT_DATA cannot be used as a ComplianceType for filtering results.

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 hasComplianceTypes() method.

Returns:

Filters the results by compliance.

INSUFFICIENT_DATA is a valid ComplianceType that is returned when an Config rule cannot be evaluated. However, INSUFFICIENT_DATA cannot be used as a ComplianceType for filtering results.

hasComplianceTypes

public final boolean hasComplianceTypes()

For responses, this returns true if the service returned a value for the ComplianceTypes 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.

complianceTypesAsStrings

public final List<String> complianceTypesAsStrings()

Filters the results by compliance.

INSUFFICIENT_DATA is a valid ComplianceType that is returned when an Config rule cannot be evaluated. However, INSUFFICIENT_DATA cannot be used as a ComplianceType for filtering results.

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 hasComplianceTypes() method.

Returns:

Filters the results by compliance.

INSUFFICIENT_DATA is a valid ComplianceType that is returned when an Config rule cannot be evaluated. However, INSUFFICIENT_DATA cannot be used as a ComplianceType for filtering results.

limit

public final Integer limit()

The maximum number of evaluation results returned on each page. The default is 10. You cannot specify a number greater than 100. If you specify 0, Config uses the default.

Returns:

The maximum number of evaluation results returned on each page. The default is 10. You cannot specify a number greater than 100. If you specify 0, Config uses the default.

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.

toBuilder

public GetComplianceDetailsByConfigRuleRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetComplianceDetailsByConfigRuleRequest.Builder,GetComplianceDetailsByConfigRuleRequest>

Specified by:

toBuilder in class ConfigRequest

builder

public static GetComplianceDetailsByConfigRuleRequest.Builder builder()

serializableBuilderClass

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