Class RuleSummary

java.lang.Object
software.amazon.awssdk.services.connect.model.RuleSummary
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<RuleSummary.Builder,RuleSummary>
@Generated("software.amazon.awssdk:codegen") public final class RuleSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<RuleSummary.Builder,RuleSummary>

A list of ActionTypes associated with a rule.

See Also:

  • Method Details

    • name

      public final String name()

      The name of the rule.

      Returns:
      The name of the rule.

    • ruleId

      public final String ruleId()

      A unique identifier for the rule.

      Returns:
      A unique identifier for the rule.

    • ruleArn

      public final String ruleArn()

      The Amazon Resource Name (ARN) of the rule.

      Returns:
      The Amazon Resource Name (ARN) of the rule.

    • eventSourceName

      public final EventSourceName eventSourceName()

      The name of the event source.

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

      Returns:
      The name of the event source.
      See Also:

    • eventSourceNameAsString

      public final String eventSourceNameAsString()

      The name of the event source.

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

      Returns:
      The name of the event source.
      See Also:

    • publishStatus

      public final RulePublishStatus publishStatus()

      The publish status of the rule.

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

      Returns:
      The publish status of the rule.
      See Also:

    • publishStatusAsString

      public final String publishStatusAsString()

      The publish status of the rule.

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

      Returns:
      The publish status of the rule.
      See Also:

    • hasActionSummaries

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

    • actionSummaries

      public final List<ActionSummary> actionSummaries()

      A list of ActionTypes associated with a rule.

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

      Returns:
      A list of ActionTypes associated with a rule.

    • createdTime

      public final Instant createdTime()

      The timestamp for when the rule was created.

      Returns:
      The timestamp for when the rule was created.

    • lastUpdatedTime

      public final Instant lastUpdatedTime()

      The timestamp for when the rule was last updated.

      Returns:
      The timestamp for when the rule was last updated.

    • toBuilder

      public RuleSummary.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<RuleSummary.Builder,RuleSummary>
      Returns:
      a builder for type T

    • builder

      public static RuleSummary.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)

    • 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.