Label (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.rekognition.model.Label

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Label
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Structure containing details about the detected label, including the name, and level of confidence.

The Amazon Rekognition Image operation operation returns a hierarchical taxonomy (Parents) for detected labels and also bounding box information (Instances) for detected labels. Amazon Rekognition Video doesn't return this information and returns null for the Parents and Instances attributes.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

Label()

Constructors
Constructor and Description
`Label()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Label`	`clone()`
`boolean`	`equals(Object obj)`
`Float`	`getConfidence()` Level of confidence.
`List<Instance>`	`getInstances()` If `Label` represents an object, `Instances` contains the bounding boxes for each instance of the detected object.
`String`	`getName()` The name (label) of the object or scene.
`List<Parent>`	`getParents()` The parent labels for a label.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setConfidence(Float confidence)` Level of confidence.
`void`	`setInstances(Collection<Instance> instances)` If `Label` represents an object, `Instances` contains the bounding boxes for each instance of the detected object.
`void`	`setName(String name)` The name (label) of the object or scene.
`void`	`setParents(Collection<Parent> parents)` The parent labels for a label.
`String`	`toString()` Returns a string representation of this object.
`Label`	`withConfidence(Float confidence)` Level of confidence.
`Label`	`withInstances(Collection<Instance> instances)` If `Label` represents an object, `Instances` contains the bounding boxes for each instance of the detected object.
`Label`	`withInstances(Instance... instances)` If `Label` represents an object, `Instances` contains the bounding boxes for each instance of the detected object.
`Label`	`withName(String name)` The name (label) of the object or scene.
`Label`	`withParents(Collection<Parent> parents)` The parent labels for a label.
`Label`	`withParents(Parent... parents)` The parent labels for a label.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Label
```
public Label()
```
- Method Detail
  - setName
```
public void setName(String name)
```
    The name (label) of the object or scene.
    
    Parameters:
    
    name - The name (label) of the object or scene.
  - getName
```
public String getName()
```
    The name (label) of the object or scene.
    
    Returns:
    
    The name (label) of the object or scene.
  - withName
```
public Label withName(String name)
```
    The name (label) of the object or scene.
    
    Parameters:
    
    name - The name (label) of the object or scene.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setConfidence
```
public void setConfidence(Float confidence)
```
    Level of confidence.
    
    Parameters:
    
    confidence - Level of confidence.
  - getConfidence
```
public Float getConfidence()
```
    Level of confidence.
    
    Returns:
    
    Level of confidence.
  - withConfidence
```
public Label withConfidence(Float confidence)
```
    Level of confidence.
    
    Parameters:
    
    confidence - Level of confidence.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getInstances
```
public List<Instance> getInstances()
```
    If Label represents an object, Instances contains the bounding boxes for each instance of the detected object. Bounding boxes are returned for common object labels such as people, cars, furniture, apparel or pets.
    
    Amazon Rekognition Video does not support bounding box information for detected labels. The value of Instances is returned as null by GetLabelDetection.
    
    Returns:
    
    If Label represents an object, Instances contains the bounding boxes for each instance of the detected object. Bounding boxes are returned for common object labels such as people, cars, furniture, apparel or pets.
    
    Amazon Rekognition Video does not support bounding box information for detected labels. The value of Instances is returned as null by GetLabelDetection.
  - setInstances
```
public void setInstances(Collection<Instance> instances)
```
    If Label represents an object, Instances contains the bounding boxes for each instance of the detected object. Bounding boxes are returned for common object labels such as people, cars, furniture, apparel or pets.
    
    Amazon Rekognition Video does not support bounding box information for detected labels. The value of Instances is returned as null by GetLabelDetection.
    
    Parameters:
    
    instances - If Label represents an object, Instances contains the bounding boxes for each instance of the detected object. Bounding boxes are returned for common object labels such as people, cars, furniture, apparel or pets.
    
    Amazon Rekognition Video does not support bounding box information for detected labels. The value of Instances is returned as null by GetLabelDetection.
  - withInstances
```
public Label withInstances(Instance... instances)
```
    If Label represents an object, Instances contains the bounding boxes for each instance of the detected object. Bounding boxes are returned for common object labels such as people, cars, furniture, apparel or pets.
    
    Amazon Rekognition Video does not support bounding box information for detected labels. The value of Instances is returned as null by GetLabelDetection.
    
    NOTE: This method appends the values to the existing list (if any). Use setInstances(java.util.Collection) or withInstances(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    instances - If Label represents an object, Instances contains the bounding boxes for each instance of the detected object. Bounding boxes are returned for common object labels such as people, cars, furniture, apparel or pets.
    
    Amazon Rekognition Video does not support bounding box information for detected labels. The value of Instances is returned as null by GetLabelDetection.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withInstances
```
public Label withInstances(Collection<Instance> instances)
```
    If Label represents an object, Instances contains the bounding boxes for each instance of the detected object. Bounding boxes are returned for common object labels such as people, cars, furniture, apparel or pets.
    
    Amazon Rekognition Video does not support bounding box information for detected labels. The value of Instances is returned as null by GetLabelDetection.
    
    Parameters:
    
    instances - If Label represents an object, Instances contains the bounding boxes for each instance of the detected object. Bounding boxes are returned for common object labels such as people, cars, furniture, apparel or pets.
    
    Amazon Rekognition Video does not support bounding box information for detected labels. The value of Instances is returned as null by GetLabelDetection.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getParents
```
public List<Parent> getParents()
```
    The parent labels for a label. The response includes all ancestor labels.
    
    Amazon Rekognition Video does not support a hierarchical taxonomy of detected labels. The value of Parents is returned as null by GetLabelDetection.
    
    Returns:
    
    The parent labels for a label. The response includes all ancestor labels.
    
    Amazon Rekognition Video does not support a hierarchical taxonomy of detected labels. The value of Parents is returned as null by GetLabelDetection.
  - setParents
```
public void setParents(Collection<Parent> parents)
```
    The parent labels for a label. The response includes all ancestor labels.
    
    Amazon Rekognition Video does not support a hierarchical taxonomy of detected labels. The value of Parents is returned as null by GetLabelDetection.
    
    Parameters:
    
    parents - The parent labels for a label. The response includes all ancestor labels.
    
    Amazon Rekognition Video does not support a hierarchical taxonomy of detected labels. The value of Parents is returned as null by GetLabelDetection.
  - withParents
```
public Label withParents(Parent... parents)
```
    The parent labels for a label. The response includes all ancestor labels.
    
    Amazon Rekognition Video does not support a hierarchical taxonomy of detected labels. The value of Parents is returned as null by GetLabelDetection.
    
    NOTE: This method appends the values to the existing list (if any). Use setParents(java.util.Collection) or withParents(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    parents - The parent labels for a label. The response includes all ancestor labels.
    
    Amazon Rekognition Video does not support a hierarchical taxonomy of detected labels. The value of Parents is returned as null by GetLabelDetection.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withParents
```
public Label withParents(Collection<Parent> parents)
```
    The parent labels for a label. The response includes all ancestor labels.
    
    Amazon Rekognition Video does not support a hierarchical taxonomy of detected labels. The value of Parents is returned as null by GetLabelDetection.
    
    Parameters:
    
    parents - The parent labels for a label. The response includes all ancestor labels.
    
    Amazon Rekognition Video does not support a hierarchical taxonomy of detected labels. The value of Parents is returned as null by GetLabelDetection.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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 Label clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class Label

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Label

Method Detail

setName

getName

withName

setConfidence

getConfidence

withConfidence

getInstances

setInstances

withInstances

withInstances

getParents

setParents

withParents

withParents

toString

equals

hashCode

clone

marshall