Class GetContentModerationRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.rekognition.model.RekognitionRequest
-
- software.amazon.awssdk.services.rekognition.model.GetContentModerationRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<GetContentModerationRequest.Builder,GetContentModerationRequest>
@Generated("software.amazon.awssdk:codegen") public final class GetContentModerationRequest extends RekognitionRequest implements ToCopyableBuilder<GetContentModerationRequest.Builder,GetContentModerationRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceGetContentModerationRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description ContentModerationAggregateByaggregateBy()Defines how to aggregate results of the StartContentModeration request.StringaggregateByAsString()Defines how to aggregate results of the StartContentModeration request.static GetContentModerationRequest.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()StringjobId()The identifier for the inappropriate, unwanted, or offensive content moderation job.IntegermaxResults()Maximum number of results to return per paginated call.StringnextToken()If the previous response was incomplete (because there is more data to retrieve), Amazon Rekognition returns a pagination token in the response.List<SdkField<?>>sdkFields()static Class<? extends GetContentModerationRequest.Builder>serializableBuilderClass()ContentModerationSortBysortBy()Sort to use for elements in theModerationLabelDetectionsarray.StringsortByAsString()Sort to use for elements in theModerationLabelDetectionsarray.GetContentModerationRequest.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
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
-
jobId
public final String jobId()
The identifier for the inappropriate, unwanted, or offensive content moderation job. Use
JobIdto identify the job in a subsequent call toGetContentModeration.- Returns:
- The identifier for the inappropriate, unwanted, or offensive content moderation job. Use
JobIdto identify the job in a subsequent call toGetContentModeration.
-
maxResults
public final Integer maxResults()
Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.
- Returns:
- Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.
-
nextToken
public final String nextToken()
If the previous response was incomplete (because there is more data to retrieve), Amazon Rekognition returns a pagination token in the response. You can use this pagination token to retrieve the next set of content moderation labels.
- Returns:
- If the previous response was incomplete (because there is more data to retrieve), Amazon Rekognition returns a pagination token in the response. You can use this pagination token to retrieve the next set of content moderation labels.
-
sortBy
public final ContentModerationSortBy sortBy()
Sort to use for elements in the
ModerationLabelDetectionsarray. UseTIMESTAMPto sort array elements by the time labels are detected. UseNAMEto alphabetically group elements for a label together. Within each label group, the array element are sorted by detection confidence. The default sort is byTIMESTAMP.If the service returns an enum value that is not available in the current SDK version,
sortBywill returnContentModerationSortBy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromsortByAsString().- Returns:
- Sort to use for elements in the
ModerationLabelDetectionsarray. UseTIMESTAMPto sort array elements by the time labels are detected. UseNAMEto alphabetically group elements for a label together. Within each label group, the array element are sorted by detection confidence. The default sort is byTIMESTAMP. - See Also:
ContentModerationSortBy
-
sortByAsString
public final String sortByAsString()
Sort to use for elements in the
ModerationLabelDetectionsarray. UseTIMESTAMPto sort array elements by the time labels are detected. UseNAMEto alphabetically group elements for a label together. Within each label group, the array element are sorted by detection confidence. The default sort is byTIMESTAMP.If the service returns an enum value that is not available in the current SDK version,
sortBywill returnContentModerationSortBy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromsortByAsString().- Returns:
- Sort to use for elements in the
ModerationLabelDetectionsarray. UseTIMESTAMPto sort array elements by the time labels are detected. UseNAMEto alphabetically group elements for a label together. Within each label group, the array element are sorted by detection confidence. The default sort is byTIMESTAMP. - See Also:
ContentModerationSortBy
-
aggregateBy
public final ContentModerationAggregateBy aggregateBy()
Defines how to aggregate results of the StartContentModeration request. Default aggregation option is TIMESTAMPS. SEGMENTS mode aggregates moderation labels over time.
If the service returns an enum value that is not available in the current SDK version,
aggregateBywill returnContentModerationAggregateBy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromaggregateByAsString().- Returns:
- Defines how to aggregate results of the StartContentModeration request. Default aggregation option is TIMESTAMPS. SEGMENTS mode aggregates moderation labels over time.
- See Also:
ContentModerationAggregateBy
-
aggregateByAsString
public final String aggregateByAsString()
Defines how to aggregate results of the StartContentModeration request. Default aggregation option is TIMESTAMPS. SEGMENTS mode aggregates moderation labels over time.
If the service returns an enum value that is not available in the current SDK version,
aggregateBywill returnContentModerationAggregateBy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromaggregateByAsString().- Returns:
- Defines how to aggregate results of the StartContentModeration request. Default aggregation option is TIMESTAMPS. SEGMENTS mode aggregates moderation labels over time.
- See Also:
ContentModerationAggregateBy
-
toBuilder
public GetContentModerationRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<GetContentModerationRequest.Builder,GetContentModerationRequest>- Specified by:
toBuilderin classRekognitionRequest
-
builder
public static GetContentModerationRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends GetContentModerationRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
-