Class DescribeAccountPoliciesRequest

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

  • Method Details

    • policyType

      public final PolicyType policyType()

      Use this parameter to limit the returned policies to only the policies that match the policy type that you specify.

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

      Returns:
      Use this parameter to limit the returned policies to only the policies that match the policy type that you specify.
      See Also:

    • policyTypeAsString

      public final String policyTypeAsString()

      Use this parameter to limit the returned policies to only the policies that match the policy type that you specify.

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

      Returns:
      Use this parameter to limit the returned policies to only the policies that match the policy type that you specify.
      See Also:

    • policyName

      public final String policyName()

      Use this parameter to limit the returned policies to only the policy with the name that you specify.

      Returns:
      Use this parameter to limit the returned policies to only the policy with the name that you specify.

    • hasAccountIdentifiers

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

    • accountIdentifiers

      public final List<String> accountIdentifiers()

      If you are using an account that is set up as a monitoring account for CloudWatch unified cross-account observability, you can use this to specify the account ID of a source account. If you do, the operation returns the account policy for the specified account. Currently, you can specify only one account ID in this parameter.

      If you omit this parameter, only the policy in the current account is returned.

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

      Returns:
      If you are using an account that is set up as a monitoring account for CloudWatch unified cross-account observability, you can use this to specify the account ID of a source account. If you do, the operation returns the account policy for the specified account. Currently, you can specify only one account ID in this parameter.

      If you omit this parameter, only the policy in the current account is returned.

    • toBuilder

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

    • builder

      public static DescribeAccountPoliciesRequest.Builder builder()

    • serializableBuilderClass

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