Package software.amazon.awssdk.services.auditmanager.model

Class ListControlsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.auditmanager.model.AuditManagerRequest

software.amazon.awssdk.services.auditmanager.model.ListControlsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListControlsRequest.Builder,ListControlsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListControlsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ListControlsRequest.Builder	builder()
String	controlCatalogId()	A filter that narrows the list of controls to a specific resource from the Amazon Web Services Control Catalog.
ControlType	controlType()	A filter that narrows the list of controls to a specific type.
String	controlTypeAsString()	A filter that narrows the list of controls to a specific type.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	maxResults()	The maximum number of results on a page or for an API request call.
String	nextToken()	The pagination token that's used to fetch the next set of results.
List<SdkField<?>>	sdkFields()
static Class<? extends ListControlsRequest.Builder>	serializableBuilderClass()
ListControlsRequest.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

controlType

public final ControlType controlType()

A filter that narrows the list of controls to a specific type.

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

Returns:

A filter that narrows the list of controls to a specific type.

See Also:

ControlType

controlTypeAsString

public final String controlTypeAsString()

A filter that narrows the list of controls to a specific type.

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

Returns:

A filter that narrows the list of controls to a specific type.

See Also:

ControlType

nextToken

public final String nextToken()

The pagination token that's used to fetch the next set of results.

Returns:

The pagination token that's used to fetch the next set of results.

maxResults

public final Integer maxResults()

The maximum number of results on a page or for an API request call.

Returns:

The maximum number of results on a page or for an API request call.

controlCatalogId

public final String controlCatalogId()

A filter that narrows the list of controls to a specific resource from the Amazon Web Services Control Catalog.

To use this parameter, specify the ARN of the Control Catalog resource. You can specify either a control domain, a control objective, or a common control. For information about how to find the ARNs for these resources, see ListDomains , ListObjectives , and ListCommonControls .

You can only filter by one Control Catalog resource at a time. Specifying multiple resource ARNs isn’t currently supported. If you want to filter by more than one ARN, we recommend that you run the ListControls operation separately for each ARN.

Alternatively, specify UNCATEGORIZED to list controls that aren't mapped to a Control Catalog resource. For example, this operation might return a list of custom controls that don't belong to any control domain or control objective.

Returns:

A filter that narrows the list of controls to a specific resource from the Amazon Web Services Control Catalog.

To use this parameter, specify the ARN of the Control Catalog resource. You can specify either a control domain, a control objective, or a common control. For information about how to find the ARNs for these resources, see ListDomains , ListObjectives , and ListCommonControls .

You can only filter by one Control Catalog resource at a time. Specifying multiple resource ARNs isn’t currently supported. If you want to filter by more than one ARN, we recommend that you run the ListControls operation separately for each ARN.

Alternatively, specify UNCATEGORIZED to list controls that aren't mapped to a Control Catalog resource. For example, this operation might return a list of custom controls that don't belong to any control domain or control objective.

toBuilder

public ListControlsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListControlsRequest.Builder,ListControlsRequest>

Specified by:

toBuilder in class AuditManagerRequest

builder

public static ListControlsRequest.Builder builder()

serializableBuilderClass

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