software.amazon.awssdk.services.dynamodb.model.DescribeContributorInsightsResponse Maven / Gradle / Ivy
Show all versions of dynamodb Show documentation
/*
* 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.dynamodb.model;
import java.time.Instant;
import java.util.Arrays;
import java.util.Collection;
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.Consumer;
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.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class DescribeContributorInsightsResponse extends DynamoDbResponse implements
ToCopyableBuilder {
private static final SdkField TABLE_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("TableName").getter(getter(DescribeContributorInsightsResponse::tableName))
.setter(setter(Builder::tableName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TableName").build()).build();
private static final SdkField INDEX_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("IndexName").getter(getter(DescribeContributorInsightsResponse::indexName))
.setter(setter(Builder::indexName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("IndexName").build()).build();
private static final SdkField> CONTRIBUTOR_INSIGHTS_RULE_LIST_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("ContributorInsightsRuleList")
.getter(getter(DescribeContributorInsightsResponse::contributorInsightsRuleList))
.setter(setter(Builder::contributorInsightsRuleList))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ContributorInsightsRuleList")
.build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField CONTRIBUTOR_INSIGHTS_STATUS_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ContributorInsightsStatus")
.getter(getter(DescribeContributorInsightsResponse::contributorInsightsStatusAsString))
.setter(setter(Builder::contributorInsightsStatus))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ContributorInsightsStatus").build())
.build();
private static final SdkField LAST_UPDATE_DATE_TIME_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("LastUpdateDateTime").getter(getter(DescribeContributorInsightsResponse::lastUpdateDateTime))
.setter(setter(Builder::lastUpdateDateTime))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("LastUpdateDateTime").build())
.build();
private static final SdkField FAILURE_EXCEPTION_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("FailureException")
.getter(getter(DescribeContributorInsightsResponse::failureException)).setter(setter(Builder::failureException))
.constructor(FailureException::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("FailureException").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(TABLE_NAME_FIELD,
INDEX_NAME_FIELD, CONTRIBUTOR_INSIGHTS_RULE_LIST_FIELD, CONTRIBUTOR_INSIGHTS_STATUS_FIELD,
LAST_UPDATE_DATE_TIME_FIELD, FAILURE_EXCEPTION_FIELD));
private final String tableName;
private final String indexName;
private final List contributorInsightsRuleList;
private final String contributorInsightsStatus;
private final Instant lastUpdateDateTime;
private final FailureException failureException;
private DescribeContributorInsightsResponse(BuilderImpl builder) {
super(builder);
this.tableName = builder.tableName;
this.indexName = builder.indexName;
this.contributorInsightsRuleList = builder.contributorInsightsRuleList;
this.contributorInsightsStatus = builder.contributorInsightsStatus;
this.lastUpdateDateTime = builder.lastUpdateDateTime;
this.failureException = builder.failureException;
}
/**
*
* The name of the table being described.
*
*
* @return The name of the table being described.
*/
public final String tableName() {
return tableName;
}
/**
*
* The name of the global secondary index being described.
*
*
* @return The name of the global secondary index being described.
*/
public final String indexName() {
return indexName;
}
/**
* For responses, this returns true if the service returned a value for the ContributorInsightsRuleList property.
* This DOES NOT check that the value is non-empty (for which, you should check the {@code isEmpty()} method on the
* property). This is useful because the SDK will never return a null collection or map, but you may need to
* differentiate between the service returning nothing (or null) and the service returning an empty collection or
* map. For requests, this returns true if a value for the property was specified in the request builder, and false
* if a value was not specified.
*/
public final boolean hasContributorInsightsRuleList() {
return contributorInsightsRuleList != null && !(contributorInsightsRuleList instanceof SdkAutoConstructList);
}
/**
*
* List of names of the associated contributor insights rules.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasContributorInsightsRuleList} method.
*
*
* @return List of names of the associated contributor insights rules.
*/
public final List contributorInsightsRuleList() {
return contributorInsightsRuleList;
}
/**
*
* Current status of contributor insights.
*
*
* If the service returns an enum value that is not available in the current SDK version,
* {@link #contributorInsightsStatus} will return {@link ContributorInsightsStatus#UNKNOWN_TO_SDK_VERSION}. The raw
* value returned by the service is available from {@link #contributorInsightsStatusAsString}.
*
*
* @return Current status of contributor insights.
* @see ContributorInsightsStatus
*/
public final ContributorInsightsStatus contributorInsightsStatus() {
return ContributorInsightsStatus.fromValue(contributorInsightsStatus);
}
/**
*
* Current status of contributor insights.
*
*
* If the service returns an enum value that is not available in the current SDK version,
* {@link #contributorInsightsStatus} will return {@link ContributorInsightsStatus#UNKNOWN_TO_SDK_VERSION}. The raw
* value returned by the service is available from {@link #contributorInsightsStatusAsString}.
*
*
* @return Current status of contributor insights.
* @see ContributorInsightsStatus
*/
public final String contributorInsightsStatusAsString() {
return contributorInsightsStatus;
}
/**
*
* Timestamp of the last time the status was changed.
*
*
* @return Timestamp of the last time the status was changed.
*/
public final Instant lastUpdateDateTime() {
return lastUpdateDateTime;
}
/**
*
* Returns information about the last failure that was encountered.
*
*
* The most common exceptions for a FAILED status are:
*
*
* -
*
* LimitExceededException - Per-account Amazon CloudWatch Contributor Insights rule limit reached. Please disable
* Contributor Insights for other tables/indexes OR disable Contributor Insights rules before retrying.
*
*
* -
*
* AccessDeniedException - Amazon CloudWatch Contributor Insights rules cannot be modified due to insufficient
* permissions.
*
*
* -
*
* AccessDeniedException - Failed to create service-linked role for Contributor Insights due to insufficient
* permissions.
*
*
* -
*
* InternalServerError - Failed to create Amazon CloudWatch Contributor Insights rules. Please retry request.
*
*
*
*
* @return Returns information about the last failure that was encountered.
*
* The most common exceptions for a FAILED status are:
*
*
* -
*
* LimitExceededException - Per-account Amazon CloudWatch Contributor Insights rule limit reached. Please
* disable Contributor Insights for other tables/indexes OR disable Contributor Insights rules before
* retrying.
*
*
* -
*
* AccessDeniedException - Amazon CloudWatch Contributor Insights rules cannot be modified due to
* insufficient permissions.
*
*
* -
*
* AccessDeniedException - Failed to create service-linked role for Contributor Insights due to insufficient
* permissions.
*
*
* -
*
* InternalServerError - Failed to create Amazon CloudWatch Contributor Insights rules. Please retry
* request.
*
*
*/
public final FailureException failureException() {
return failureException;
}
@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 + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(tableName());
hashCode = 31 * hashCode + Objects.hashCode(indexName());
hashCode = 31 * hashCode + Objects.hashCode(hasContributorInsightsRuleList() ? contributorInsightsRuleList() : null);
hashCode = 31 * hashCode + Objects.hashCode(contributorInsightsStatusAsString());
hashCode = 31 * hashCode + Objects.hashCode(lastUpdateDateTime());
hashCode = 31 * hashCode + Objects.hashCode(failureException());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof DescribeContributorInsightsResponse)) {
return false;
}
DescribeContributorInsightsResponse other = (DescribeContributorInsightsResponse) obj;
return Objects.equals(tableName(), other.tableName()) && Objects.equals(indexName(), other.indexName())
&& hasContributorInsightsRuleList() == other.hasContributorInsightsRuleList()
&& Objects.equals(contributorInsightsRuleList(), other.contributorInsightsRuleList())
&& Objects.equals(contributorInsightsStatusAsString(), other.contributorInsightsStatusAsString())
&& Objects.equals(lastUpdateDateTime(), other.lastUpdateDateTime())
&& Objects.equals(failureException(), other.failureException());
}
/**
* 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("DescribeContributorInsightsResponse").add("TableName", tableName())
.add("IndexName", indexName())
.add("ContributorInsightsRuleList", hasContributorInsightsRuleList() ? contributorInsightsRuleList() : null)
.add("ContributorInsightsStatus", contributorInsightsStatusAsString())
.add("LastUpdateDateTime", lastUpdateDateTime()).add("FailureException", failureException()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "TableName":
return Optional.ofNullable(clazz.cast(tableName()));
case "IndexName":
return Optional.ofNullable(clazz.cast(indexName()));
case "ContributorInsightsRuleList":
return Optional.ofNullable(clazz.cast(contributorInsightsRuleList()));
case "ContributorInsightsStatus":
return Optional.ofNullable(clazz.cast(contributorInsightsStatusAsString()));
case "LastUpdateDateTime":
return Optional.ofNullable(clazz.cast(lastUpdateDateTime()));
case "FailureException":
return Optional.ofNullable(clazz.cast(failureException()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((DescribeContributorInsightsResponse) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends DynamoDbResponse.Builder, SdkPojo,
CopyableBuilder {
/**
*
* The name of the table being described.
*
*
* @param tableName
* The name of the table being described.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tableName(String tableName);
/**
*
* The name of the global secondary index being described.
*
*
* @param indexName
* The name of the global secondary index being described.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder indexName(String indexName);
/**
*
* List of names of the associated contributor insights rules.
*
*
* @param contributorInsightsRuleList
* List of names of the associated contributor insights rules.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder contributorInsightsRuleList(Collection contributorInsightsRuleList);
/**
*
* List of names of the associated contributor insights rules.
*
*
* @param contributorInsightsRuleList
* List of names of the associated contributor insights rules.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder contributorInsightsRuleList(String... contributorInsightsRuleList);
/**
*
* Current status of contributor insights.
*
*
* @param contributorInsightsStatus
* Current status of contributor insights.
* @see ContributorInsightsStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see ContributorInsightsStatus
*/
Builder contributorInsightsStatus(String contributorInsightsStatus);
/**
*
* Current status of contributor insights.
*
*
* @param contributorInsightsStatus
* Current status of contributor insights.
* @see ContributorInsightsStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see ContributorInsightsStatus
*/
Builder contributorInsightsStatus(ContributorInsightsStatus contributorInsightsStatus);
/**
*
* Timestamp of the last time the status was changed.
*
*
* @param lastUpdateDateTime
* Timestamp of the last time the status was changed.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder lastUpdateDateTime(Instant lastUpdateDateTime);
/**
*
* Returns information about the last failure that was encountered.
*
*
* The most common exceptions for a FAILED status are:
*
*
* -
*
* LimitExceededException - Per-account Amazon CloudWatch Contributor Insights rule limit reached. Please
* disable Contributor Insights for other tables/indexes OR disable Contributor Insights rules before retrying.
*
*
* -
*
* AccessDeniedException - Amazon CloudWatch Contributor Insights rules cannot be modified due to insufficient
* permissions.
*
*
* -
*
* AccessDeniedException - Failed to create service-linked role for Contributor Insights due to insufficient
* permissions.
*
*
* -
*
* InternalServerError - Failed to create Amazon CloudWatch Contributor Insights rules. Please retry request.
*
*
*
*
* @param failureException
* Returns information about the last failure that was encountered.
*
* The most common exceptions for a FAILED status are:
*
*
* -
*
* LimitExceededException - Per-account Amazon CloudWatch Contributor Insights rule limit reached. Please
* disable Contributor Insights for other tables/indexes OR disable Contributor Insights rules before
* retrying.
*
*
* -
*
* AccessDeniedException - Amazon CloudWatch Contributor Insights rules cannot be modified due to
* insufficient permissions.
*
*
* -
*
* AccessDeniedException - Failed to create service-linked role for Contributor Insights due to
* insufficient permissions.
*
*
* -
*
* InternalServerError - Failed to create Amazon CloudWatch Contributor Insights rules. Please retry
* request.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder failureException(FailureException failureException);
/**
*
* Returns information about the last failure that was encountered.
*
*
* The most common exceptions for a FAILED status are:
*
*
* -
*
* LimitExceededException - Per-account Amazon CloudWatch Contributor Insights rule limit reached. Please
* disable Contributor Insights for other tables/indexes OR disable Contributor Insights rules before retrying.
*
*
* -
*
* AccessDeniedException - Amazon CloudWatch Contributor Insights rules cannot be modified due to insufficient
* permissions.
*
*
* -
*
* AccessDeniedException - Failed to create service-linked role for Contributor Insights due to insufficient
* permissions.
*
*
* -
*
* InternalServerError - Failed to create Amazon CloudWatch Contributor Insights rules. Please retry request.
*
*
*
* This is a convenience method that creates an instance of the {@link FailureException.Builder} avoiding the
* need to create one manually via {@link FailureException#builder()}.
*
*
* When the {@link Consumer} completes, {@link FailureException.Builder#build()} is called immediately and its
* result is passed to {@link #failureException(FailureException)}.
*
* @param failureException
* a consumer that will call methods on {@link FailureException.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #failureException(FailureException)
*/
default Builder failureException(Consumer failureException) {
return failureException(FailureException.builder().applyMutation(failureException).build());
}
}
static final class BuilderImpl extends DynamoDbResponse.BuilderImpl implements Builder {
private String tableName;
private String indexName;
private List contributorInsightsRuleList = DefaultSdkAutoConstructList.getInstance();
private String contributorInsightsStatus;
private Instant lastUpdateDateTime;
private FailureException failureException;
private BuilderImpl() {
}
private BuilderImpl(DescribeContributorInsightsResponse model) {
super(model);
tableName(model.tableName);
indexName(model.indexName);
contributorInsightsRuleList(model.contributorInsightsRuleList);
contributorInsightsStatus(model.contributorInsightsStatus);
lastUpdateDateTime(model.lastUpdateDateTime);
failureException(model.failureException);
}
public final String getTableName() {
return tableName;
}
public final void setTableName(String tableName) {
this.tableName = tableName;
}
@Override
public final Builder tableName(String tableName) {
this.tableName = tableName;
return this;
}
public final String getIndexName() {
return indexName;
}
public final void setIndexName(String indexName) {
this.indexName = indexName;
}
@Override
public final Builder indexName(String indexName) {
this.indexName = indexName;
return this;
}
public final Collection getContributorInsightsRuleList() {
if (contributorInsightsRuleList instanceof SdkAutoConstructList) {
return null;
}
return contributorInsightsRuleList;
}
public final void setContributorInsightsRuleList(Collection contributorInsightsRuleList) {
this.contributorInsightsRuleList = ContributorInsightsRuleListCopier.copy(contributorInsightsRuleList);
}
@Override
public final Builder contributorInsightsRuleList(Collection contributorInsightsRuleList) {
this.contributorInsightsRuleList = ContributorInsightsRuleListCopier.copy(contributorInsightsRuleList);
return this;
}
@Override
@SafeVarargs
public final Builder contributorInsightsRuleList(String... contributorInsightsRuleList) {
contributorInsightsRuleList(Arrays.asList(contributorInsightsRuleList));
return this;
}
public final String getContributorInsightsStatus() {
return contributorInsightsStatus;
}
public final void setContributorInsightsStatus(String contributorInsightsStatus) {
this.contributorInsightsStatus = contributorInsightsStatus;
}
@Override
public final Builder contributorInsightsStatus(String contributorInsightsStatus) {
this.contributorInsightsStatus = contributorInsightsStatus;
return this;
}
@Override
public final Builder contributorInsightsStatus(ContributorInsightsStatus contributorInsightsStatus) {
this.contributorInsightsStatus(contributorInsightsStatus == null ? null : contributorInsightsStatus.toString());
return this;
}
public final Instant getLastUpdateDateTime() {
return lastUpdateDateTime;
}
public final void setLastUpdateDateTime(Instant lastUpdateDateTime) {
this.lastUpdateDateTime = lastUpdateDateTime;
}
@Override
public final Builder lastUpdateDateTime(Instant lastUpdateDateTime) {
this.lastUpdateDateTime = lastUpdateDateTime;
return this;
}
public final FailureException.Builder getFailureException() {
return failureException != null ? failureException.toBuilder() : null;
}
public final void setFailureException(FailureException.BuilderImpl failureException) {
this.failureException = failureException != null ? failureException.build() : null;
}
@Override
public final Builder failureException(FailureException failureException) {
this.failureException = failureException;
return this;
}
@Override
public DescribeContributorInsightsResponse build() {
return new DescribeContributorInsightsResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}