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

Class DescribeGatewayCapabilityConfigurationResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.iotsitewise.model.IoTSiteWiseResponse

software.amazon.awssdk.services.iotsitewise.model.DescribeGatewayCapabilityConfigurationResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeGatewayCapabilityConfigurationResponse.Builder,DescribeGatewayCapabilityConfigurationResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeGatewayCapabilityConfigurationResponse.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeGatewayCapabilityConfigurationResponse.Builder	builder()
String	capabilityConfiguration()	The JSON document that defines the gateway capability's configuration.
String	capabilityNamespace()	The namespace of the gateway capability.
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)
String	gatewayId()	The ID of the gateway that defines the capability configuration.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeGatewayCapabilityConfigurationResponse.Builder>	serializableBuilderClass()
DescribeGatewayCapabilityConfigurationResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.iotsitewise.model.IoTSiteWiseResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

gatewayId

public final String gatewayId()

The ID of the gateway that defines the capability configuration.

Returns:

The ID of the gateway that defines the capability configuration.

capabilityNamespace

public final String capabilityNamespace()

The namespace of the gateway capability.

Returns:

The namespace of the gateway capability.

capabilityConfiguration

public final String capabilityConfiguration()

The JSON document that defines the gateway capability's configuration. For more information, see Configuring data sources (CLI) in the IoT SiteWise User Guide.

Returns:

The JSON document that defines the gateway capability's configuration. For more information, see Configuring data sources (CLI) in the IoT SiteWise User Guide.

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 DescribeGatewayCapabilityConfigurationResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeGatewayCapabilityConfigurationResponse.Builder,DescribeGatewayCapabilityConfigurationResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static DescribeGatewayCapabilityConfigurationResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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 SdkResponse

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