Class GetLifecyclePoliciesRequest

All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetLifecyclePoliciesRequest.Builder,GetLifecyclePoliciesRequest>

@Generated("software.amazon.awssdk:codegen") public final class GetLifecyclePoliciesRequest extends DlmRequest implements ToCopyableBuilder<GetLifecyclePoliciesRequest.Builder,GetLifecyclePoliciesRequest>
  • Method Details

    • hasPolicyIds

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

      public final List<String> policyIds()

      The identifiers of the data lifecycle policies.

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

      Returns:
      The identifiers of the data lifecycle policies.
    • state

      public final GettablePolicyStateValues state()

      The activation state.

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

      Returns:
      The activation state.
      See Also:
    • stateAsString

      public final String stateAsString()

      The activation state.

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

      Returns:
      The activation state.
      See Also:
    • resourceTypes

      public final List<ResourceTypeValues> resourceTypes()

      The resource type.

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

      Returns:
      The resource type.
    • hasResourceTypes

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

      public final List<String> resourceTypesAsStrings()

      The resource type.

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

      Returns:
      The resource type.
    • hasTargetTags

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

      public final List<String> targetTags()

      The target tag for a policy.

      Tags are strings in the format key=value.

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

      Returns:
      The target tag for a policy.

      Tags are strings in the format key=value.

    • hasTagsToAdd

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

      public final List<String> tagsToAdd()

      The tags to add to objects created by the policy.

      Tags are strings in the format key=value.

      These user-defined tags are added in addition to the Amazon Web Services-added lifecycle tags.

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

      Returns:
      The tags to add to objects created by the policy.

      Tags are strings in the format key=value.

      These user-defined tags are added in addition to the Amazon Web Services-added lifecycle tags.

    • defaultPolicyType

      public final DefaultPoliciesTypeValues defaultPolicyType()

      [Default policies only] Specifies the type of default policy to get. Specify one of the following:

      • VOLUME - To get only the default policy for EBS snapshots

      • INSTANCE - To get only the default policy for EBS-backed AMIs

      • ALL - To get all default policies

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

      Returns:
      [Default policies only] Specifies the type of default policy to get. Specify one of the following:

      • VOLUME - To get only the default policy for EBS snapshots

      • INSTANCE - To get only the default policy for EBS-backed AMIs

      • ALL - To get all default policies

      See Also:
    • defaultPolicyTypeAsString

      public final String defaultPolicyTypeAsString()

      [Default policies only] Specifies the type of default policy to get. Specify one of the following:

      • VOLUME - To get only the default policy for EBS snapshots

      • INSTANCE - To get only the default policy for EBS-backed AMIs

      • ALL - To get all default policies

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

      Returns:
      [Default policies only] Specifies the type of default policy to get. Specify one of the following:

      • VOLUME - To get only the default policy for EBS snapshots

      • INSTANCE - To get only the default policy for EBS-backed AMIs

      • ALL - To get all default policies

      See Also:
    • 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<GetLifecyclePoliciesRequest.Builder,GetLifecyclePoliciesRequest>
      Specified by:
      toBuilder in class DlmRequest
      Returns:
      a builder for type T
    • builder

      public static GetLifecyclePoliciesRequest.Builder builder()
    • serializableBuilderClass

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