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

Class StartTextDetectionRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<StartTextDetectionRequest.Builder,StartTextDetectionRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StartTextDetectionRequest.Builder

Method Summary

Modifier and Type	Method	Description
static StartTextDetectionRequest.Builder	builder()
String	clientRequestToken()	Idempotent token used to identify the start request.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
StartTextDetectionFilters	filters()	Optional parameters that let you set criteria the text must meet to be included in your response.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	jobTag()	An identifier returned in the completion status published by your Amazon Simple Notification Service topic.
NotificationChannel	notificationChannel()	Returns the value of the NotificationChannel property for this object.
List<SdkField<?>>	sdkFields()
static Class<? extends StartTextDetectionRequest.Builder>	serializableBuilderClass()
StartTextDetectionRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Video	video()	Returns the value of the Video property for 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

video

public final Video video()

Returns the value of the Video property for this object.

Returns:

The value of the Video property for this object.

clientRequestToken

public final String clientRequestToken()

Idempotent token used to identify the start request. If you use the same token with multiple StartTextDetection requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidentaly started more than once.

Returns:

Idempotent token used to identify the start request. If you use the same token with multiple StartTextDetection requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidentaly started more than once.

notificationChannel

public final NotificationChannel notificationChannel()

Returns the value of the NotificationChannel property for this object.

Returns:

The value of the NotificationChannel property for this object.

jobTag

public final String jobTag()

An identifier returned in the completion status published by your Amazon Simple Notification Service topic. For example, you can use JobTag to group related jobs and identify them in the completion notification.

Returns:

An identifier returned in the completion status published by your Amazon Simple Notification Service topic. For example, you can use JobTag to group related jobs and identify them in the completion notification.

filters

public final StartTextDetectionFilters filters()

Optional parameters that let you set criteria the text must meet to be included in your response.

Returns:

Optional parameters that let you set criteria the text must meet to be included in your response.

toBuilder

public StartTextDetectionRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StartTextDetectionRequest.Builder,StartTextDetectionRequest>

Specified by:

toBuilder in class RekognitionRequest

builder

public static StartTextDetectionRequest.Builder builder()

serializableBuilderClass

public static Class<? extends StartTextDetectionRequest.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