Package software.amazon.awssdk.services.rekognition.model

Class DescribeProjectsRequest

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.DescribeProjectsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeProjectsRequest.Builder,DescribeProjectsRequest>

@Generated("software.amazon.awssdk:codegen")
public final class DescribeProjectsRequest
extends RekognitionRequest
implements ToCopyableBuilder<DescribeProjectsRequest.Builder,DescribeProjectsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeProjectsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeProjectsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<CustomizationFeature>	features()	Specifies the type of customization to filter projects by.
List<String>	featuresAsStrings()	Specifies the type of customization to filter projects by.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFeatures()	For responses, this returns true if the service returned a value for the Features property.
int	hashCode()
boolean	hasProjectNames()	For responses, this returns true if the service returned a value for the ProjectNames property.
Integer	maxResults()	The maximum number of results to return per paginated call.
String	nextToken()	If the previous response was incomplete (because there is more results to retrieve), Rekognition returns a pagination token in the response.
List<String>	projectNames()	A list of the projects that you want Rekognition to describe.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeProjectsRequest.Builder>	serializableBuilderClass()
DescribeProjectsRequest.Builder	toBuilder()
String	toString()	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

nextToken

public final 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.

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.

maxResults

public final 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.

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.

hasProjectNames

public final boolean hasProjectNames()

For responses, this returns true if the service returned a value for the ProjectNames property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

projectNames

public final List<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.

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 hasProjectNames() method.

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.

features

public final List<CustomizationFeature> features()

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

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 hasFeatures() method.

Returns:

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

hasFeatures

public final boolean hasFeatures()

For responses, this returns true if the service returned a value for the Features property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

featuresAsStrings

public final List<String> featuresAsStrings()

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

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 hasFeatures() method.

Returns:

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

toBuilder

public DescribeProjectsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeProjectsRequest.Builder,DescribeProjectsRequest>

Specified by:

toBuilder in class RekognitionRequest

builder

public static DescribeProjectsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeProjectsRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo