Class EnableEnhancedMonitoringResponse

    • Method Detail

      • streamName

        public final String streamName()

        The name of the Kinesis data stream.

        Returns:
        The name of the Kinesis data stream.
      • currentShardLevelMetrics

        public final List<MetricsName> currentShardLevelMetrics()

        Represents the current state of the metrics that are in the enhanced state before the operation.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasCurrentShardLevelMetrics() method.

        Returns:
        Represents the current state of the metrics that are in the enhanced state before the operation.
      • hasCurrentShardLevelMetrics

        public final boolean hasCurrentShardLevelMetrics()
        For responses, this returns true if the service returned a value for the CurrentShardLevelMetrics property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • currentShardLevelMetricsAsStrings

        public final List<String> currentShardLevelMetricsAsStrings()

        Represents the current state of the metrics that are in the enhanced state before the operation.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasCurrentShardLevelMetrics() method.

        Returns:
        Represents the current state of the metrics that are in the enhanced state before the operation.
      • desiredShardLevelMetrics

        public final List<MetricsName> desiredShardLevelMetrics()

        Represents the list of all the metrics that would be in the enhanced state after the operation.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDesiredShardLevelMetrics() method.

        Returns:
        Represents the list of all the metrics that would be in the enhanced state after the operation.
      • hasDesiredShardLevelMetrics

        public final boolean hasDesiredShardLevelMetrics()
        For responses, this returns true if the service returned a value for the DesiredShardLevelMetrics property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • desiredShardLevelMetricsAsStrings

        public final List<String> desiredShardLevelMetricsAsStrings()

        Represents the list of all the metrics that would be in the enhanced state after the operation.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDesiredShardLevelMetrics() method.

        Returns:
        Represents the list of all the metrics that would be in the enhanced state after the operation.
      • streamARN

        public final String streamARN()

        The ARN of the stream.

        Returns:
        The ARN of the stream.
      • 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