Class ListAppsRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<ListAppsRequest.Builder,
ListAppsRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic ListAppsRequest.Builder
builder()
final String
A parameter to search for the domain ID.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 total number of items to return in the response.final String
If the previous response was truncated, you will receive this token.static Class
<? extends ListAppsRequest.Builder> final AppSortKey
sortBy()
The parameter by which to sort the results.final String
The parameter by which to sort the results.final SortOrder
The sort order for the results.final String
The sort order for the results.final String
A parameter to search by space name.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.final String
A parameter to search by user profile name.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
nextToken
If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
- Returns:
- If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
-
maxResults
The total number of items to return in the response. If the total number of items available is more than the value specified, a
NextToken
is provided in the response. To resume pagination, provide theNextToken
value in the as part of a subsequent call. The default value is 10.- Returns:
- The total number of items to return in the response. If the total number of items available is more than
the value specified, a
NextToken
is provided in the response. To resume pagination, provide theNextToken
value in the as part of a subsequent call. The default value is 10.
-
sortOrder
The sort order for the results. The default is Ascending.
If the service returns an enum value that is not available in the current SDK version,
sortOrder
will returnSortOrder.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsortOrderAsString()
.- Returns:
- The sort order for the results. The default is Ascending.
- See Also:
-
sortOrderAsString
The sort order for the results. The default is Ascending.
If the service returns an enum value that is not available in the current SDK version,
sortOrder
will returnSortOrder.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsortOrderAsString()
.- Returns:
- The sort order for the results. The default is Ascending.
- See Also:
-
sortBy
The parameter by which to sort the results. The default is CreationTime.
If the service returns an enum value that is not available in the current SDK version,
sortBy
will returnAppSortKey.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsortByAsString()
.- Returns:
- The parameter by which to sort the results. The default is CreationTime.
- See Also:
-
sortByAsString
The parameter by which to sort the results. The default is CreationTime.
If the service returns an enum value that is not available in the current SDK version,
sortBy
will returnAppSortKey.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsortByAsString()
.- Returns:
- The parameter by which to sort the results. The default is CreationTime.
- See Also:
-
domainIdEquals
A parameter to search for the domain ID.
- Returns:
- A parameter to search for the domain ID.
-
userProfileNameEquals
A parameter to search by user profile name. If
SpaceNameEquals
is set, then this value cannot be set.- Returns:
- A parameter to search by user profile name. If
SpaceNameEquals
is set, then this value cannot be set.
-
spaceNameEquals
A parameter to search by space name. If
UserProfileNameEquals
is set, then this value cannot be set.- Returns:
- A parameter to search by space name. If
UserProfileNameEquals
is set, then this value cannot be set.
-
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<ListAppsRequest.Builder,
ListAppsRequest> - Specified by:
toBuilder
in classSageMakerRequest
- 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
-