@Generated(value="software.amazon.awssdk:codegen") public final class GetComplianceSummaryRequest extends ResourceGroupsTaggingApiRequest implements ToCopyableBuilder<GetComplianceSummaryRequest.Builder,GetComplianceSummaryRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
GetComplianceSummaryRequest.Builder |
| 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()
Specifies a list of attributes to group the counts of noncompliant resources by.
|
List<String> |
groupByAsStrings()
Specifies a list of attributes to group the counts of noncompliant resources by.
|
boolean |
hasGroupBy()
For responses, this returns true if the service returned a value for the GroupBy property.
|
int |
hashCode() |
boolean |
hasRegionFilters()
For responses, this returns true if the service returned a value for the RegionFilters property.
|
boolean |
hasResourceTypeFilters()
For responses, this returns true if the service returned a value for the ResourceTypeFilters property.
|
boolean |
hasTagKeyFilters()
For responses, this returns true if the service returned a value for the TagKeyFilters property.
|
boolean |
hasTargetIdFilters()
For responses, this returns true if the service returned a value for the TargetIdFilters property.
|
Integer |
maxResults()
Specifies the maximum number of results to be returned in each page.
|
String |
paginationToken()
Specifies a
PaginationToken response value from a previous request to indicate that you want the
next page of results. |
List<String> |
regionFilters()
Specifies a list of AWS Regions to limit the output by.
|
List<String> |
resourceTypeFilters()
Specifies that you want the response to include information for only resources of the specified types.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends GetComplianceSummaryRequest.Builder> |
serializableBuilderClass() |
List<String> |
tagKeyFilters()
Specifies that you want the response to include information for only resources that have tags with the specified
tag keys.
|
List<String> |
targetIdFilters()
Specifies 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.
|
overrideConfigurationcopypublic final boolean hasTargetIdFilters()
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.public final List<String> targetIdFilters()
Specifies 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.
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 hasTargetIdFilters() method.
public final boolean hasRegionFilters()
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.public final List<String> regionFilters()
Specifies a list of AWS 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.
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 hasRegionFilters() method.
public final boolean hasResourceTypeFilters()
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.public final List<String> resourceTypeFilters()
Specifies that you want the response to include information for only resources of the specified types. 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 a comma separated 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.
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 hasResourceTypeFilters() method.
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 a comma separated array. The array can include up to 100 items. Note that the length constraint requirement applies to each resource type filter.
public final boolean hasTagKeyFilters()
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.public final List<String> tagKeyFilters()
Specifies that you want the response to include information for only resources that have tags with the specified tag keys. 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.
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 hasTagKeyFilters() method.
public final List<GroupByAttribute> groupBy()
Specifies 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.
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 hasGroupBy() method.
public final boolean hasGroupBy()
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.public final List<String> groupByAsStrings()
Specifies 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.
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 hasGroupBy() method.
public final Integer maxResults()
Specifies the maximum number of results to be returned in each page. A query can return fewer than this maximum,
even if there are more results still to return. You should always check the PaginationToken response
value to see if there are more results. You can specify a minimum of 1 and a maximum value of 100.
PaginationToken response value to see if there are more results. You can specify a minimum
of 1 and a maximum value of 100.public final String paginationToken()
Specifies a PaginationToken response value from a previous request to indicate that you want the
next page of results. Leave this parameter empty in your initial request.
PaginationToken response value from a previous request to indicate that you want
the next page of results. Leave this parameter empty in your initial request.public GetComplianceSummaryRequest.Builder toBuilder()
ToCopyableBuildertoBuilder in interface ToCopyableBuilder<GetComplianceSummaryRequest.Builder,GetComplianceSummaryRequest>toBuilder in class ResourceGroupsTaggingApiRequestpublic static GetComplianceSummaryRequest.Builder builder()
public static Class<? extends GetComplianceSummaryRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
SdkPojoSdkPojo 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.
equalsBySdkFields in interface SdkPojoobj - the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequestSdkRequest. 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.getValueForField in class SdkRequestfieldName - The name of the member to be retrieved.clazz - The class to cast the returned object to.