com.amazonaws.services.kendra.model.HierarchicalPrincipal Maven / Gradle / Ivy
Show all versions of aws-java-sdk-kendra Show documentation
/*
* 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;
/**
*
* Information to define the hierarchy for which documents users should have access to.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class HierarchicalPrincipal implements Serializable, Cloneable, StructuredPojo {
/**
*
* A list of principal lists that
* define the hierarchy for which documents users should have access to. Each hierarchical list specifies which user
* or group has allow or deny access for each document.
*
*/
private java.util.List principalList;
/**
*
* A list of principal lists that
* define the hierarchy for which documents users should have access to. Each hierarchical list specifies which user
* or group has allow or deny access for each document.
*
*
* @return A list of principal lists
* that define the hierarchy for which documents users should have access to. Each hierarchical list
* specifies which user or group has allow or deny access for each document.
*/
public java.util.List getPrincipalList() {
return principalList;
}
/**
*
* A list of principal lists that
* define the hierarchy for which documents users should have access to. Each hierarchical list specifies which user
* or group has allow or deny access for each document.
*
*
* @param principalList
* A list of principal lists
* that define the hierarchy for which documents users should have access to. Each hierarchical list
* specifies which user or group has allow or deny access for each document.
*/
public void setPrincipalList(java.util.Collection principalList) {
if (principalList == null) {
this.principalList = null;
return;
}
this.principalList = new java.util.ArrayList(principalList);
}
/**
*
* A list of principal lists that
* define the hierarchy for which documents users should have access to. Each hierarchical list specifies which user
* or group has allow or deny access for each document.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setPrincipalList(java.util.Collection)} or {@link #withPrincipalList(java.util.Collection)} if you want
* to override the existing values.
*
*
* @param principalList
* A list of principal lists
* that define the hierarchy for which documents users should have access to. Each hierarchical list
* specifies which user or group has allow or deny access for each document.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public HierarchicalPrincipal withPrincipalList(Principal... principalList) {
if (this.principalList == null) {
setPrincipalList(new java.util.ArrayList(principalList.length));
}
for (Principal ele : principalList) {
this.principalList.add(ele);
}
return this;
}
/**
*
* A list of principal lists that
* define the hierarchy for which documents users should have access to. Each hierarchical list specifies which user
* or group has allow or deny access for each document.
*
*
* @param principalList
* A list of principal lists
* that define the hierarchy for which documents users should have access to. Each hierarchical list
* specifies which user or group has allow or deny access for each document.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public HierarchicalPrincipal withPrincipalList(java.util.Collection principalList) {
setPrincipalList(principalList);
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 (getPrincipalList() != null)
sb.append("PrincipalList: ").append(getPrincipalList());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof HierarchicalPrincipal == false)
return false;
HierarchicalPrincipal other = (HierarchicalPrincipal) obj;
if (other.getPrincipalList() == null ^ this.getPrincipalList() == null)
return false;
if (other.getPrincipalList() != null && other.getPrincipalList().equals(this.getPrincipalList()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getPrincipalList() == null) ? 0 : getPrincipalList().hashCode());
return hashCode;
}
@Override
public HierarchicalPrincipal clone() {
try {
return (HierarchicalPrincipal) 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.HierarchicalPrincipalMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}