Class SearchProvisionedProductsRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<SearchProvisionedProductsRequest.Builder,
SearchProvisionedProductsRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The language code.final AccessLevelFilter
The access level to use to obtain results.builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final Map
<ProvisionedProductViewFilterBy, List<String>> filters()
The search filters.The search filters.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 Filters property.final int
hashCode()
final Integer
pageSize()
The maximum number of items to return with this call.final String
The page token for the next set of results.static Class
<? extends SearchProvisionedProductsRequest.Builder> final String
sortBy()
The sort field.final SortOrder
The sort order.final String
The sort order.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
-
acceptLanguage
The language code.
-
jp
- Japanese -
zh
- Chinese
- Returns:
- The language code.
-
jp
- Japanese -
zh
- Chinese
-
-
-
accessLevelFilter
The access level to use to obtain results. The default is
User
.- Returns:
- The access level to use to obtain results. The default is
User
.
-
filters
The search filters.
When the key is
SearchQuery
, the searchable fields arearn
,createdTime
,id
,lastRecordId
,idempotencyToken
,name
,physicalId
,productId
,provisioningArtifactId
,type
,status
,tags
,userArn
,userArnSession
,lastProvisioningRecordId
,lastSuccessfulProvisioningRecordId
,productName
, andprovisioningArtifactName
.Example:
"SearchQuery":["status:AVAILABLE"]
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
hasFilters()
method.- Returns:
- The search filters.
When the key is
SearchQuery
, the searchable fields arearn
,createdTime
,id
,lastRecordId
,idempotencyToken
,name
,physicalId
,productId
,provisioningArtifactId
,type
,status
,tags
,userArn
,userArnSession
,lastProvisioningRecordId
,lastSuccessfulProvisioningRecordId
,productName
, andprovisioningArtifactName
.Example:
"SearchQuery":["status:AVAILABLE"]
-
hasFilters
public final boolean hasFilters()For responses, this returns true if the service returned a value for the Filters 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. -
filtersAsStrings
The search filters.
When the key is
SearchQuery
, the searchable fields arearn
,createdTime
,id
,lastRecordId
,idempotencyToken
,name
,physicalId
,productId
,provisioningArtifactId
,type
,status
,tags
,userArn
,userArnSession
,lastProvisioningRecordId
,lastSuccessfulProvisioningRecordId
,productName
, andprovisioningArtifactName
.Example:
"SearchQuery":["status:AVAILABLE"]
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
hasFilters()
method.- Returns:
- The search filters.
When the key is
SearchQuery
, the searchable fields arearn
,createdTime
,id
,lastRecordId
,idempotencyToken
,name
,physicalId
,productId
,provisioningArtifactId
,type
,status
,tags
,userArn
,userArnSession
,lastProvisioningRecordId
,lastSuccessfulProvisioningRecordId
,productName
, andprovisioningArtifactName
.Example:
"SearchQuery":["status:AVAILABLE"]
-
sortBy
The sort field. If no value is specified, the results are not sorted. The valid values are
arn
,id
,name
, andlastRecordId
.- Returns:
- The sort field. If no value is specified, the results are not sorted. The valid values are
arn
,id
,name
, andlastRecordId
.
-
sortOrder
The sort order. If no value is specified, the results are not sorted.
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. If no value is specified, the results are not sorted.
- See Also:
-
sortOrderAsString
The sort order. If no value is specified, the results are not sorted.
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. If no value is specified, the results are not sorted.
- See Also:
-
pageSize
The maximum number of items to return with this call.
- Returns:
- The maximum number of items to return with this call.
-
pageToken
The page token for the next set of results. To retrieve the first set of results, use null.
- Returns:
- The page token for the next set of results. To retrieve the first set of results, use null.
-
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<SearchProvisionedProductsRequest.Builder,
SearchProvisionedProductsRequest> - Specified by:
toBuilder
in classServiceCatalogRequest
- 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
-