Class MetricValue

    • Method Detail

      • count

        public final Long count()

        If the comparisonOperator calls for a numeric value, use this to specify that numeric value to be compared with the metric.

        Returns:
        If the comparisonOperator calls for a numeric value, use this to specify that numeric value to be compared with the metric.
      • hasCidrs

        public final boolean hasCidrs()
        For responses, this returns true if the service returned a value for the Cidrs 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.
      • cidrs

        public final List<String> cidrs()

        If the comparisonOperator calls for a set of CIDRs, use this to specify that set to be compared with the metric.

        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 hasCidrs() method.

        Returns:
        If the comparisonOperator calls for a set of CIDRs, use this to specify that set to be compared with the metric.
      • hasPorts

        public final boolean hasPorts()
        For responses, this returns true if the service returned a value for the Ports 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.
      • ports

        public final List<Integer> ports()

        If the comparisonOperator calls for a set of ports, use this to specify that set to be compared with the metric.

        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 hasPorts() method.

        Returns:
        If the comparisonOperator calls for a set of ports, use this to specify that set to be compared with the metric.
      • number

        public final Double number()

        The numeral value of a metric.

        Returns:
        The numeral value of a metric.
      • hasNumbers

        public final boolean hasNumbers()
        For responses, this returns true if the service returned a value for the Numbers 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.
      • numbers

        public final List<Double> numbers()

        The numeral values of a metric.

        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 hasNumbers() method.

        Returns:
        The numeral values of a metric.
      • hasStrings

        public final boolean hasStrings()
        For responses, this returns true if the service returned a value for the Strings 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.
      • strings

        public final List<String> strings()

        The string values of a metric.

        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 hasStrings() method.

        Returns:
        The string values of a metric.
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • 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)