Package software.amazon.awssdk.services.iot.model

Class CreateCustomMetricRequest

    • Method Detail

      • metricName

        public final String metricName()

        The name of the custom metric. This will be used in the metric report submitted from the device/thing. The name can't begin with aws:. You can't change the name after you define it.

        Returns:
        The name of the custom metric. This will be used in the metric report submitted from the device/thing. The name can't begin with aws:. You can't change the name after you define it.

      • displayName

        public final String displayName()

        The friendly name in the console for the custom metric. This name doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. You can update the friendly name after you define it.

        Returns:
        The friendly name in the console for the custom metric. This name doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. You can update the friendly name after you define it.

      • metricType

        public final CustomMetricType metricType()

        The type of the custom metric.

        The type number only takes a single metric value as an input, but when you submit the metrics value in the DeviceMetrics report, you must pass it as an array with a single value.

        If the service returns an enum value that is not available in the current SDK version, metricType will return CustomMetricType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from metricTypeAsString().

        Returns:
        The type of the custom metric.

        The type number only takes a single metric value as an input, but when you submit the metrics value in the DeviceMetrics report, you must pass it as an array with a single value.

        See Also:
        CustomMetricType

      • metricTypeAsString

        public final String metricTypeAsString()

        The type of the custom metric.

        The type number only takes a single metric value as an input, but when you submit the metrics value in the DeviceMetrics report, you must pass it as an array with a single value.

        If the service returns an enum value that is not available in the current SDK version, metricType will return CustomMetricType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from metricTypeAsString().

        Returns:
        The type of the custom metric.

        The type number only takes a single metric value as an input, but when you submit the metrics value in the DeviceMetrics report, you must pass it as an array with a single value.

        See Also:
        CustomMetricType

      • hasTags

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

      • tags

        public final List<Tag> tags()

        Metadata that can be used to manage the custom 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 hasTags() method.

        Returns:
        Metadata that can be used to manage the custom metric.

      • clientRequestToken

        public final String clientRequestToken()

        Each custom metric must have a unique client request token. If you try to create a new custom metric that already exists with a different token, an exception occurs. If you omit this value, Amazon Web Services SDKs will automatically generate a unique client request.

        Returns:
        Each custom metric must have a unique client request token. If you try to create a new custom metric that already exists with a different token, an exception occurs. If you omit this value, Amazon Web Services SDKs will automatically generate a unique client request.

      • 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