Class ListAssetsRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<ListAssetsRequest.Builder,
ListAssetsRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The ID of the asset model by which to filter the list of assets.static ListAssetsRequest.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final ListAssetsFilter
filter()
The filter for the requested list of assets.final String
The filter for the requested list of assets.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 results to return for each paginated request.final String
The token to be used for the next set of paginated results.static Class
<? extends ListAssetsRequest.Builder> 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
-
nextToken
The token to be used for the next set of paginated results.
- Returns:
- The token to be used for the next set of paginated results.
-
maxResults
The maximum number of results to return for each paginated request.
Default: 50
- Returns:
- The maximum number of results to return for each paginated request.
Default: 50
-
assetModelId
The ID of the asset model by which to filter the list of assets. This parameter is required if you choose
ALL
forfilter
. This can be either the actual ID in UUID format, or elseexternalId:
followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.- Returns:
- The ID of the asset model by which to filter the list of assets. This parameter is required if you choose
ALL
forfilter
. This can be either the actual ID in UUID format, or elseexternalId:
followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
-
filter
The filter for the requested list of assets. Choose one of the following options:
-
ALL
– The list includes all assets for a given asset model ID. TheassetModelId
parameter is required if you filter byALL
. -
TOP_LEVEL
– The list includes only top-level assets in the asset hierarchy tree.
Default:
ALL
If the service returns an enum value that is not available in the current SDK version,
filter
will returnListAssetsFilter.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromfilterAsString()
.- Returns:
- The filter for the requested list of assets. Choose one of the following options:
-
ALL
– The list includes all assets for a given asset model ID. TheassetModelId
parameter is required if you filter byALL
. -
TOP_LEVEL
– The list includes only top-level assets in the asset hierarchy tree.
Default:
ALL
-
- See Also:
-
-
filterAsString
The filter for the requested list of assets. Choose one of the following options:
-
ALL
– The list includes all assets for a given asset model ID. TheassetModelId
parameter is required if you filter byALL
. -
TOP_LEVEL
– The list includes only top-level assets in the asset hierarchy tree.
Default:
ALL
If the service returns an enum value that is not available in the current SDK version,
filter
will returnListAssetsFilter.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromfilterAsString()
.- Returns:
- The filter for the requested list of assets. Choose one of the following options:
-
ALL
– The list includes all assets for a given asset model ID. TheassetModelId
parameter is required if you filter byALL
. -
TOP_LEVEL
– The list includes only top-level assets in the asset hierarchy tree.
Default:
ALL
-
- See Also:
-
-
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<ListAssetsRequest.Builder,
ListAssetsRequest> - Specified by:
toBuilder
in classIoTSiteWiseRequest
- 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
-