com.amazonaws.services.kendra.model.IndexConfigurationSummary 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;
/**
*
* Summary information on the configuration of an index.
*
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class IndexConfigurationSummary implements Serializable, Cloneable, StructuredPojo {
/**
*
* The name of the index.
*
*/
private String name;
/**
*
* A identifier for the index. Use this to identify the index when you are using APIs such as Query,
* DescribeIndex, UpdateIndex, and DeleteIndex.
*
*/
private String id;
/**
*
* Indicates whether the index is a Enterprise Edition index or a Developer Edition index.
*
*/
private String edition;
/**
*
* The Unix timestamp when the index was created.
*
*/
private java.util.Date createdAt;
/**
*
* The Unix timestamp when the index was last updated.
*
*/
private java.util.Date updatedAt;
/**
*
* The current status of the index. When the status is ACTIVE, the index is ready to search.
*
*/
private String status;
/**
*
* The name of the index.
*
*
* @param name
* The name of the index.
*/
public void setName(String name) {
this.name = name;
}
/**
*
* The name of the index.
*
*
* @return The name of the index.
*/
public String getName() {
return this.name;
}
/**
*
* The name of the index.
*
*
* @param name
* The name of the index.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public IndexConfigurationSummary withName(String name) {
setName(name);
return this;
}
/**
*
* A identifier for the index. Use this to identify the index when you are using APIs such as Query,
* DescribeIndex, UpdateIndex, and DeleteIndex.
*
*
* @param id
* A identifier for the index. Use this to identify the index when you are using APIs such as
* Query, DescribeIndex, UpdateIndex, and DeleteIndex.
*/
public void setId(String id) {
this.id = id;
}
/**
*
* A identifier for the index. Use this to identify the index when you are using APIs such as Query,
* DescribeIndex, UpdateIndex, and DeleteIndex.
*
*
* @return A identifier for the index. Use this to identify the index when you are using APIs such as
* Query, DescribeIndex, UpdateIndex, and DeleteIndex.
*/
public String getId() {
return this.id;
}
/**
*
* A identifier for the index. Use this to identify the index when you are using APIs such as Query,
* DescribeIndex, UpdateIndex, and DeleteIndex.
*
*
* @param id
* A identifier for the index. Use this to identify the index when you are using APIs such as
* Query, DescribeIndex, UpdateIndex, and DeleteIndex.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public IndexConfigurationSummary withId(String id) {
setId(id);
return this;
}
/**
*
* Indicates whether the index is a Enterprise Edition index or a Developer Edition index.
*
*
* @param edition
* Indicates whether the index is a Enterprise Edition index or a Developer Edition index.
* @see IndexEdition
*/
public void setEdition(String edition) {
this.edition = edition;
}
/**
*
* Indicates whether the index is a Enterprise Edition index or a Developer Edition index.
*
*
* @return Indicates whether the index is a Enterprise Edition index or a Developer Edition index.
* @see IndexEdition
*/
public String getEdition() {
return this.edition;
}
/**
*
* Indicates whether the index is a Enterprise Edition index or a Developer Edition index.
*
*
* @param edition
* Indicates whether the index is a Enterprise Edition index or a Developer Edition index.
* @return Returns a reference to this object so that method calls can be chained together.
* @see IndexEdition
*/
public IndexConfigurationSummary withEdition(String edition) {
setEdition(edition);
return this;
}
/**
*
* Indicates whether the index is a Enterprise Edition index or a Developer Edition index.
*
*
* @param edition
* Indicates whether the index is a Enterprise Edition index or a Developer Edition index.
* @return Returns a reference to this object so that method calls can be chained together.
* @see IndexEdition
*/
public IndexConfigurationSummary withEdition(IndexEdition edition) {
this.edition = edition.toString();
return this;
}
/**
*
* The Unix timestamp when the index was created.
*
*
* @param createdAt
* The Unix timestamp when the index was created.
*/
public void setCreatedAt(java.util.Date createdAt) {
this.createdAt = createdAt;
}
/**
*
* The Unix timestamp when the index was created.
*
*
* @return The Unix timestamp when the index was created.
*/
public java.util.Date getCreatedAt() {
return this.createdAt;
}
/**
*
* The Unix timestamp when the index was created.
*
*
* @param createdAt
* The Unix timestamp when the index was created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public IndexConfigurationSummary withCreatedAt(java.util.Date createdAt) {
setCreatedAt(createdAt);
return this;
}
/**
*
* The Unix timestamp when the index was last updated.
*
*
* @param updatedAt
* The Unix timestamp when the index was last updated.
*/
public void setUpdatedAt(java.util.Date updatedAt) {
this.updatedAt = updatedAt;
}
/**
*
* The Unix timestamp when the index was last updated.
*
*
* @return The Unix timestamp when the index was last updated.
*/
public java.util.Date getUpdatedAt() {
return this.updatedAt;
}
/**
*
* The Unix timestamp when the index was last updated.
*
*
* @param updatedAt
* The Unix timestamp when the index was last updated.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public IndexConfigurationSummary withUpdatedAt(java.util.Date updatedAt) {
setUpdatedAt(updatedAt);
return this;
}
/**
*
* The current status of the index. When the status is ACTIVE, the index is ready to search.
*
*
* @param status
* The current status of the index. When the status is ACTIVE, the index is ready to search.
* @see IndexStatus
*/
public void setStatus(String status) {
this.status = status;
}
/**
*
* The current status of the index. When the status is ACTIVE, the index is ready to search.
*
*
* @return The current status of the index. When the status is ACTIVE, the index is ready to search.
* @see IndexStatus
*/
public String getStatus() {
return this.status;
}
/**
*
* The current status of the index. When the status is ACTIVE, the index is ready to search.
*
*
* @param status
* The current status of the index. When the status is ACTIVE, the index is ready to search.
* @return Returns a reference to this object so that method calls can be chained together.
* @see IndexStatus
*/
public IndexConfigurationSummary withStatus(String status) {
setStatus(status);
return this;
}
/**
*
* The current status of the index. When the status is ACTIVE, the index is ready to search.
*
*
* @param status
* The current status of the index. When the status is ACTIVE, the index is ready to search.
* @return Returns a reference to this object so that method calls can be chained together.
* @see IndexStatus
*/
public IndexConfigurationSummary withStatus(IndexStatus status) {
this.status = status.toString();
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 (getName() != null)
sb.append("Name: ").append(getName()).append(",");
if (getId() != null)
sb.append("Id: ").append(getId()).append(",");
if (getEdition() != null)
sb.append("Edition: ").append(getEdition()).append(",");
if (getCreatedAt() != null)
sb.append("CreatedAt: ").append(getCreatedAt()).append(",");
if (getUpdatedAt() != null)
sb.append("UpdatedAt: ").append(getUpdatedAt()).append(",");
if (getStatus() != null)
sb.append("Status: ").append(getStatus());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof IndexConfigurationSummary == false)
return false;
IndexConfigurationSummary other = (IndexConfigurationSummary) obj;
if (other.getName() == null ^ this.getName() == null)
return false;
if (other.getName() != null && other.getName().equals(this.getName()) == false)
return false;
if (other.getId() == null ^ this.getId() == null)
return false;
if (other.getId() != null && other.getId().equals(this.getId()) == false)
return false;
if (other.getEdition() == null ^ this.getEdition() == null)
return false;
if (other.getEdition() != null && other.getEdition().equals(this.getEdition()) == false)
return false;
if (other.getCreatedAt() == null ^ this.getCreatedAt() == null)
return false;
if (other.getCreatedAt() != null && other.getCreatedAt().equals(this.getCreatedAt()) == false)
return false;
if (other.getUpdatedAt() == null ^ this.getUpdatedAt() == null)
return false;
if (other.getUpdatedAt() != null && other.getUpdatedAt().equals(this.getUpdatedAt()) == false)
return false;
if (other.getStatus() == null ^ this.getStatus() == null)
return false;
if (other.getStatus() != null && other.getStatus().equals(this.getStatus()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
hashCode = prime * hashCode + ((getId() == null) ? 0 : getId().hashCode());
hashCode = prime * hashCode + ((getEdition() == null) ? 0 : getEdition().hashCode());
hashCode = prime * hashCode + ((getCreatedAt() == null) ? 0 : getCreatedAt().hashCode());
hashCode = prime * hashCode + ((getUpdatedAt() == null) ? 0 : getUpdatedAt().hashCode());
hashCode = prime * hashCode + ((getStatus() == null) ? 0 : getStatus().hashCode());
return hashCode;
}
@Override
public IndexConfigurationSummary clone() {
try {
return (IndexConfigurationSummary) 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.IndexConfigurationSummaryMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}