Class ApprovalPolicy

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

A governance approval policy that specifies which principals and governed actions require approval, and which assets the policy applies to.

See Also:

  • Method Details

    • policyId

      public final String policyId()

      The unique identifier of the approval policy.

      Returns:
      The unique identifier of the approval policy.

    • policyArn

      public final String policyArn()

      The Amazon Resource Name (ARN) of the approval policy.

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

    • name

      public final String name()

      The name of the approval policy.

      Returns:
      The name of the approval policy.

    • description

      public final String description()

      A description of the approval policy.

      Returns:
      A description of the approval policy.

    • actions

      public final List<GovernedAction> actions()

      The list of governed actions that trigger the approval workflow.

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

      Returns:
      The list of governed actions that trigger the approval workflow.

    • hasActions

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

    • actionsAsStrings

      public final List<String> actionsAsStrings()

      The list of governed actions that trigger the approval workflow.

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

      Returns:
      The list of governed actions that trigger the approval workflow.

    • assetTypes

      public final List<AssetType> assetTypes()

      The list of asset types that the approval policy applies to.

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

      Returns:
      The list of asset types that the approval policy applies to.

    • hasAssetTypes

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

    • assetTypesAsStrings

      public final List<String> assetTypesAsStrings()

      The list of asset types that the approval policy applies to.

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

      Returns:
      The list of asset types that the approval policy applies to.

    • applicableTo

      public final ApplicableTo applicableTo()

      The scoping configuration that determines who the approval policy applies to.

      Returns:
      The scoping configuration that determines who the approval policy applies to.

    • hasApprovalGroups

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

    • approvalGroups

      public final List<String> approvalGroups()

      The list of group ARNs whose members can approve requests.

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

      Returns:
      The list of group ARNs whose members can approve requests.

    • createdAt

      public final Instant createdAt()

      The date and time that the approval policy was created.

      Returns:
      The date and time that the approval policy was created.

    • updatedAt

      public final Instant updatedAt()

      The date and time that the approval policy was last updated.

      Returns:
      The date and time that the approval policy was last updated.

    • toBuilder

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

    • builder

      public static ApprovalPolicy.Builder builder()

    • serializableBuilderClass

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