/* * Copyright 2018-2023 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; /** *

* Identifies a document for which to retrieve status information *

* * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class DocumentInfo implements Serializable, Cloneable, StructuredPojo { /** *

* The identifier of the document. *

*/ private String documentId; /** *

* Attributes that identify a specific version of a document to check. *

* The only valid attributes are: *

*
* version *
*
*
* datasourceId *
*
*
* jobExecutionId *
*

* The attributes follow these rules: *

*
* dataSourceId and jobExecutionId must be used together. *
*
*
* version is ignored if dataSourceId and jobExecutionId are not provided. *
*
*
* If dataSourceId and jobExecutionId are provided, but version is not, the * version defaults to "0". *
*

*/ private java.util.List attributes; /** *

* The identifier of the document. *

* * @param documentId * The identifier of the document. */ public void setDocumentId(String documentId) { this.documentId = documentId; } /** *

* The identifier of the document. *

* * @return The identifier of the document. */ public String getDocumentId() { return this.documentId; } /** *

* The identifier of the document. *

* * @param documentId * The identifier of the document. * @return Returns a reference to this object so that method calls can be chained together. */ public DocumentInfo withDocumentId(String documentId) { setDocumentId(documentId); return this; } /** *

* Attributes that identify a specific version of a document to check. *

* The only valid attributes are: *

*
* version *
*
*
* datasourceId *
*
*
* jobExecutionId *
*

* The attributes follow these rules: *

*
* dataSourceId and jobExecutionId must be used together. *
*
*
* version is ignored if dataSourceId and jobExecutionId are not provided. *
*
*
* If dataSourceId and jobExecutionId are provided, but version is not, the * version defaults to "0". *
*

* * @return Attributes that identify a specific version of a document to check.

* The only valid attributes are: *

*
* version *
*
*
* datasourceId *
*
*
* jobExecutionId *
*

* The attributes follow these rules: *

*
* dataSourceId and jobExecutionId must be used together. *
*
*
* version is ignored if dataSourceId and jobExecutionId are not * provided. *
*
*
* If dataSourceId and jobExecutionId are provided, but version is * not, the version defaults to "0". *
*

getAttributes() { return attributes; } /** *

* Attributes that identify a specific version of a document to check. *

* The only valid attributes are: *

*
* version *
*
*
* datasourceId *
*
*
* jobExecutionId *
*

* The attributes follow these rules: *

*
* dataSourceId and jobExecutionId must be used together. *
*
*
* version is ignored if dataSourceId and jobExecutionId are not provided. *
*
*
* If dataSourceId and jobExecutionId are provided, but version is not, the * version defaults to "0". *
*

* * @param attributes * Attributes that identify a specific version of a document to check.

* The only valid attributes are: *

*
* version *
*
*
* datasourceId *
*
*
* jobExecutionId *
*

* The attributes follow these rules: *

*
* dataSourceId and jobExecutionId must be used together. *
*
*
* version is ignored if dataSourceId and jobExecutionId are not * provided. *
*
*
* If dataSourceId and jobExecutionId are provided, but version is * not, the version defaults to "0". *
*

attributes) { if (attributes == null) { this.attributes = null; return; } this.attributes = new java.util.ArrayList(attributes); } /** *

* Attributes that identify a specific version of a document to check. *

* The only valid attributes are: *

*
* version *
*
*
* datasourceId *
*
*
* jobExecutionId *
*

* The attributes follow these rules: *

*
* dataSourceId and jobExecutionId must be used together. *
*
*
* version is ignored if dataSourceId and jobExecutionId are not provided. *
*
*
* If dataSourceId and jobExecutionId are provided, but version is not, the * version defaults to "0". *
*

* NOTE: This method appends the values to the existing list (if any). Use * {@link #setAttributes(java.util.Collection)} or {@link #withAttributes(java.util.Collection)} if you want to * override the existing values. *

* * @param attributes * Attributes that identify a specific version of a document to check.

* The only valid attributes are: *

*
* version *
*
*
* datasourceId *
*
*
* jobExecutionId *
*

* The attributes follow these rules: *

*
* dataSourceId and jobExecutionId must be used together. *
*
*
* version is ignored if dataSourceId and jobExecutionId are not * provided. *
*
*
* If dataSourceId and jobExecutionId are provided, but version is * not, the version defaults to "0". *
*

(attributes.length)); } for (DocumentAttribute ele : attributes) { this.attributes.add(ele); } return this; } /** *

* Attributes that identify a specific version of a document to check. *

* The only valid attributes are: *

*
* version *
*
*
* datasourceId *
*
*
* jobExecutionId *
*

* The attributes follow these rules: *

*
* dataSourceId and jobExecutionId must be used together. *
*
*
* version is ignored if dataSourceId and jobExecutionId are not provided. *
*
*
* If dataSourceId and jobExecutionId are provided, but version is not, the * version defaults to "0". *
*

* * @param attributes * Attributes that identify a specific version of a document to check.

* The only valid attributes are: *

*
* version *
*
*
* datasourceId *
*
*
* jobExecutionId *
*

* The attributes follow these rules: *

*
* dataSourceId and jobExecutionId must be used together. *
*
*
* version is ignored if dataSourceId and jobExecutionId are not * provided. *
*
*
* If dataSourceId and jobExecutionId are provided, but version is * not, the version defaults to "0". *
*

attributes) { setAttributes(attributes); 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 (getDocumentId() != null) sb.append("DocumentId: ").append(getDocumentId()).append(","); if (getAttributes() != null) sb.append("Attributes: ").append(getAttributes()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof DocumentInfo == false) return false; DocumentInfo other = (DocumentInfo) obj; if (other.getDocumentId() == null ^ this.getDocumentId() == null) return false; if (other.getDocumentId() != null && other.getDocumentId().equals(this.getDocumentId()) == false) return false; if (other.getAttributes() == null ^ this.getAttributes() == null) return false; if (other.getAttributes() != null && other.getAttributes().equals(this.getAttributes()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getDocumentId() == null) ? 0 : getDocumentId().hashCode()); hashCode = prime * hashCode + ((getAttributes() == null) ? 0 : getAttributes().hashCode()); return hashCode; } @Override public DocumentInfo clone() { try { return (DocumentInfo) 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.DocumentInfoMarshaller.getInstance().marshall(this, protocolMarshaller); } }