Class ListSolutionsRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<ListSolutionsRequest.Builder,
ListSolutionsRequest>
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionstatic ListSolutionsRequest.Builder
builder()
final String
catalog()
Specifies the catalog associated with the request.category()
Filters the solutions based on the category to which they belong.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 boolean
For responses, this returns true if the service returned a value for the Category property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Identifier property.final boolean
For responses, this returns true if the service returned a value for the Status property.Filters the solutions based on their unique identifier.final Integer
The maximum number of results returned by a single call.final String
A pagination token used to retrieve the next set of results in subsequent calls.static Class
<? extends ListSolutionsRequest.Builder> final SolutionSort
sort()
Object that configures sorting done on the response.final List
<SolutionStatus> status()
Filters solutions based on their status.Filters solutions based on their status.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
-
catalog
Specifies the catalog associated with the request. This field takes a string value from a predefined list:
AWS
orSandbox
. The catalog determines which environment the solutions are listed in. UseAWS
to list solutions in the Amazon Web Services catalog, andSandbox
to list solutions in a secure and isolated testing environment.- Returns:
- Specifies the catalog associated with the request. This field takes a string value from a predefined
list:
AWS
orSandbox
. The catalog determines which environment the solutions are listed in. UseAWS
to list solutions in the Amazon Web Services catalog, andSandbox
to list solutions in a secure and isolated testing environment.
-
hasCategory
public final boolean hasCategory()For responses, this returns true if the service returned a value for the Category property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
category
Filters the solutions based on the category to which they belong. This allows partners to search for solutions within specific categories, such as
Software
,Consulting
, orManaged Services
.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
hasCategory()
method.- Returns:
- Filters the solutions based on the category to which they belong. This allows partners to search for
solutions within specific categories, such as
Software
,Consulting
, orManaged Services
.
-
hasIdentifier
public final boolean hasIdentifier()For responses, this returns true if the service returned a value for the Identifier property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
identifier
Filters the solutions based on their unique identifier. Use this filter to retrieve specific solutions by providing the solution's identifier for accurate results.
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
hasIdentifier()
method.- Returns:
- Filters the solutions based on their unique identifier. Use this filter to retrieve specific solutions by providing the solution's identifier for accurate results.
-
maxResults
The maximum number of results returned by a single call. This value must be provided in the next call to retrieve the next set of results.
Default: 20
- Returns:
- The maximum number of results returned by a single call. This value must be provided in the next call to
retrieve the next set of results.
Default: 20
-
nextToken
A pagination token used to retrieve the next set of results in subsequent calls. This token is included in the response only if there are additional result pages available.
- Returns:
- A pagination token used to retrieve the next set of results in subsequent calls. This token is included in the response only if there are additional result pages available.
-
sort
Object that configures sorting done on the response. Default
Sort.SortBy
isIdentifier
.- Returns:
- Object that configures sorting done on the response. Default
Sort.SortBy
isIdentifier
.
-
status
Filters solutions based on their status. This filter helps partners manage their solution portfolios effectively.
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
hasStatus()
method.- Returns:
- Filters solutions based on their status. This filter helps partners manage their solution portfolios effectively.
-
hasStatus
public final boolean hasStatus()For responses, this returns true if the service returned a value for the Status property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
statusAsStrings
Filters solutions based on their status. This filter helps partners manage their solution portfolios effectively.
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
hasStatus()
method.- Returns:
- Filters solutions based on their status. This filter helps partners manage their solution portfolios effectively.
-
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<ListSolutionsRequest.Builder,
ListSolutionsRequest> - Specified by:
toBuilder
in classPartnerCentralSellingRequest
- 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
-
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
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
- Returns:
- The mapping between the field name and its corresponding field.
-