Interface DescribeGatewayCapabilityConfigurationResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, CopyableBuilder<DescribeGatewayCapabilityConfigurationResponse.Builder,DescribeGatewayCapabilityConfigurationResponse>, IoTSiteWiseResponse.Builder, SdkBuilder<DescribeGatewayCapabilityConfigurationResponse.Builder,DescribeGatewayCapabilityConfigurationResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
DescribeGatewayCapabilityConfigurationResponse
@Mutable @NotThreadSafe public static interface DescribeGatewayCapabilityConfigurationResponse.Builder extends IoTSiteWiseResponse.Builder, SdkPojo, CopyableBuilder<DescribeGatewayCapabilityConfigurationResponse.Builder,DescribeGatewayCapabilityConfigurationResponse>

  • Method Details

    • gatewayId

      DescribeGatewayCapabilityConfigurationResponse.Builder gatewayId(String gatewayId)

      The ID of the gateway that defines the capability configuration.

      Parameters:
      gatewayId - The ID of the gateway that defines the capability configuration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • capabilityNamespace

      DescribeGatewayCapabilityConfigurationResponse.Builder capabilityNamespace(String capabilityNamespace)

      The namespace of the gateway capability.

      Parameters:
      capabilityNamespace - The namespace of the gateway capability.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • capabilityConfiguration

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

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • capabilitySyncStatus

      DescribeGatewayCapabilityConfigurationResponse.Builder capabilitySyncStatus(String capabilitySyncStatus)

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

      • IN_SYNC - The gateway is running with the latest configuration.

      • OUT_OF_SYNC - The gateway hasn't received the latest configuration.

      • SYNC_FAILED - The gateway rejected the latest configuration.

      • UNKNOWN - The gateway hasn't reported its sync status.

      • NOT_APPLICABLE - The gateway doesn't support this capability. This is most common when integrating partner data sources, because the data integration is handled externally by the partner.

      Parameters:
      capabilitySyncStatus - The synchronization status of the gateway capability configuration. The sync status can be one of the following:

      • IN_SYNC - The gateway is running with the latest configuration.

      • OUT_OF_SYNC - The gateway hasn't received the latest configuration.

      • SYNC_FAILED - The gateway rejected the latest configuration.

      • UNKNOWN - The gateway hasn't reported its sync status.

      • NOT_APPLICABLE - The gateway doesn't support this capability. This is most common when integrating partner data sources, because the data integration is handled externally by the partner.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • capabilitySyncStatus

      DescribeGatewayCapabilityConfigurationResponse.Builder capabilitySyncStatus(CapabilitySyncStatus capabilitySyncStatus)

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

      • IN_SYNC - The gateway is running with the latest configuration.

      • OUT_OF_SYNC - The gateway hasn't received the latest configuration.

      • SYNC_FAILED - The gateway rejected the latest configuration.

      • UNKNOWN - The gateway hasn't reported its sync status.

      • NOT_APPLICABLE - The gateway doesn't support this capability. This is most common when integrating partner data sources, because the data integration is handled externally by the partner.

      Parameters:
      capabilitySyncStatus - The synchronization status of the gateway capability configuration. The sync status can be one of the following:

      • IN_SYNC - The gateway is running with the latest configuration.

      • OUT_OF_SYNC - The gateway hasn't received the latest configuration.

      • SYNC_FAILED - The gateway rejected the latest configuration.

      • UNKNOWN - The gateway hasn't reported its sync status.

      • NOT_APPLICABLE - The gateway doesn't support this capability. This is most common when integrating partner data sources, because the data integration is handled externally by the partner.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: