Class DescribePoliciesRequest

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

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

    • autoScalingGroupName

      public final String autoScalingGroupName()

      The name of the Auto Scaling group.

      Returns:
      The name of the Auto Scaling group.
    • hasPolicyNames

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

      public final List<String> policyNames()

      The names of one or more policies. If you omit this property, all policies are described. If a group name is provided, the results are limited to that group. If you specify an unknown policy name, it is ignored with no error.

      Array Members: Maximum number of 50 items.

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

      Returns:
      The names of one or more policies. If you omit this property, all policies are described. If a group name is provided, the results are limited to that group. If you specify an unknown policy name, it is ignored with no error.

      Array Members: Maximum number of 50 items.

    • hasPolicyTypes

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

      public final List<String> policyTypes()

      One or more policy types. The valid values are SimpleScaling, StepScaling, TargetTrackingScaling, and PredictiveScaling.

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

      Returns:
      One or more policy types. The valid values are SimpleScaling, StepScaling, TargetTrackingScaling, and PredictiveScaling.
    • nextToken

      public final String nextToken()

      The token for the next set of items to return. (You received this token from a previous call.)

      Returns:
      The token for the next set of items to return. (You received this token from a previous call.)
    • maxRecords

      public final Integer maxRecords()

      The maximum number of items to be returned with each call. The default value is 50 and the maximum value is 100.

      Returns:
      The maximum number of items to be returned with each call. The default value is 50 and the maximum value is 100.
    • toBuilder

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

      public static DescribePoliciesRequest.Builder builder()
    • serializableBuilderClass

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