Class ListTelemetryFieldsRequest

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

  • Method Details

    • dataSetName

      public final String dataSetName()

      The name of the dataset to list fields for.

      Returns:
      The name of the dataset to list fields for.

    • telemetryType

      public final TelemetryType telemetryType()

      The type of telemetry to filter fields by.

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

      Returns:
      The type of telemetry to filter fields by.
      See Also:

    • telemetryTypeAsString

      public final String telemetryTypeAsString()

      The type of telemetry to filter fields by.

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

      Returns:
      The type of telemetry to filter fields by.
      See Also:

    • startTime

      public final Instant startTime()

      Inclusive start of the lookback window. When omitted, the service defaults to the configured lookback before endTime.

      Returns:
      Inclusive start of the lookback window. When omitted, the service defaults to the configured lookback before endTime.

    • endTime

      public final Instant endTime()

      Inclusive end of the lookback window. When omitted, the service defaults to the current time.

      Returns:
      Inclusive end of the lookback window. When omitted, the service defaults to the current time.

    • nextToken

      public final String nextToken()

      A token to retrieve the next page of results. Reserved for future pagination; the service does not paginate at this time and returns null.

      Returns:
      A token to retrieve the next page of results. Reserved for future pagination; the service does not paginate at this time and returns null.

    • toBuilder

      public ListTelemetryFieldsRequest.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<ListTelemetryFieldsRequest.Builder,ListTelemetryFieldsRequest>
      Specified by:
      toBuilder in class CloudWatchOmniRequest
      Returns:
      a builder for type T

    • builder

      public static ListTelemetryFieldsRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ListTelemetryFieldsRequest.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.