Class CreateDlpSettingRequest

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

  • Method Details

    • awsAccountId

      public final String awsAccountId()

      The ID of the Amazon Web Services account in which to create the DLP setting.

      Returns:
      The ID of the Amazon Web Services account in which to create the DLP setting.

    • dlpSettingId

      public final String dlpSettingId()

      A unique identifier for the DLP setting.

      Returns:
      A unique identifier for the DLP setting.

    • name

      public final String name()

      A human-readable display name for the DLP setting.

      Returns:
      A human-readable display name for the DLP setting.

    • providerType

      public final DlpProviderType providerType()

      The type of external DLP provider to use for sensitivity label classification. Currently, the only supported value is MICROSOFT_PURVIEW.

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

      Returns:
      The type of external DLP provider to use for sensitivity label classification. Currently, the only supported value is MICROSOFT_PURVIEW.
      See Also:

    • providerTypeAsString

      public final String providerTypeAsString()

      The type of external DLP provider to use for sensitivity label classification. Currently, the only supported value is MICROSOFT_PURVIEW.

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

      Returns:
      The type of external DLP provider to use for sensitivity label classification. Currently, the only supported value is MICROSOFT_PURVIEW.
      See Also:

    • providerConfig

      public final ProviderConfig providerConfig()

      The provider-specific configuration for the DLP integration. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

      Returns:
      The provider-specific configuration for the DLP integration. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

    • providerOutageAction

      public final DlpAction providerOutageAction()

      The behavior to apply when the DLP provider is unreachable. Valid values are ALLOW, WARN, and BLOCK.

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

      Returns:
      The behavior to apply when the DLP provider is unreachable. Valid values are ALLOW, WARN, and BLOCK.
      See Also:

    • providerOutageActionAsString

      public final String providerOutageActionAsString()

      The behavior to apply when the DLP provider is unreachable. Valid values are ALLOW, WARN, and BLOCK.

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

      Returns:
      The behavior to apply when the DLP provider is unreachable. Valid values are ALLOW, WARN, and BLOCK.
      See Also:

    • enabled

      public final Boolean enabled()

      Specifies whether DLP enforcement is active for this setting. Set to true to enable enforcement, or false to disable it at time of setting creation.

      Returns:
      Specifies whether DLP enforcement is active for this setting. Set to true to enable enforcement, or false to disable it at time of setting creation.

    • hasTags

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

    • tags

      public final List<Tag> tags()

      A list of resource tags to apply to the DLP setting. You can use tags to manage access to your Amazon Web Services resources.

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

      Returns:
      A list of resource tags to apply to the DLP setting. You can use tags to manage access to your Amazon Web Services resources.

    • toBuilder

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

    • builder

      public static CreateDlpSettingRequest.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.