Package software.amazon.awssdk.services.iotsitewise.model

Class ListAssetPropertiesRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.iotsitewise.model.IoTSiteWiseRequest

software.amazon.awssdk.services.iotsitewise.model.ListAssetPropertiesRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListAssetPropertiesRequest.Builder,ListAssetPropertiesRequest>

@Generated("software.amazon.awssdk:codegen")
public final class ListAssetPropertiesRequest
extends IoTSiteWiseRequest
implements ToCopyableBuilder<ListAssetPropertiesRequest.Builder,ListAssetPropertiesRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListAssetPropertiesRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	assetId()	The ID of the asset.
static ListAssetPropertiesRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
ListAssetPropertiesFilter	filter()	Filters the requested list of asset properties.
String	filterAsString()	Filters the requested list of asset properties.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	maxResults()	The maximum number of results to return for each paginated request.
String	nextToken()	The token to be used for the next set of paginated results.
List<SdkField<?>>	sdkFields()
static Class<? extends ListAssetPropertiesRequest.Builder>	serializableBuilderClass()
ListAssetPropertiesRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

assetId

public final String assetId()

The ID of the asset. This can be either the actual ID in UUID format, or else externalId: 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. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

nextToken

public final String 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

public final Integer maxResults()

The maximum number of results to return for each paginated request. If not specified, the default value is 50.

Returns:

The maximum number of results to return for each paginated request. If not specified, the default value is 50.

filter

public final ListAssetPropertiesFilter filter()

Filters the requested list of asset properties. You can choose one of the following options:

• ALL – The list includes all asset properties for a given asset model ID.

• BASE – The list includes only base asset properties for a given asset model ID.

Default: BASE

If the service returns an enum value that is not available in the current SDK version, filter will return ListAssetPropertiesFilter.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from filterAsString().

Returns:

Filters the requested list of asset properties. You can choose one of the following options:

• ALL – The list includes all asset properties for a given asset model ID.

• BASE – The list includes only base asset properties for a given asset model ID.

Default: BASE

See Also:

ListAssetPropertiesFilter

filterAsString

public final String filterAsString()

Filters the requested list of asset properties. You can choose one of the following options:

• ALL – The list includes all asset properties for a given asset model ID.

• BASE – The list includes only base asset properties for a given asset model ID.

Default: BASE

If the service returns an enum value that is not available in the current SDK version, filter will return ListAssetPropertiesFilter.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from filterAsString().

Returns:

Filters the requested list of asset properties. You can choose one of the following options:

• ALL – The list includes all asset properties for a given asset model ID.

• BASE – The list includes only base asset properties for a given asset model ID.

Default: BASE

See Also:

ListAssetPropertiesFilter

toBuilder

public ListAssetPropertiesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListAssetPropertiesRequest.Builder,ListAssetPropertiesRequest>

Specified by:

toBuilder in class IoTSiteWiseRequest

builder

public static ListAssetPropertiesRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ListAssetPropertiesRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String 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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo