software.amazon.awssdk.services.qbusiness.model.Index Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of qbusiness Show documentation
Show all versions of qbusiness Show documentation
The AWS Java SDK for Q Business module holds the client classes that are used for
communicating with Q Business.
/*
* Copyright 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 software.amazon.awssdk.services.qbusiness.model;
import java.io.Serializable;
import java.time.Instant;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Summary information for your Amazon Q Business index.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class Index implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField DISPLAY_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("displayName").getter(getter(Index::displayName)).setter(setter(Builder::displayName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("displayName").build()).build();
private static final SdkField INDEX_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("indexId").getter(getter(Index::indexId)).setter(setter(Builder::indexId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("indexId").build()).build();
private static final SdkField CREATED_AT_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("createdAt").getter(getter(Index::createdAt)).setter(setter(Builder::createdAt))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("createdAt").build()).build();
private static final SdkField UPDATED_AT_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("updatedAt").getter(getter(Index::updatedAt)).setter(setter(Builder::updatedAt))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("updatedAt").build()).build();
private static final SdkField STATUS_FIELD = SdkField. builder(MarshallingType.STRING).memberName("status")
.getter(getter(Index::statusAsString)).setter(setter(Builder::status))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("status").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(DISPLAY_NAME_FIELD,
INDEX_ID_FIELD, CREATED_AT_FIELD, UPDATED_AT_FIELD, STATUS_FIELD));
private static final long serialVersionUID = 1L;
private final String displayName;
private final String indexId;
private final Instant createdAt;
private final Instant updatedAt;
private final String status;
private Index(BuilderImpl builder) {
this.displayName = builder.displayName;
this.indexId = builder.indexId;
this.createdAt = builder.createdAt;
this.updatedAt = builder.updatedAt;
this.status = builder.status;
}
/**
*
* The name of the index.
*
*
* @return The name of the index.
*/
public final String displayName() {
return displayName;
}
/**
*
* The identifier for the index.
*
*
* @return The identifier for the index.
*/
public final String indexId() {
return indexId;
}
/**
*
* The Unix timestamp when the index was created.
*
*
* @return The Unix timestamp when the index was created.
*/
public final Instant createdAt() {
return createdAt;
}
/**
*
* The Unix timestamp when the index was last updated.
*
*
* @return The Unix timestamp when the index was last updated.
*/
public final Instant updatedAt() {
return updatedAt;
}
/**
*
* The current status of the index. When the status is ACTIVE, the index is ready.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #status} will
* return {@link IndexStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #statusAsString}.
*
*
* @return The current status of the index. When the status is ACTIVE, the index is ready.
* @see IndexStatus
*/
public final IndexStatus status() {
return IndexStatus.fromValue(status);
}
/**
*
* The current status of the index. When the status is ACTIVE, the index is ready.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #status} will
* return {@link IndexStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #statusAsString}.
*
*
* @return The current status of the index. When the status is ACTIVE, the index is ready.
* @see IndexStatus
*/
public final String statusAsString() {
return status;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(displayName());
hashCode = 31 * hashCode + Objects.hashCode(indexId());
hashCode = 31 * hashCode + Objects.hashCode(createdAt());
hashCode = 31 * hashCode + Objects.hashCode(updatedAt());
hashCode = 31 * hashCode + Objects.hashCode(statusAsString());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof Index)) {
return false;
}
Index other = (Index) obj;
return Objects.equals(displayName(), other.displayName()) && Objects.equals(indexId(), other.indexId())
&& Objects.equals(createdAt(), other.createdAt()) && Objects.equals(updatedAt(), other.updatedAt())
&& Objects.equals(statusAsString(), other.statusAsString());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("Index").add("DisplayName", displayName()).add("IndexId", indexId())
.add("CreatedAt", createdAt()).add("UpdatedAt", updatedAt()).add("Status", statusAsString()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "displayName":
return Optional.ofNullable(clazz.cast(displayName()));
case "indexId":
return Optional.ofNullable(clazz.cast(indexId()));
case "createdAt":
return Optional.ofNullable(clazz.cast(createdAt()));
case "updatedAt":
return Optional.ofNullable(clazz.cast(updatedAt()));
case "status":
return Optional.ofNullable(clazz.cast(statusAsString()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((Index) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The name of the index.
*
*
* @param displayName
* The name of the index.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder displayName(String displayName);
/**
*
* The identifier for the index.
*
*
* @param indexId
* The identifier for the index.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder indexId(String indexId);
/**
*
* 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.
*/
Builder createdAt(Instant createdAt);
/**
*
* 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.
*/
Builder updatedAt(Instant updatedAt);
/**
*
* The current status of the index. When the status is ACTIVE, the index is ready.
*
*
* @param status
* The current status of the index. When the status is ACTIVE, the index is ready.
* @see IndexStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see IndexStatus
*/
Builder status(String status);
/**
*
* The current status of the index. When the status is ACTIVE, the index is ready.
*
*
* @param status
* The current status of the index. When the status is ACTIVE, the index is ready.
* @see IndexStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see IndexStatus
*/
Builder status(IndexStatus status);
}
static final class BuilderImpl implements Builder {
private String displayName;
private String indexId;
private Instant createdAt;
private Instant updatedAt;
private String status;
private BuilderImpl() {
}
private BuilderImpl(Index model) {
displayName(model.displayName);
indexId(model.indexId);
createdAt(model.createdAt);
updatedAt(model.updatedAt);
status(model.status);
}
public final String getDisplayName() {
return displayName;
}
public final void setDisplayName(String displayName) {
this.displayName = displayName;
}
@Override
public final Builder displayName(String displayName) {
this.displayName = displayName;
return this;
}
public final String getIndexId() {
return indexId;
}
public final void setIndexId(String indexId) {
this.indexId = indexId;
}
@Override
public final Builder indexId(String indexId) {
this.indexId = indexId;
return this;
}
public final Instant getCreatedAt() {
return createdAt;
}
public final void setCreatedAt(Instant createdAt) {
this.createdAt = createdAt;
}
@Override
public final Builder createdAt(Instant createdAt) {
this.createdAt = createdAt;
return this;
}
public final Instant getUpdatedAt() {
return updatedAt;
}
public final void setUpdatedAt(Instant updatedAt) {
this.updatedAt = updatedAt;
}
@Override
public final Builder updatedAt(Instant updatedAt) {
this.updatedAt = updatedAt;
return this;
}
public final String getStatus() {
return status;
}
public final void setStatus(String status) {
this.status = status;
}
@Override
public final Builder status(String status) {
this.status = status;
return this;
}
@Override
public final Builder status(IndexStatus status) {
this.status(status == null ? null : status.toString());
return this;
}
@Override
public Index build() {
return new Index(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}