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>

  • Method Details

    • 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:

    • 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:

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ListControlsRequest.Builder,ListControlsRequest>
      Specified by:
      toBuilder in class AuditManagerRequest
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.