Class GatewayCapabilitySummary
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<GatewayCapabilitySummary.Builder,
GatewayCapabilitySummary>
Contains a summary of a gateway capability configuration.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
The namespace of the capability configuration.final CapabilitySyncStatus
The synchronization status of the capability configuration.final String
The synchronization status of the capability configuration.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
static Class
<? extends GatewayCapabilitySummary.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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
, whereversion
is a number such as1
.- 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
, whereversion
is a number such as1
.
-
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. -
OUT_OF_SYNC
– The gateway hasn't received the capability configuration. -
SYNC_FAILED
– The gateway rejected the capability configuration.
If the service returns an enum value that is not available in the current SDK version,
capabilitySyncStatus
will returnCapabilitySyncStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcapabilitySyncStatusAsString()
.- 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. -
OUT_OF_SYNC
– The gateway hasn't received the capability configuration. -
SYNC_FAILED
– The gateway rejected the capability configuration.
-
- See Also:
-
-
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. -
OUT_OF_SYNC
– The gateway hasn't received the capability configuration. -
SYNC_FAILED
– The gateway rejected the capability configuration.
If the service returns an enum value that is not available in the current SDK version,
capabilitySyncStatus
will returnCapabilitySyncStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcapabilitySyncStatusAsString()
.- 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. -
OUT_OF_SYNC
– The gateway hasn't received the capability configuration. -
SYNC_FAILED
– The gateway rejected the capability configuration.
-
- 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<GatewayCapabilitySummary.Builder,
GatewayCapabilitySummary> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
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
-
sdkFields
-