Package software.amazon.awssdk.services.iotfleetwise.model

Class CustomProperty

java.lang.Object

software.amazon.awssdk.services.iotfleetwise.model.CustomProperty

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<CustomProperty.Builder,CustomProperty>

@Generated("software.amazon.awssdk:codegen")
public final class CustomProperty
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<CustomProperty.Builder,CustomProperty>

Represents a member of the complex data structure. The data type of the property can be either primitive or another struct.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CustomProperty.Builder

Method Summary

Modifier and Type	Method	Description
static CustomProperty.Builder	builder()
String	comment()	A comment in addition to the description.
NodeDataEncoding	dataEncoding()	Indicates whether the property is binary data.
String	dataEncodingAsString()	Indicates whether the property is binary data.
NodeDataType	dataType()	The data type for the custom property.
String	dataTypeAsString()	The data type for the custom property.
String	deprecationMessage()	The deprecation message for the node or the branch that was moved or deleted.
String	description()	A brief description of the custom property.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	fullyQualifiedName()	The fully qualified name of the custom property.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CustomProperty.Builder>	serializableBuilderClass()
String	structFullyQualifiedName()	The fully qualified name of the struct node for the custom property if the data type of the custom property is Struct or StructArray.
CustomProperty.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

fullyQualifiedName

public final String fullyQualifiedName()

The fully qualified name of the custom property. For example, the fully qualified name of a custom property might be ComplexDataTypes.VehicleDataTypes.SVMCamera.FPS.

Returns:

The fully qualified name of the custom property. For example, the fully qualified name of a custom property might be ComplexDataTypes.VehicleDataTypes.SVMCamera.FPS.

dataType

public final NodeDataType dataType()

The data type for the custom property.

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

Returns:

The data type for the custom property.

See Also:

NodeDataType

dataTypeAsString

public final String dataTypeAsString()

The data type for the custom property.

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

Returns:

The data type for the custom property.

See Also:

NodeDataType

dataEncoding

public final NodeDataEncoding dataEncoding()

Indicates whether the property is binary data.

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

Returns:

Indicates whether the property is binary data.

See Also:

NodeDataEncoding

dataEncodingAsString

public final String dataEncodingAsString()

Indicates whether the property is binary data.

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

Returns:

Indicates whether the property is binary data.

See Also:

NodeDataEncoding

description

public final String description()

A brief description of the custom property.

Returns:

A brief description of the custom property.

deprecationMessage

public final String deprecationMessage()

The deprecation message for the node or the branch that was moved or deleted.

Returns:

The deprecation message for the node or the branch that was moved or deleted.

comment

public final String comment()

A comment in addition to the description.

Returns:

A comment in addition to the description.

structFullyQualifiedName

public final String structFullyQualifiedName()

The fully qualified name of the struct node for the custom property if the data type of the custom property is Struct or StructArray.

Returns:

The fully qualified name of the struct node for the custom property if the data type of the custom property is Struct or StructArray.

toBuilder

public CustomProperty.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CustomProperty.Builder,CustomProperty>

builder

public static CustomProperty.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo