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

Class GatewayCapabilitySummary

java.lang.Object

software.amazon.awssdk.services.iotsitewise.model.GatewayCapabilitySummary

All Implemented Interfaces:

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

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

Contains a summary of a gateway capability configuration.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GatewayCapabilitySummary.Builder

Method Summary

Modifier and Type	Method	Description
static GatewayCapabilitySummary.Builder	builder()
String	capabilityNamespace()	The namespace of the capability configuration.
CapabilitySyncStatus	capabilitySyncStatus()	The synchronization status of the capability configuration.
String	capabilitySyncStatusAsString()	The synchronization status of the capability configuration.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends GatewayCapabilitySummary.Builder>	serializableBuilderClass()
GatewayCapabilitySummary.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

capabilityNamespace

public final String capabilityNamespace()

The namespace of the capability configuration. For example, if you configure OPC-UA sources from the IoT SiteWise console, your OPC-UA capability configuration has the namespace iotsitewise:opcuacollector:version, where version is a number such as 1.

Returns:

The namespace of the capability configuration. For example, if you configure OPC-UA sources from the IoT SiteWise console, your OPC-UA capability configuration has the namespace iotsitewise:opcuacollector:version, where version is a number such as 1.

capabilitySyncStatus

public final CapabilitySyncStatus capabilitySyncStatus()

The synchronization status of the capability configuration. The sync status can be one of the following:

• IN_SYNC – The gateway is running the capability configuration.

• NOT_APPLICABLE – Synchronization is not required for this capability configuration. This is most common when integrating partner data sources, because the data integration is handled externally by the partner.

• OUT_OF_SYNC – The gateway hasn't received the capability configuration.

• SYNC_FAILED – The gateway rejected the capability configuration.

• UNKNOWN – The synchronization status is currently unknown due to an undetermined or temporary error.

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

Returns:

The synchronization status of the capability configuration. The sync status can be one of the following:

• IN_SYNC – The gateway is running the capability configuration.

• NOT_APPLICABLE – Synchronization is not required for this capability configuration. This is most common when integrating partner data sources, because the data integration is handled externally by the partner.

• OUT_OF_SYNC – The gateway hasn't received the capability configuration.

• SYNC_FAILED – The gateway rejected the capability configuration.

• UNKNOWN – The synchronization status is currently unknown due to an undetermined or temporary error.

See Also:

CapabilitySyncStatus

capabilitySyncStatusAsString

public final String capabilitySyncStatusAsString()

The synchronization status of the capability configuration. The sync status can be one of the following:

• IN_SYNC – The gateway is running the capability configuration.

• NOT_APPLICABLE – Synchronization is not required for this capability configuration. This is most common when integrating partner data sources, because the data integration is handled externally by the partner.

• OUT_OF_SYNC – The gateway hasn't received the capability configuration.

• SYNC_FAILED – The gateway rejected the capability configuration.

• UNKNOWN – The synchronization status is currently unknown due to an undetermined or temporary error.

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

Returns:

The synchronization status of the capability configuration. The sync status can be one of the following:

• IN_SYNC – The gateway is running the capability configuration.

• NOT_APPLICABLE – Synchronization is not required for this capability configuration. This is most common when integrating partner data sources, because the data integration is handled externally by the partner.

• OUT_OF_SYNC – The gateway hasn't received the capability configuration.

• SYNC_FAILED – The gateway rejected the capability configuration.

• UNKNOWN – The synchronization status is currently unknown due to an undetermined or temporary error.

See Also:

CapabilitySyncStatus

toBuilder

public GatewayCapabilitySummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GatewayCapabilitySummary.Builder,GatewayCapabilitySummary>

builder

public static GatewayCapabilitySummary.Builder builder()

serializableBuilderClass

public static Class<? extends GatewayCapabilitySummary.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