Package software.amazon.awssdk.services.dynamodb.model

Class DescribeContributorInsightsResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.dynamodb.model.DynamoDbResponse

software.amazon.awssdk.services.dynamodb.model.DescribeContributorInsightsResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeContributorInsightsResponse.Builder,DescribeContributorInsightsResponse>

@Generated("software.amazon.awssdk:codegen")
public final class DescribeContributorInsightsResponse
extends DynamoDbResponse
implements ToCopyableBuilder<DescribeContributorInsightsResponse.Builder,DescribeContributorInsightsResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeContributorInsightsResponse.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeContributorInsightsResponse.Builder	builder()
List<String>	contributorInsightsRuleList()	List of names of the associated contributor insights rules.
ContributorInsightsStatus	contributorInsightsStatus()	Current status of contributor insights.
String	contributorInsightsStatusAsString()	Current status of contributor insights.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
FailureException	failureException()	Returns information about the last failure that was encountered.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasContributorInsightsRuleList()	For responses, this returns true if the service returned a value for the ContributorInsightsRuleList property.
int	hashCode()
String	indexName()	The name of the global secondary index being described.
Instant	lastUpdateDateTime()	Timestamp of the last time the status was changed.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeContributorInsightsResponse.Builder>	serializableBuilderClass()
String	tableName()	The name of the table being described.
DescribeContributorInsightsResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.dynamodb.model.DynamoDbResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

tableName

public final String tableName()

The name of the table being described.

Returns:

The name of the table being described.

indexName

public final String indexName()

The name of the global secondary index being described.

Returns:

The name of the global secondary index being described.

hasContributorInsightsRuleList

public final boolean hasContributorInsightsRuleList()

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 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.

contributorInsightsRuleList

public final List<String> contributorInsightsRuleList()

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 hasContributorInsightsRuleList() method.

Returns:

List of names of the associated contributor insights rules.

contributorInsightsStatus

public final ContributorInsightsStatus contributorInsightsStatus()

Current status of contributor insights.

If the service returns an enum value that is not available in the current SDK version, contributorInsightsStatus will return ContributorInsightsStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from contributorInsightsStatusAsString().

Returns:

Current status of contributor insights.

See Also:

ContributorInsightsStatus

contributorInsightsStatusAsString

public final String contributorInsightsStatusAsString()

Current status of contributor insights.

If the service returns an enum value that is not available in the current SDK version, contributorInsightsStatus will return ContributorInsightsStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from contributorInsightsStatusAsString().

Returns:

Current status of contributor insights.

See Also:

ContributorInsightsStatus

lastUpdateDateTime

public final Instant lastUpdateDateTime()

Timestamp of the last time the status was changed.

Returns:

Timestamp of the last time the status was changed.

failureException

public final 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.

Returns:

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.

toBuilder

public DescribeContributorInsightsResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeContributorInsightsResponse.Builder,DescribeContributorInsightsResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static DescribeContributorInsightsResponse.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeContributorInsightsResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo