com.amazonaws.services.rekognition.model

Class GetContentModerationRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.rekognition.model.GetContentModerationRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GetContentModerationRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
GetContentModerationRequest()

Method Summary

Modifier and Type	Method and Description
GetContentModerationRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getAggregateBy() Defines how to aggregate results of the StartContentModeration request.
String	getJobId() The identifier for the inappropriate, unwanted, or offensive content moderation job.
Integer	getMaxResults() Maximum number of results to return per paginated call.
String	getNextToken() If the previous response was incomplete (because there is more data to retrieve), Amazon Rekognition returns a pagination token in the response.
String	getSortBy() Sort to use for elements in the ModerationLabelDetections array.
int	hashCode()
void	setAggregateBy(String aggregateBy) Defines how to aggregate results of the StartContentModeration request.
void	setJobId(String jobId) The identifier for the inappropriate, unwanted, or offensive content moderation job.
void	setMaxResults(Integer maxResults) Maximum number of results to return per paginated call.
void	setNextToken(String nextToken) If the previous response was incomplete (because there is more data to retrieve), Amazon Rekognition returns a pagination token in the response.
void	setSortBy(String sortBy) Sort to use for elements in the ModerationLabelDetections array.
String	toString() Returns a string representation of this object.
GetContentModerationRequest	withAggregateBy(ContentModerationAggregateBy aggregateBy) Defines how to aggregate results of the StartContentModeration request.
GetContentModerationRequest	withAggregateBy(String aggregateBy) Defines how to aggregate results of the StartContentModeration request.
GetContentModerationRequest	withJobId(String jobId) The identifier for the inappropriate, unwanted, or offensive content moderation job.
GetContentModerationRequest	withMaxResults(Integer maxResults) Maximum number of results to return per paginated call.
GetContentModerationRequest	withNextToken(String nextToken) If the previous response was incomplete (because there is more data to retrieve), Amazon Rekognition returns a pagination token in the response.
GetContentModerationRequest	withSortBy(ContentModerationSortBy sortBy) Sort to use for elements in the ModerationLabelDetections array.
GetContentModerationRequest	withSortBy(String sortBy) Sort to use for elements in the ModerationLabelDetections array.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GetContentModerationRequest

public GetContentModerationRequest()

Method Detail

setJobId

public void setJobId(String jobId)

The identifier for the inappropriate, unwanted, or offensive content moderation job. Use JobId to identify the job in a subsequent call to GetContentModeration.

Parameters:

jobId - The identifier for the inappropriate, unwanted, or offensive content moderation job. Use JobId to identify the job in a subsequent call to GetContentModeration.

getJobId

public String getJobId()

The identifier for the inappropriate, unwanted, or offensive content moderation job. Use JobId to identify the job in a subsequent call to GetContentModeration.

Returns:

The identifier for the inappropriate, unwanted, or offensive content moderation job. Use JobId to identify the job in a subsequent call to GetContentModeration.

withJobId

public GetContentModerationRequest withJobId(String jobId)

The identifier for the inappropriate, unwanted, or offensive content moderation job. Use JobId to identify the job in a subsequent call to GetContentModeration.

Parameters:

jobId - The identifier for the inappropriate, unwanted, or offensive content moderation job. Use JobId to identify the job in a subsequent call to GetContentModeration.

Returns:

Returns a reference to this object so that method calls can be chained together.

setMaxResults

public void setMaxResults(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.

Parameters:

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.

getMaxResults

public Integer getMaxResults()

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.

withMaxResults

public GetContentModerationRequest withMaxResults(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setNextToken

public void setNextToken(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.

Parameters:

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.

getNextToken

public String getNextToken()

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.

withNextToken

public GetContentModerationRequest withNextToken(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setSortBy

public void setSortBy(String 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.

Parameters:

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.

See Also:

ContentModerationSortBy

getSortBy

public String getSortBy()

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:

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.

See Also:

ContentModerationSortBy

withSortBy

public GetContentModerationRequest withSortBy(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ContentModerationSortBy

withSortBy

public GetContentModerationRequest withSortBy(ContentModerationSortBy 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ContentModerationSortBy

setAggregateBy

public void setAggregateBy(String aggregateBy)

Defines how to aggregate results of the StartContentModeration request. Default aggregation option is TIMESTAMPS. SEGMENTS mode aggregates moderation labels over time.

Parameters:

aggregateBy - Defines how to aggregate results of the StartContentModeration request. Default aggregation option is TIMESTAMPS. SEGMENTS mode aggregates moderation labels over time.

See Also:

ContentModerationAggregateBy

getAggregateBy

public String getAggregateBy()

Defines how to aggregate results of the StartContentModeration request. Default aggregation option is TIMESTAMPS. SEGMENTS mode aggregates moderation labels over time.

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

withAggregateBy

public GetContentModerationRequest withAggregateBy(String aggregateBy)

Defines how to aggregate results of the StartContentModeration request. Default aggregation option is TIMESTAMPS. SEGMENTS mode aggregates moderation labels over time.

Parameters:

aggregateBy - Defines how to aggregate results of the StartContentModeration request. Default aggregation option is TIMESTAMPS. SEGMENTS mode aggregates moderation labels over time.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ContentModerationAggregateBy

withAggregateBy

public GetContentModerationRequest withAggregateBy(ContentModerationAggregateBy aggregateBy)

Defines how to aggregate results of the StartContentModeration request. Default aggregation option is TIMESTAMPS. SEGMENTS mode aggregates moderation labels over time.

Parameters:

aggregateBy - Defines how to aggregate results of the StartContentModeration request. Default aggregation option is TIMESTAMPS. SEGMENTS mode aggregates moderation labels over time.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ContentModerationAggregateBy

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public GetContentModerationRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()