Class PutGroupRequest

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

  • Method Details

    • applicationId

      public final String applicationId()

      The identifier of the application in which the user and group mapping belongs.

      Returns:
      The identifier of the application in which the user and group mapping belongs.

    • indexId

      public final String indexId()

      The identifier of the index in which you want to map users to their groups.

      Returns:
      The identifier of the index in which you want to map users to their groups.

    • groupName

      public final String groupName()

      The list that contains your users or sub groups that belong the same group. For example, the group "Company" includes the user "CEO" and the sub groups "Research", "Engineering", and "Sales and Marketing".

      Returns:
      The list that contains your users or sub groups that belong the same group. For example, the group "Company" includes the user "CEO" and the sub groups "Research", "Engineering", and "Sales and Marketing".

    • dataSourceId

      public final String dataSourceId()

      The identifier of the data source for which you want to map users to their groups. This is useful if a group is tied to multiple data sources, but you only want the group to access documents of a certain data source. For example, the groups "Research", "Engineering", and "Sales and Marketing" are all tied to the company's documents stored in the data sources Confluence and Salesforce. However, "Sales and Marketing" team only needs access to customer-related documents stored in Salesforce.

      Returns:
      The identifier of the data source for which you want to map users to their groups. This is useful if a group is tied to multiple data sources, but you only want the group to access documents of a certain data source. For example, the groups "Research", "Engineering", and "Sales and Marketing" are all tied to the company's documents stored in the data sources Confluence and Salesforce. However, "Sales and Marketing" team only needs access to customer-related documents stored in Salesforce.

    • type

      public final MembershipType type()

      The type of the group.

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

      Returns:
      The type of the group.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of the group.

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

      Returns:
      The type of the group.
      See Also:

    • groupMembers

      public final GroupMembers groupMembers()
      Returns the value of the GroupMembers property for this object.
      Returns:
      The value of the GroupMembers property for this object.

    • roleArn

      public final String roleArn()

      The Amazon Resource Name (ARN) of an IAM role that has access to the S3 file that contains your list of users that belong to a group.

      Returns:
      The Amazon Resource Name (ARN) of an IAM role that has access to the S3 file that contains your list of users that belong to a group.

    • toBuilder

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

    • builder

      public static PutGroupRequest.Builder builder()

    • serializableBuilderClass

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