Class CreateRuleResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.rbin.model.RbinResponse
software.amazon.awssdk.services.rbin.model.CreateRuleResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateRuleResponse.Builder,CreateRuleResponse>
@Generated("software.amazon.awssdk:codegen") public final class CreateRuleResponse extends RbinResponse implements ToCopyableBuilder<CreateRuleResponse.Builder,CreateRuleResponse>

  • Method Details

    • identifier

      public final String identifier()

      The unique ID of the retention rule.

      Returns:
      The unique ID of the retention rule.

    • retentionPeriod

      public final RetentionPeriod retentionPeriod()
      Returns the value of the RetentionPeriod property for this object.
      Returns:
      The value of the RetentionPeriod property for this object.

    • description

      public final String description()

      The retention rule description.

      Returns:
      The retention rule description.

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

      Information about the tags assigned to the retention 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 hasTags() method.

      Returns:
      Information about the tags assigned to the retention rule.

    • resourceType

      public final ResourceType resourceType()

      The resource type retained by the retention rule.

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

      Returns:
      The resource type retained by the retention rule.
      See Also:

    • resourceTypeAsString

      public final String resourceTypeAsString()

      The resource type retained by the retention rule.

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

      Returns:
      The resource type retained by the retention rule.
      See Also:

    • hasResourceTags

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

    • resourceTags

      public final List<ResourceTag> resourceTags()

      Information about the resource tags used to identify resources that are retained by the retention 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 hasResourceTags() method.

      Returns:
      Information about the resource tags used to identify resources that are retained by the retention rule.

    • status

      public final RuleStatus status()

      The state of the retention rule. Only retention rules that are in the available state retain resources.

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

      Returns:
      The state of the retention rule. Only retention rules that are in the available state retain resources.
      See Also:

    • statusAsString

      public final String statusAsString()

      The state of the retention rule. Only retention rules that are in the available state retain resources.

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

      Returns:
      The state of the retention rule. Only retention rules that are in the available state retain resources.
      See Also:

    • lockConfiguration

      public final LockConfiguration lockConfiguration()

      Information about the retention rule lock configuration.

      Returns:
      Information about the retention rule lock configuration.

    • lockState

      public final LockState lockState()

      The lock state for the retention rule.

      • locked - The retention rule is locked and can't be modified or deleted.

      • pending_unlock - The retention rule has been unlocked but it is still within the unlock delay period. The retention rule can be modified or deleted only after the unlock delay period has expired.

      • unlocked - The retention rule is unlocked and it can be modified or deleted by any user with the required permissions.

      • null - The retention rule has never been locked. Once a retention rule has been locked, it can transition between the locked and unlocked states only; it can never transition back to null.

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

      Returns:
      The lock state for the retention rule.

      • locked - The retention rule is locked and can't be modified or deleted.

      • pending_unlock - The retention rule has been unlocked but it is still within the unlock delay period. The retention rule can be modified or deleted only after the unlock delay period has expired.

      • unlocked - The retention rule is unlocked and it can be modified or deleted by any user with the required permissions.

      • null - The retention rule has never been locked. Once a retention rule has been locked, it can transition between the locked and unlocked states only; it can never transition back to null.

      See Also:

    • lockStateAsString

      public final String lockStateAsString()

      The lock state for the retention rule.

      • locked - The retention rule is locked and can't be modified or deleted.

      • pending_unlock - The retention rule has been unlocked but it is still within the unlock delay period. The retention rule can be modified or deleted only after the unlock delay period has expired.

      • unlocked - The retention rule is unlocked and it can be modified or deleted by any user with the required permissions.

      • null - The retention rule has never been locked. Once a retention rule has been locked, it can transition between the locked and unlocked states only; it can never transition back to null.

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

      Returns:
      The lock state for the retention rule.

      • locked - The retention rule is locked and can't be modified or deleted.

      • pending_unlock - The retention rule has been unlocked but it is still within the unlock delay period. The retention rule can be modified or deleted only after the unlock delay period has expired.

      • unlocked - The retention rule is unlocked and it can be modified or deleted by any user with the required permissions.

      • null - The retention rule has never been locked. Once a retention rule has been locked, it can transition between the locked and unlocked states only; it can never transition back to null.

      See Also:

    • ruleArn

      public final String ruleArn()

      The Amazon Resource Name (ARN) of the retention rule.

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

    • toBuilder

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

    • builder

      public static CreateRuleResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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 SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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.