• Home
• com.amazonaws
• aws-java-sdk-kendra
• 1.12.742
• source code
• ExperienceEntitiesSummary.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.amazonaws.services.kendra.model.ExperienceEntitiesSummary Maven / Gradle / Ivy

/*
 * Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
 * the License. A copy of the License is located at
 * 
 * http://aws.amazon.com/apache2.0
 * 
 * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
 * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
 * and limitations under the License.
 */
package com.amazonaws.services.kendra.model;

import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;

/**
 * 

 * Summary information for users or groups in your IAM Identity Center identity source with granted access to your
 * Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more
 * information on creating a search application experience, see Building a search
 * experience with no code.
 * 
 * 
 * @see AWS
 *      API Documentation
 */
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ExperienceEntitiesSummary implements Serializable, Cloneable, StructuredPojo {

    /**
     * 

     * The identifier of a user or group in your IAM Identity Center identity source. For example, a user ID could be an
     * email.
     * 
     */
    private String entityId;
    /**
     * 

     * Shows the type as User or Group.
     * 
     */
    private String entityType;
    /**
     * 

     * Information about the user entity.
     * 
     */
    private EntityDisplayData displayData;

    /**
     * 

     * The identifier of a user or group in your IAM Identity Center identity source. For example, a user ID could be an
     * email.
     * 
     * 
     * @param entityId
     *        The identifier of a user or group in your IAM Identity Center identity source. For example, a user ID
     *        could be an email.
     */

    public void setEntityId(String entityId) {
        this.entityId = entityId;
    }

    /**
     * 

     * The identifier of a user or group in your IAM Identity Center identity source. For example, a user ID could be an
     * email.
     * 
     * 
     * @return The identifier of a user or group in your IAM Identity Center identity source. For example, a user ID
     *         could be an email.
     */

    public String getEntityId() {
        return this.entityId;
    }

    /**
     * 

     * The identifier of a user or group in your IAM Identity Center identity source. For example, a user ID could be an
     * email.
     * 
     * 
     * @param entityId
     *        The identifier of a user or group in your IAM Identity Center identity source. For example, a user ID
     *        could be an email.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public ExperienceEntitiesSummary withEntityId(String entityId) {
        setEntityId(entityId);
        return this;
    }

    /**
     * 

     * Shows the type as User or Group.
     * 
     * 
     * @param entityType
     *        Shows the type as User or Group.
     * @see EntityType
     */

    public void setEntityType(String entityType) {
        this.entityType = entityType;
    }

    /**
     * 

     * Shows the type as User or Group.
     * 
     * 
     * @return Shows the type as User or Group.
     * @see EntityType
     */

    public String getEntityType() {
        return this.entityType;
    }

    /**
     * 

     * Shows the type as User or Group.
     * 
     * 
     * @param entityType
     *        Shows the type as User or Group.
     * @return Returns a reference to this object so that method calls can be chained together.
     * @see EntityType
     */

    public ExperienceEntitiesSummary withEntityType(String entityType) {
        setEntityType(entityType);
        return this;
    }

    /**
     * 

     * Shows the type as User or Group.
     * 
     * 
     * @param entityType
     *        Shows the type as User or Group.
     * @return Returns a reference to this object so that method calls can be chained together.
     * @see EntityType
     */

    public ExperienceEntitiesSummary withEntityType(EntityType entityType) {
        this.entityType = entityType.toString();
        return this;
    }

    /**
     * 

     * Information about the user entity.
     * 
     * 
     * @param displayData
     *        Information about the user entity.
     */

    public void setDisplayData(EntityDisplayData displayData) {
        this.displayData = displayData;
    }

    /**
     * 

     * Information about the user entity.
     * 
     * 
     * @return Information about the user entity.
     */

    public EntityDisplayData getDisplayData() {
        return this.displayData;
    }

    /**
     * 

     * Information about the user entity.
     * 
     * 
     * @param displayData
     *        Information about the user entity.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public ExperienceEntitiesSummary withDisplayData(EntityDisplayData displayData) {
        setDisplayData(displayData);
        return this;
    }

    /**
     * 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.
     *
     * @return A string representation of this object.
     *
     * @see java.lang.Object#toString()
     */
    @Override
    public String toString() {
        StringBuilder sb = new StringBuilder();
        sb.append("{");
        if (getEntityId() != null)
            sb.append("EntityId: ").append(getEntityId()).append(",");
        if (getEntityType() != null)
            sb.append("EntityType: ").append(getEntityType()).append(",");
        if (getDisplayData() != null)
            sb.append("DisplayData: ").append(getDisplayData());
        sb.append("}");
        return sb.toString();
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj)
            return true;
        if (obj == null)
            return false;

        if (obj instanceof ExperienceEntitiesSummary == false)
            return false;
        ExperienceEntitiesSummary other = (ExperienceEntitiesSummary) obj;
        if (other.getEntityId() == null ^ this.getEntityId() == null)
            return false;
        if (other.getEntityId() != null && other.getEntityId().equals(this.getEntityId()) == false)
            return false;
        if (other.getEntityType() == null ^ this.getEntityType() == null)
            return false;
        if (other.getEntityType() != null && other.getEntityType().equals(this.getEntityType()) == false)
            return false;
        if (other.getDisplayData() == null ^ this.getDisplayData() == null)
            return false;
        if (other.getDisplayData() != null && other.getDisplayData().equals(this.getDisplayData()) == false)
            return false;
        return true;
    }

    @Override
    public int hashCode() {
        final int prime = 31;
        int hashCode = 1;

        hashCode = prime * hashCode + ((getEntityId() == null) ? 0 : getEntityId().hashCode());
        hashCode = prime * hashCode + ((getEntityType() == null) ? 0 : getEntityType().hashCode());
        hashCode = prime * hashCode + ((getDisplayData() == null) ? 0 : getDisplayData().hashCode());
        return hashCode;
    }

    @Override
    public ExperienceEntitiesSummary clone() {
        try {
            return (ExperienceEntitiesSummary) super.clone();
        } catch (CloneNotSupportedException e) {
            throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
        }
    }

    @com.amazonaws.annotation.SdkInternalApi
    @Override
    public void marshall(ProtocolMarshaller protocolMarshaller) {
        com.amazonaws.services.kendra.model.transform.ExperienceEntitiesSummaryMarshaller.getInstance().marshall(this, protocolMarshaller);
    }
}