GetComplianceSummaryRequest (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.resourcegroupstaggingapi.model.ResourceGroupsTaggingApiRequest
    - - software.amazon.awssdk.services.resourcegroupstaggingapi.model.GetComplianceSummaryRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<GetComplianceSummaryRequest.Builder,GetComplianceSummaryRequest>

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface GetComplianceSummaryRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`GetComplianceSummaryRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static GetComplianceSummaryRequest.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)` Indicates whether some other object is "equal to" this one by SDK fields.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)` Used to retrieve the value of a field from any class that extends `SdkRequest`.
`List<GroupByAttribute>`	`groupBy()` A list of attributes to group the counts of noncompliant resources by.
`List<String>`	`groupByAsStrings()` A list of attributes to group the counts of noncompliant resources by.
`boolean`	`hasGroupBy()` Returns true if the GroupBy property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`boolean`	`hasRegionFilters()` Returns true if the RegionFilters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasResourceTypeFilters()` Returns true if the ResourceTypeFilters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasTagKeyFilters()` Returns true if the TagKeyFilters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasTargetIdFilters()` Returns true if the TargetIdFilters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`Integer`	`maxResults()` A limit that restricts the number of results that are returned per page.
`String`	`paginationToken()` A string that indicates that additional data is available.
`List<String>`	`regionFilters()` A list of Regions to limit the output by.
`List<String>`	`resourceTypeFilters()` The constraints on the resources that you want returned.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends GetComplianceSummaryRequest.Builder>`	`serializableBuilderClass()`
`List<String>`	`tagKeyFilters()` A list of tag keys to limit the output by.
`List<String>`	`targetIdFilters()` The target identifiers (usually, specific account IDs) to limit the output by.
`GetComplianceSummaryRequest.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`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
getClass, notify, notifyAll, wait, wait, wait

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

- Method Detail
  - hasTargetIdFilters
```
public boolean hasTargetIdFilters()
```
    Returns true if the TargetIdFilters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - targetIdFilters
```
public List<String> targetIdFilters()
```
    The target identifiers (usually, specific account IDs) to limit the output by. If you use this parameter, the count of returned noncompliant resources includes only resources with the specified target IDs.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasTargetIdFilters() to see if a value was sent in this field.
    
    Returns:
    
    The target identifiers (usually, specific account IDs) to limit the output by. If you use this parameter, the count of returned noncompliant resources includes only resources with the specified target IDs.
  - hasRegionFilters
```
public boolean hasRegionFilters()
```
    Returns true if the RegionFilters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - regionFilters
```
public List<String> regionFilters()
```
    A list of Regions to limit the output by. If you use this parameter, the count of returned noncompliant resources includes only resources in the specified Regions.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasRegionFilters() to see if a value was sent in this field.
    
    Returns:
    
    A list of Regions to limit the output by. If you use this parameter, the count of returned noncompliant resources includes only resources in the specified Regions.
  - hasResourceTypeFilters
```
public boolean hasResourceTypeFilters()
```
    Returns true if the ResourceTypeFilters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - resourceTypeFilters
```
public List<String> resourceTypeFilters()
```
    The constraints on the resources that you want returned. The format of each resource type is service[:resourceType]. For example, specifying a resource type of ec2 returns all Amazon EC2 resources (which includes EC2 instances). Specifying a resource type of ec2:instance returns only EC2 instances.
    
    The string for each service name and resource type is the same as that embedded in a resource's Amazon Resource Name (ARN). Consult the AWS General Reference for the following:
    - For a list of service name strings, see AWS Service Namespaces.
    - For resource type strings, see Example ARNs.
    - For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
    You can specify multiple resource types by using an array. The array can include up to 100 items. Note that the length constraint requirement applies to each resource type filter.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasResourceTypeFilters() to see if a value was sent in this field.
    Returns:
    The constraints on the resources that you want returned. The format of each resource type is service[:resourceType]. For example, specifying a resource type of ec2 returns all Amazon EC2 resources (which includes EC2 instances). Specifying a resource type of ec2:instance returns only EC2 instances.
    
    The string for each service name and resource type is the same as that embedded in a resource's Amazon Resource Name (ARN). Consult the AWS General Reference for the following:
    
    For a list of service name strings, see AWS Service Namespaces.
    
    For resource type strings, see Example ARNs.
    
    For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
    
    You can specify multiple resource types by using an array. The array can include up to 100 items. Note that the length constraint requirement applies to each resource type filter.
  - hasTagKeyFilters
```
public boolean hasTagKeyFilters()
```
    Returns true if the TagKeyFilters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - tagKeyFilters
```
public List<String> tagKeyFilters()
```
    A list of tag keys to limit the output by. If you use this parameter, the count of returned noncompliant resources includes only resources that have the specified tag keys.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasTagKeyFilters() to see if a value was sent in this field.
    
    Returns:
    
    A list of tag keys to limit the output by. If you use this parameter, the count of returned noncompliant resources includes only resources that have the specified tag keys.
  - groupBy
```
public List<GroupByAttribute> groupBy()
```
    A list of attributes to group the counts of noncompliant resources by. If supplied, the counts are sorted by those attributes.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasGroupBy() to see if a value was sent in this field.
    
    Returns:
    
    A list of attributes to group the counts of noncompliant resources by. If supplied, the counts are sorted by those attributes.
  - hasGroupBy
```
public boolean hasGroupBy()
```
    Returns true if the GroupBy property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - groupByAsStrings
```
public List<String> groupByAsStrings()
```
    A list of attributes to group the counts of noncompliant resources by. If supplied, the counts are sorted by those attributes.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasGroupBy() to see if a value was sent in this field.
    
    Returns:
    
    A list of attributes to group the counts of noncompliant resources by. If supplied, the counts are sorted by those attributes.
  - maxResults
```
public Integer maxResults()
```
    A limit that restricts the number of results that are returned per page.
    
    Returns:
    
    A limit that restricts the number of results that are returned per page.
  - paginationToken
```
public String paginationToken()
```
    A string that indicates that additional data is available. Leave this value empty for your initial request. If the response includes a PaginationToken, use that string for this value to request an additional page of data.
    
    Returns:
    
    A string that indicates that additional data is available. Leave this value empty for your initial request. If the response includes a PaginationToken, use that string for this value to request an additional page of data.
  - toBuilder
```
public GetComplianceSummaryRequest.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<GetComplianceSummaryRequest.Builder,GetComplianceSummaryRequest>
    
    Specified by:
    
    toBuilder in class ResourceGroupsTaggingApiRequest
    
    Returns:
    
    a builder for type T
  - builder
```
public static GetComplianceSummaryRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends GetComplianceSummaryRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public 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 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 <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 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.

AWS SDK for Java API Reference - 2.15.14

Class GetComplianceSummaryRequest

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

hasTargetIdFilters

targetIdFilters

hasRegionFilters

regionFilters

hasResourceTypeFilters

resourceTypeFilters

hasTagKeyFilters

tagKeyFilters

groupBy

hasGroupBy

groupByAsStrings

maxResults

paginationToken

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

Copyright © 2020 Amazon Web Services, Inc. All Rights Reserved.