Package software.amazon.awssdk.services.kendra.model

Class CreateAccessControlConfigurationRequest

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

  • Method Details

    • indexId

      public final String indexId()

      The identifier of the index to create an access control configuration for your documents.

      Returns:
      The identifier of the index to create an access control configuration for your documents.

    • name

      public final String name()

      A name for the access control configuration.

      Returns:
      A name for the access control configuration.

    • description

      public final String description()

      A description for the access control configuration.

      Returns:
      A description for the access control configuration.

    • hasAccessControlList

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

    • accessControlList

      public final List<Principal> accessControlList()

      Information on principals (users and/or groups) and which documents they should have access to. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

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

      Returns:
      Information on principals (users and/or groups) and which documents they should have access to. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

    • hasHierarchicalAccessControlList

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

    • hierarchicalAccessControlList

      public final List<HierarchicalPrincipal> hierarchicalAccessControlList()

      The list of principal lists that define the hierarchy for which documents users should have access 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 hasHierarchicalAccessControlList() method.

      Returns:
      The list of principal lists that define the hierarchy for which documents users should have access to.

    • clientToken

      public final String clientToken()

      A token that you provide to identify the request to create an access control configuration. Multiple calls to the CreateAccessControlConfiguration API with the same client token will create only one access control configuration.

      Returns:
      A token that you provide to identify the request to create an access control configuration. Multiple calls to the CreateAccessControlConfiguration API with the same client token will create only one access control configuration.

    • toBuilder

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

    • builder

      public static CreateAccessControlConfigurationRequest.Builder builder()

    • serializableBuilderClass

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