com.amazonaws.services.rekognition.model

Class DescribeProjectsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.rekognition.model.DescribeProjectsRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribeProjectsRequest
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
DescribeProjectsRequest()

Method Summary

Modifier and Type	Method and Description
DescribeProjectsRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
List<String>	getFeatures() Specifies the type of customization to filter projects by.
Integer	getMaxResults() The maximum number of results to return per paginated call.
String	getNextToken() If the previous response was incomplete (because there is more results to retrieve), Rekognition returns a pagination token in the response.
List<String>	getProjectNames() A list of the projects that you want Rekognition to describe.
int	hashCode()
void	setFeatures(Collection<String> features) Specifies the type of customization to filter projects by.
void	setMaxResults(Integer maxResults) The maximum number of results to return per paginated call.
void	setNextToken(String nextToken) If the previous response was incomplete (because there is more results to retrieve), Rekognition returns a pagination token in the response.
void	setProjectNames(Collection<String> projectNames) A list of the projects that you want Rekognition to describe.
String	toString() Returns a string representation of this object.
DescribeProjectsRequest	withFeatures(Collection<String> features) Specifies the type of customization to filter projects by.
DescribeProjectsRequest	withFeatures(CustomizationFeature... features) Specifies the type of customization to filter projects by.
DescribeProjectsRequest	withFeatures(String... features) Specifies the type of customization to filter projects by.
DescribeProjectsRequest	withMaxResults(Integer maxResults) The maximum number of results to return per paginated call.
DescribeProjectsRequest	withNextToken(String nextToken) If the previous response was incomplete (because there is more results to retrieve), Rekognition returns a pagination token in the response.
DescribeProjectsRequest	withProjectNames(Collection<String> projectNames) A list of the projects that you want Rekognition to describe.
DescribeProjectsRequest	withProjectNames(String... projectNames) A list of the projects that you want Rekognition to describe.

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

DescribeProjectsRequest

public DescribeProjectsRequest()

Method Detail

setNextToken

public void setNextToken(String nextToken)

If the previous response was incomplete (because there is more results to retrieve), Rekognition returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.

Parameters:

nextToken - If the previous response was incomplete (because there is more results to retrieve), Rekognition returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.

getNextToken

public String getNextToken()

If the previous response was incomplete (because there is more results to retrieve), Rekognition returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.

Returns:

If the previous response was incomplete (because there is more results to retrieve), Rekognition returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.

withNextToken

public DescribeProjectsRequest withNextToken(String nextToken)

If the previous response was incomplete (because there is more results to retrieve), Rekognition returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.

Parameters:

nextToken - If the previous response was incomplete (because there is more results to retrieve), Rekognition returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.

Returns:

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

setMaxResults

public void setMaxResults(Integer maxResults)

The maximum number of results to return per paginated call. The largest value you can specify is 100. If you specify a value greater than 100, a ValidationException error occurs. The default value is 100.

Parameters:

maxResults - The maximum number of results to return per paginated call. The largest value you can specify is 100. If you specify a value greater than 100, a ValidationException error occurs. The default value is 100.

getMaxResults

public Integer getMaxResults()

The maximum number of results to return per paginated call. The largest value you can specify is 100. If you specify a value greater than 100, a ValidationException error occurs. The default value is 100.

Returns:

The maximum number of results to return per paginated call. The largest value you can specify is 100. If you specify a value greater than 100, a ValidationException error occurs. The default value is 100.

withMaxResults

public DescribeProjectsRequest withMaxResults(Integer maxResults)

The maximum number of results to return per paginated call. The largest value you can specify is 100. If you specify a value greater than 100, a ValidationException error occurs. The default value is 100.

Parameters:

maxResults - The maximum number of results to return per paginated call. The largest value you can specify is 100. If you specify a value greater than 100, a ValidationException error occurs. The default value is 100.

Returns:

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

getProjectNames

public List<String> getProjectNames()

A list of the projects that you want Rekognition to describe. If you don't specify a value, the response includes descriptions for all the projects in your AWS account.

Returns:

A list of the projects that you want Rekognition to describe. If you don't specify a value, the response includes descriptions for all the projects in your AWS account.

setProjectNames

public void setProjectNames(Collection<String> projectNames)

A list of the projects that you want Rekognition to describe. If you don't specify a value, the response includes descriptions for all the projects in your AWS account.

Parameters:

projectNames - A list of the projects that you want Rekognition to describe. If you don't specify a value, the response includes descriptions for all the projects in your AWS account.

withProjectNames

public DescribeProjectsRequest withProjectNames(String... projectNames)

A list of the projects that you want Rekognition to describe. If you don't specify a value, the response includes descriptions for all the projects in your AWS account.

NOTE: This method appends the values to the existing list (if any). Use setProjectNames(java.util.Collection) or withProjectNames(java.util.Collection) if you want to override the existing values.

Parameters:

projectNames - A list of the projects that you want Rekognition to describe. If you don't specify a value, the response includes descriptions for all the projects in your AWS account.

Returns:

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

withProjectNames

public DescribeProjectsRequest withProjectNames(Collection<String> projectNames)

A list of the projects that you want Rekognition to describe. If you don't specify a value, the response includes descriptions for all the projects in your AWS account.

Parameters:

projectNames - A list of the projects that you want Rekognition to describe. If you don't specify a value, the response includes descriptions for all the projects in your AWS account.

Returns:

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

getFeatures

public List<String> getFeatures()

Specifies the type of customization to filter projects by. If no value is specified, CUSTOM_LABELS is used as a default.

Returns:

Specifies the type of customization to filter projects by. If no value is specified, CUSTOM_LABELS is used as a default.

See Also:

CustomizationFeature

setFeatures

public void setFeatures(Collection<String> features)

Specifies the type of customization to filter projects by. If no value is specified, CUSTOM_LABELS is used as a default.

Parameters:

features - Specifies the type of customization to filter projects by. If no value is specified, CUSTOM_LABELS is used as a default.

See Also:

CustomizationFeature

withFeatures

public DescribeProjectsRequest withFeatures(String... features)

Specifies the type of customization to filter projects by. If no value is specified, CUSTOM_LABELS is used as a default.

NOTE: This method appends the values to the existing list (if any). Use setFeatures(java.util.Collection) or withFeatures(java.util.Collection) if you want to override the existing values.

Parameters:

features - Specifies the type of customization to filter projects by. If no value is specified, CUSTOM_LABELS is used as a default.

Returns:

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

See Also:

CustomizationFeature

withFeatures

public DescribeProjectsRequest withFeatures(Collection<String> features)

Specifies the type of customization to filter projects by. If no value is specified, CUSTOM_LABELS is used as a default.

Parameters:

features - Specifies the type of customization to filter projects by. If no value is specified, CUSTOM_LABELS is used as a default.

Returns:

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

See Also:

CustomizationFeature

withFeatures

public DescribeProjectsRequest withFeatures(CustomizationFeature... features)

Specifies the type of customization to filter projects by. If no value is specified, CUSTOM_LABELS is used as a default.

Parameters:

features - Specifies the type of customization to filter projects by. If no value is specified, CUSTOM_LABELS is used as a default.

Returns:

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

See Also:

CustomizationFeature

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 DescribeProjectsRequest 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()