software.amazon.awssdk.services.rekognition.model

Class ConnectedHomeSettings

java.lang.Object

software.amazon.awssdk.services.rekognition.model.ConnectedHomeSettings

All Implemented Interfaces:

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

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

Label detection settings to use on a streaming video. Defining the settings is required in the request parameter for CreateStreamProcessor. Including this setting in the CreateStreamProcessor request enables you to use the stream processor for label detection. You can then select what you want the stream processor to detect, such as people or pets. When the stream processor has started, one notification is sent for each object class specified. For example, if packages and pets are selected, one SNS notification is published the first time a package is detected and one SNS notification is published the first time a pet is detected, as well as an end-of-session summary.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ConnectedHomeSettings.Builder

Method Summary

Modifier and Type	Method and Description
static ConnectedHomeSettings.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasLabels() For responses, this returns true if the service returned a value for the Labels property.
List<String>	labels() Specifies what you want to detect in the video, such as people, packages, or pets.
Float	minConfidence() The minimum confidence required to label an object in the video.
List<SdkField<?>>	sdkFields()
static Class<? extends ConnectedHomeSettings.Builder>	serializableBuilderClass()
ConnectedHomeSettings.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

hasLabels

public final boolean hasLabels()

For responses, this returns true if the service returned a value for the Labels 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.

labels

public final List<String> labels()

Specifies what you want to detect in the video, such as people, packages, or pets. The current valid labels you can include in this list are: "PERSON", "PET", "PACKAGE", and "ALL".

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

Returns:

Specifies what you want to detect in the video, such as people, packages, or pets. The current valid labels you can include in this list are: "PERSON", "PET", "PACKAGE", and "ALL".

minConfidence

public final Float minConfidence()

The minimum confidence required to label an object in the video.

Returns:

The minimum confidence required to label an object in the video.

toBuilder

public ConnectedHomeSettings.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ConnectedHomeSettings.Builder,ConnectedHomeSettings>

builder

public static ConnectedHomeSettings.Builder builder()

serializableBuilderClass

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

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo