Class MicrosoftPurviewProviderConfig

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

The full configuration for Microsoft Purview DLP integration, including the provider credentials and the label-action mappings that define the enforcement policy.

See Also:

  • Method Details

    • credentials

      public final MicrosoftPurviewCredentials credentials()

      The credentials used to authenticate with Microsoft Purview.

      Returns:
      The credentials used to authenticate with Microsoft Purview.

    • hasLabelActionMappings

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

    • labelActionMappings

      public final List<LabelActionMapping> labelActionMappings()

      The mappings from Microsoft Purview sensitivity labels to enforcement actions.

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

      Returns:
      The mappings from Microsoft Purview sensitivity labels to enforcement actions.

    • unmappedAction

      public final DlpAction unmappedAction()

      The default action to apply to content that has no sensitivity label or whose label is not mapped. Valid values are ALLOW, BLOCK, and WARN.

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

      Returns:
      The default action to apply to content that has no sensitivity label or whose label is not mapped. Valid values are ALLOW, BLOCK, and WARN.
      See Also:

    • unmappedActionAsString

      public final String unmappedActionAsString()

      The default action to apply to content that has no sensitivity label or whose label is not mapped. Valid values are ALLOW, BLOCK, and WARN.

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

      Returns:
      The default action to apply to content that has no sensitivity label or whose label is not mapped. Valid values are ALLOW, BLOCK, and WARN.
      See Also:

    • toBuilder

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

    • builder

      public static MicrosoftPurviewProviderConfig.Builder builder()

    • serializableBuilderClass

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