Class CreateFleetMetricRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.iot.model.IotRequest
software.amazon.awssdk.services.iot.model.CreateFleetMetricRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateFleetMetricRequest.Builder,CreateFleetMetricRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateFleetMetricRequest extends IotRequest implements ToCopyableBuilder<CreateFleetMetricRequest.Builder,CreateFleetMetricRequest>

  • Method Details

    • metricName

      public final String metricName()

      The name of the fleet metric to create.

      Returns:
      The name of the fleet metric to create.

    • queryString

      public final String queryString()

      The search query string.

      Returns:
      The search query string.

    • aggregationType

      public final AggregationType aggregationType()

      The type of the aggregation query.

      Returns:
      The type of the aggregation query.

    • period

      public final Integer period()

      The time in seconds between fleet metric emissions. Range [60(1 min), 86400(1 day)] and must be multiple of 60.

      Returns:
      The time in seconds between fleet metric emissions. Range [60(1 min), 86400(1 day)] and must be multiple of 60.

    • aggregationField

      public final String aggregationField()

      The field to aggregate.

      Returns:
      The field to aggregate.

    • description

      public final String description()

      The fleet metric description.

      Returns:
      The fleet metric description.

    • queryVersion

      public final String queryVersion()

      The query version.

      Returns:
      The query version.

    • indexName

      public final String indexName()

      The name of the index to search.

      Returns:
      The name of the index to search.

    • unit

      public final FleetMetricUnit unit()

      Used to support unit transformation such as milliseconds to seconds. The unit must be supported by CW metric. Default to null.

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

      Returns:
      Used to support unit transformation such as milliseconds to seconds. The unit must be supported by CW metric. Default to null.
      See Also:

    • unitAsString

      public final String unitAsString()

      Used to support unit transformation such as milliseconds to seconds. The unit must be supported by CW metric. Default to null.

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

      Returns:
      Used to support unit transformation such as milliseconds to seconds. The unit must be supported by CW metric. Default to null.
      See Also:

    • 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, which can be used to manage the fleet 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, which can be used to manage the fleet metric.

    • toBuilder

      public CreateFleetMetricRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CreateFleetMetricRequest.Builder,CreateFleetMetricRequest>
      Specified by:
      toBuilder in class IotRequest
      Returns:
      a builder for type T

    • builder

      public static CreateFleetMetricRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.