Class GetLabelDetectionRequestMetadata

java.lang.Object

software.amazon.awssdk.services.rekognition.model.GetLabelDetectionRequestMetadata

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<GetLabelDetectionRequestMetadata.Builder,GetLabelDetectionRequestMetadata>

@Generated("software.amazon.awssdk:codegen")
public final class GetLabelDetectionRequestMetadata
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<GetLabelDetectionRequestMetadata.Builder,GetLabelDetectionRequestMetadata>

Contains metadata about a label detection request, including the SortBy and AggregateBy options.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetLabelDetectionRequestMetadata.Builder

Method Summary

Modifier and Type	Method	Description
final LabelDetectionAggregateBy	aggregateBy()	The aggregation method chosen for a GetLabelDetection request.
final String	aggregateByAsString()	The aggregation method chosen for a GetLabelDetection request.
static GetLabelDetectionRequestMetadata.Builder	builder()
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)	Indicates whether some other object is "equal to" this one by SDK fields.
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final List<SdkField<?>>	sdkFields()
static Class<? extends GetLabelDetectionRequestMetadata.Builder>	serializableBuilderClass()
final LabelDetectionSortBy	sortBy()	The sorting method chosen for a GetLabelDetection request.
final String	sortByAsString()	The sorting method chosen for a GetLabelDetection request.
GetLabelDetectionRequestMetadata.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
final String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Details

sortBy

public final LabelDetectionSortBy sortBy()

The sorting method chosen for a GetLabelDetection request.

If the service returns an enum value that is not available in the current SDK version, sortBy will return LabelDetectionSortBy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sortByAsString().

Returns:

The sorting method chosen for a GetLabelDetection request.

See Also:

• LabelDetectionSortBy

sortByAsString

public final String sortByAsString()

The sorting method chosen for a GetLabelDetection request.

If the service returns an enum value that is not available in the current SDK version, sortBy will return LabelDetectionSortBy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sortByAsString().

Returns:

The sorting method chosen for a GetLabelDetection request.

See Also:

• LabelDetectionSortBy

aggregateBy

public final LabelDetectionAggregateBy aggregateBy()

The aggregation method chosen for a GetLabelDetection request.

If the service returns an enum value that is not available in the current SDK version, aggregateBy will return LabelDetectionAggregateBy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from aggregateByAsString().

Returns:

The aggregation method chosen for a GetLabelDetection request.

See Also:

• LabelDetectionAggregateBy

aggregateByAsString

public final String aggregateByAsString()

The aggregation method chosen for a GetLabelDetection request.

If the service returns an enum value that is not available in the current SDK version, aggregateBy will return LabelDetectionAggregateBy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from aggregateByAsString().

Returns:

The aggregation method chosen for a GetLabelDetection request.

See Also:

• LabelDetectionAggregateBy

toBuilder

public GetLabelDetectionRequestMetadata.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<GetLabelDetectionRequestMetadata.Builder,GetLabelDetectionRequestMetadata>

Returns:

a builder for type T

builder

public static GetLabelDetectionRequestMetadata.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.