Class DescribeContributorInsightsResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DescribeContributorInsightsResponse.Builder,
DescribeContributorInsightsResponse>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
List of names of the associated contributor insights rules.Current status of contributor insights.final String
Current status of contributor insights.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final FailureException
Returns information about the last failure that was encountered.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final boolean
For responses, this returns true if the service returned a value for the ContributorInsightsRuleList property.final int
hashCode()
final String
The name of the global secondary index being described.final Instant
Timestamp of the last time the status was changed.static Class
<? extends DescribeContributorInsightsResponse.Builder> final String
The name of the table being described.Take this object and create a builder that contains all of the current property values of this object.final 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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
tableName
The name of the table being described.
- Returns:
- The name of the table being described.
-
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 theisEmpty()
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
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
Current status of contributor insights.
If the service returns an enum value that is not available in the current SDK version,
contributorInsightsStatus
will returnContributorInsightsStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcontributorInsightsStatusAsString()
.- Returns:
- Current status of contributor insights.
- See Also:
-
contributorInsightsStatusAsString
Current status of contributor insights.
If the service returns an enum value that is not available in the current SDK version,
contributorInsightsStatus
will returnContributorInsightsStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcontributorInsightsStatusAsString()
.- Returns:
- Current status of contributor insights.
- See Also:
-
lastUpdateDateTime
Timestamp of the last time the status was changed.
- Returns:
- Timestamp of the last time the status was changed.
-
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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<DescribeContributorInsightsResponse.Builder,
DescribeContributorInsightsResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends DescribeContributorInsightsResponse.Builder> serializableBuilderClass() -
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-