* Gets the inappropriate, unwanted, or offensive content analysis results for a * Amazon Rekognition Video analysis started by StartContentModeration. * For a list of moderation labels in Amazon Rekognition, see Using the image and video moderation APIs. *
*
* Amazon Rekognition Video inappropriate or offensive content detection in a
* stored video is an asynchronous operation. You start analysis by calling
* StartContentModeration which returns a job identifier (
* JobId). When analysis finishes, Amazon Rekognition Video
* publishes a completion status to the Amazon Simple Notification Service topic
* registered in the initial call to StartContentModeration. To get
* the results of the content analysis, first check that the status value
* published to the Amazon SNS topic is SUCCEEDED. If so, call
* GetContentModeration and pass the job identifier (
* JobId) from the initial call to
* StartContentModeration.
*
* For more information, see Working with Stored Videos in the Amazon * Rekognition Devlopers Guide. *
*
* GetContentModeration returns detected inappropriate, unwanted,
* or offensive content moderation labels, and the time they are detected, in an
* array, ModerationLabels, of ContentModerationDetection
* objects.
*
* By default, the moderated labels are returned sorted by time, in milliseconds
* from the start of the video. You can also sort them by moderated label by
* specifying NAME for the SortBy input parameter.
*
* Since video analysis can return a large number of results, use the
* MaxResults parameter to limit the number of labels returned in a
* single call to GetContentModeration. If there are more results
* than specified in MaxResults, the value of
* NextToken in the operation response contains a pagination token
* for getting the next set of results. To get the next page of results, call
* GetContentModeration and populate the NextToken
* request parameter with the value of NextToken returned from the
* previous call to GetContentModeration.
*
* For more information, see moderating content in the Amazon Rekognition * Developer Guide. *
*/ public class GetContentModerationRequest extends AmazonWebServiceRequest implements Serializable { /** *
* The identifier for the inappropriate, unwanted, or offensive content
* moderation job. Use JobId to identify the job in a
* subsequent call to GetContentModeration.
*
* Constraints:
* Length: 1 - 64
* Pattern: ^[a-zA-Z0-9-_]+$
*/
private String jobId;
/**
*
* 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. *
*
* Constraints:
* Range: 1 -
*/
private Integer maxResults;
/**
*
* 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. *
*
* Constraints:
* Length: - 255
*/
private String nextToken;
/**
*
* Sort to use for elements in the ModerationLabelDetections
* array. Use TIMESTAMP to sort array elements by the time
* labels are detected. Use NAME to alphabetically group
* elements for a label together. Within each label group, the array element
* are sorted by detection confidence. The default sort is by
* TIMESTAMP.
*
* Constraints:
* Allowed Values: NAME, TIMESTAMP
*/
private String sortBy;
/**
*
* Defines how to aggregate results of the StartContentModeration request. * Default aggregation option is TIMESTAMPS. SEGMENTS mode aggregates * moderation labels over time. *
*
* Constraints:
* Allowed Values: TIMESTAMPS, SEGMENTS
*/
private String aggregateBy;
/**
*
* The identifier for the inappropriate, unwanted, or offensive content
* moderation job. Use JobId to identify the job in a
* subsequent call to GetContentModeration.
*
* Constraints:
* Length: 1 - 64
* Pattern: ^[a-zA-Z0-9-_]+$
*
* @return
* The identifier for the inappropriate, unwanted, or offensive
* content moderation job. Use JobId to identify the
* job in a subsequent call to GetContentModeration.
*
* The identifier for the inappropriate, unwanted, or offensive content
* moderation job. Use JobId to identify the job in a
* subsequent call to GetContentModeration.
*
* Constraints:
* Length: 1 - 64
* Pattern: ^[a-zA-Z0-9-_]+$
*
* @param jobId
* The identifier for the inappropriate, unwanted, or offensive
* content moderation job. Use JobId to identify the
* job in a subsequent call to GetContentModeration.
*
* The identifier for the inappropriate, unwanted, or offensive content
* moderation job. Use JobId to identify the job in a
* subsequent call to GetContentModeration.
*
* Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Length: 1 - 64
* Pattern: ^[a-zA-Z0-9-_]+$
*
* @param jobId
* The identifier for the inappropriate, unwanted, or offensive
* content moderation job. Use JobId to identify the
* job in a subsequent call to GetContentModeration.
*
* 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. *
*
* Constraints:
* Range: 1 -
*
* @return
* 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. *
*/ public Integer getMaxResults() { return 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. *
*
* Constraints:
* Range: 1 -
*
* @param 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. *
*/ public void setMaxResults(Integer maxResults) { this.maxResults = 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 a reference to this object so that method calls can be chained * together. *
* Constraints:
* Range: 1 -
*
* @param 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. *
* @return A reference to this updated object so that method calls can be * chained together. */ public GetContentModerationRequest withMaxResults(Integer maxResults) { this.maxResults = maxResults; return this; } /** ** 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. *
*
* Constraints:
* Length: - 255
*
* @return
* 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. *
*/ public String getNextToken() { return 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. *
*
* Constraints:
* Length: - 255
*
* @param 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. *
*/ public void setNextToken(String nextToken) { this.nextToken = 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 a reference to this object so that method calls can be chained * together. *
* Constraints:
* Length: - 255
*
* @param 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. *
* @return A reference to this updated object so that method calls can be * chained together. */ public GetContentModerationRequest withNextToken(String nextToken) { this.nextToken = nextToken; return this; } /** *
* Sort to use for elements in the ModerationLabelDetections
* array. Use TIMESTAMP to sort array elements by the time
* labels are detected. Use NAME to alphabetically group
* elements for a label together. Within each label group, the array element
* are sorted by detection confidence. The default sort is by
* TIMESTAMP.
*
* Constraints:
* Allowed Values: NAME, TIMESTAMP
*
* @return
* Sort to use for elements in the
* ModerationLabelDetections array. Use
* TIMESTAMP to sort array elements by the time labels
* are detected. Use NAME to alphabetically group
* elements for a label together. Within each label group, the array
* element are sorted by detection confidence. The default sort is
* by TIMESTAMP.
*
* Sort to use for elements in the ModerationLabelDetections
* array. Use TIMESTAMP to sort array elements by the time
* labels are detected. Use NAME to alphabetically group
* elements for a label together. Within each label group, the array element
* are sorted by detection confidence. The default sort is by
* TIMESTAMP.
*
* Constraints:
* Allowed Values: NAME, TIMESTAMP
*
* @param sortBy
* Sort to use for elements in the
* ModerationLabelDetections array. Use
* TIMESTAMP to sort array elements by the time
* labels are detected. Use NAME to alphabetically
* group elements for a label together. Within each label group,
* the array element are sorted by detection confidence. The
* default sort is by TIMESTAMP.
*
* Sort to use for elements in the ModerationLabelDetections
* array. Use TIMESTAMP to sort array elements by the time
* labels are detected. Use NAME to alphabetically group
* elements for a label together. Within each label group, the array element
* are sorted by detection confidence. The default sort is by
* TIMESTAMP.
*
* Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Allowed Values: NAME, TIMESTAMP
*
* @param sortBy
* Sort to use for elements in the
* ModerationLabelDetections array. Use
* TIMESTAMP to sort array elements by the time
* labels are detected. Use NAME to alphabetically
* group elements for a label together. Within each label group,
* the array element are sorted by detection confidence. The
* default sort is by TIMESTAMP.
*
* Sort to use for elements in the ModerationLabelDetections
* array. Use TIMESTAMP to sort array elements by the time
* labels are detected. Use NAME to alphabetically group
* elements for a label together. Within each label group, the array element
* are sorted by detection confidence. The default sort is by
* TIMESTAMP.
*
* Constraints:
* Allowed Values: NAME, TIMESTAMP
*
* @param sortBy
* Sort to use for elements in the
* ModerationLabelDetections array. Use
* TIMESTAMP to sort array elements by the time
* labels are detected. Use NAME to alphabetically
* group elements for a label together. Within each label group,
* the array element are sorted by detection confidence. The
* default sort is by TIMESTAMP.
*
* Sort to use for elements in the ModerationLabelDetections
* array. Use TIMESTAMP to sort array elements by the time
* labels are detected. Use NAME to alphabetically group
* elements for a label together. Within each label group, the array element
* are sorted by detection confidence. The default sort is by
* TIMESTAMP.
*
* Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Allowed Values: NAME, TIMESTAMP
*
* @param sortBy
* Sort to use for elements in the
* ModerationLabelDetections array. Use
* TIMESTAMP to sort array elements by the time
* labels are detected. Use NAME to alphabetically
* group elements for a label together. Within each label group,
* the array element are sorted by detection confidence. The
* default sort is by TIMESTAMP.
*
* Defines how to aggregate results of the StartContentModeration request. * Default aggregation option is TIMESTAMPS. SEGMENTS mode aggregates * moderation labels over time. *
*
* Constraints:
* Allowed Values: TIMESTAMPS, SEGMENTS
*
* @return
* Defines how to aggregate results of the StartContentModeration * request. Default aggregation option is TIMESTAMPS. SEGMENTS mode * aggregates moderation labels over time. *
* @see ContentModerationAggregateBy */ public String getAggregateBy() { return aggregateBy; } /** ** Defines how to aggregate results of the StartContentModeration request. * Default aggregation option is TIMESTAMPS. SEGMENTS mode aggregates * moderation labels over time. *
*
* Constraints:
* Allowed Values: TIMESTAMPS, SEGMENTS
*
* @param aggregateBy
* Defines how to aggregate results of the StartContentModeration * request. Default aggregation option is TIMESTAMPS. SEGMENTS * mode aggregates moderation labels over time. *
* @see ContentModerationAggregateBy */ public void setAggregateBy(String aggregateBy) { this.aggregateBy = aggregateBy; } /** ** Defines how to aggregate results of the StartContentModeration request. * Default aggregation option is TIMESTAMPS. SEGMENTS mode aggregates * moderation labels over time. *
** Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Allowed Values: TIMESTAMPS, SEGMENTS
*
* @param aggregateBy
* Defines how to aggregate results of the StartContentModeration * request. Default aggregation option is TIMESTAMPS. SEGMENTS * mode aggregates moderation labels over time. *
* @return A reference to this updated object so that method calls can be * chained together. * @see ContentModerationAggregateBy */ public GetContentModerationRequest withAggregateBy(String aggregateBy) { this.aggregateBy = aggregateBy; return this; } /** ** Defines how to aggregate results of the StartContentModeration request. * Default aggregation option is TIMESTAMPS. SEGMENTS mode aggregates * moderation labels over time. *
*
* Constraints:
* Allowed Values: TIMESTAMPS, SEGMENTS
*
* @param aggregateBy
* Defines how to aggregate results of the StartContentModeration * request. Default aggregation option is TIMESTAMPS. SEGMENTS * mode aggregates moderation labels over time. *
* @see ContentModerationAggregateBy */ public void setAggregateBy(ContentModerationAggregateBy aggregateBy) { this.aggregateBy = aggregateBy.toString(); } /** ** Defines how to aggregate results of the StartContentModeration request. * Default aggregation option is TIMESTAMPS. SEGMENTS mode aggregates * moderation labels over time. *
** Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Allowed Values: TIMESTAMPS, SEGMENTS
*
* @param aggregateBy
* Defines how to aggregate results of the StartContentModeration * request. Default aggregation option is TIMESTAMPS. SEGMENTS * mode aggregates moderation labels over time. *
* @return A reference to this updated object so that method calls can be * chained together. * @see ContentModerationAggregateBy */ public GetContentModerationRequest withAggregateBy(ContentModerationAggregateBy aggregateBy) { this.aggregateBy = aggregateBy.toString(); return this; } /** * Returns a string representation of this object; useful for testing and * debugging. * * @return A string representation of this object. * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getJobId() != null) sb.append("JobId: " + getJobId() + ","); if (getMaxResults() != null) sb.append("MaxResults: " + getMaxResults() + ","); if (getNextToken() != null) sb.append("NextToken: " + getNextToken() + ","); if (getSortBy() != null) sb.append("SortBy: " + getSortBy() + ","); if (getAggregateBy() != null) sb.append("AggregateBy: " + getAggregateBy()); sb.append("}"); return sb.toString(); } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getJobId() == null) ? 0 : getJobId().hashCode()); hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode()); hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode()); hashCode = prime * hashCode + ((getSortBy() == null) ? 0 : getSortBy().hashCode()); hashCode = prime * hashCode + ((getAggregateBy() == null) ? 0 : getAggregateBy().hashCode()); return hashCode; } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof GetContentModerationRequest == false) return false; GetContentModerationRequest other = (GetContentModerationRequest) obj; if (other.getJobId() == null ^ this.getJobId() == null) return false; if (other.getJobId() != null && other.getJobId().equals(this.getJobId()) == false) return false; if (other.getMaxResults() == null ^ this.getMaxResults() == null) return false; if (other.getMaxResults() != null && other.getMaxResults().equals(this.getMaxResults()) == false) return false; if (other.getNextToken() == null ^ this.getNextToken() == null) return false; if (other.getNextToken() != null && other.getNextToken().equals(this.getNextToken()) == false) return false; if (other.getSortBy() == null ^ this.getSortBy() == null) return false; if (other.getSortBy() != null && other.getSortBy().equals(this.getSortBy()) == false) return false; if (other.getAggregateBy() == null ^ this.getAggregateBy() == null) return false; if (other.getAggregateBy() != null && other.getAggregateBy().equals(this.getAggregateBy()) == false) return false; return true; } }