Class ListReportGroupsRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<ListReportGroupsRequest.Builder,
ListReportGroupsRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final Integer
The maximum number of paginated report groups returned per response.final String
During a previous call, the maximum number of items that can be returned is the value specified inmaxResults
.static Class
<? extends ListReportGroupsRequest.Builder> final ReportGroupSortByType
sortBy()
The criterion to be used to list build report groups.final String
The criterion to be used to list build report groups.final SortOrderType
Used to specify the order to sort the list of returned report groups.final String
Used to specify the order to sort the list of returned report groups.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
sortOrder
Used to specify the order to sort the list of returned report groups. Valid values are
ASCENDING
andDESCENDING
.If the service returns an enum value that is not available in the current SDK version,
sortOrder
will returnSortOrderType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsortOrderAsString()
.- Returns:
- Used to specify the order to sort the list of returned report groups. Valid values are
ASCENDING
andDESCENDING
. - See Also:
-
sortOrderAsString
Used to specify the order to sort the list of returned report groups. Valid values are
ASCENDING
andDESCENDING
.If the service returns an enum value that is not available in the current SDK version,
sortOrder
will returnSortOrderType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsortOrderAsString()
.- Returns:
- Used to specify the order to sort the list of returned report groups. Valid values are
ASCENDING
andDESCENDING
. - See Also:
-
sortBy
The criterion to be used to list build report groups. Valid values include:
-
CREATED_TIME
: List based on when each report group was created. -
LAST_MODIFIED_TIME
: List based on when each report group was last changed. -
NAME
: List based on each report group's name.
If the service returns an enum value that is not available in the current SDK version,
sortBy
will returnReportGroupSortByType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsortByAsString()
.- Returns:
- The criterion to be used to list build report groups. Valid values include:
-
CREATED_TIME
: List based on when each report group was created. -
LAST_MODIFIED_TIME
: List based on when each report group was last changed. -
NAME
: List based on each report group's name.
-
- See Also:
-
-
sortByAsString
The criterion to be used to list build report groups. Valid values include:
-
CREATED_TIME
: List based on when each report group was created. -
LAST_MODIFIED_TIME
: List based on when each report group was last changed. -
NAME
: List based on each report group's name.
If the service returns an enum value that is not available in the current SDK version,
sortBy
will returnReportGroupSortByType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsortByAsString()
.- Returns:
- The criterion to be used to list build report groups. Valid values include:
-
CREATED_TIME
: List based on when each report group was created. -
LAST_MODIFIED_TIME
: List based on when each report group was last changed. -
NAME
: List based on each report group's name.
-
- See Also:
-
-
nextToken
During a previous call, the maximum number of items that can be returned is the value specified in
maxResults
. If there more items in the list, then a unique string called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.- Returns:
- During a previous call, the maximum number of items that can be returned is the value specified in
maxResults
. If there more items in the list, then a unique string called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.
-
maxResults
The maximum number of paginated report groups returned per response. Use
nextToken
to iterate pages in the list of returnedReportGroup
objects. The default value is 100.- Returns:
- The maximum number of paginated report groups returned per response. Use
nextToken
to iterate pages in the list of returnedReportGroup
objects. The default value is 100.
-
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 interfaceToCopyableBuilder<ListReportGroupsRequest.Builder,
ListReportGroupsRequest> - Specified by:
toBuilder
in classCodeBuildRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-