Skip to content

CreateLabelRequest

Source code in docs_src/capo_lookoutequipment/types/create_label_request.py 
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
class CreateLabelRequest(TypedDict, closed=True):
    label_group_name: "capo_lookoutequipment.types.label_group_name.LabelGroupName"
    """<p> The name of a group of labels. </p> <p>Data in this field will be retained for service usage. Follow best practices for the security of your data. </p>"""
    start_time: "capo_lookoutequipment.types.timestamp.Timestamp"
    """<p> The start time of the labeled event. </p>"""
    end_time: "capo_lookoutequipment.types.timestamp.Timestamp"
    """<p> The end time of the labeled event. </p>"""
    rating: "capo_lookoutequipment.types.label_rating.LabelRating"
    """<p> Indicates whether a labeled event represents an anomaly. </p>"""
    fault_code: NotRequired["capo_lookoutequipment.types.fault_code.FaultCode"]
    """<p> Provides additional information about the label. The fault code must be defined in the FaultCodes attribute of the label group.</p> <p>Data in this field will be retained for service usage. Follow best practices for the security of your data. </p>"""
    notes: NotRequired["capo_lookoutequipment.types.comments.Comments"]
    """<p> Metadata providing additional information about the label. </p> <p>Data in this field will be retained for service usage. Follow best practices for the security of your data.</p>"""
    equipment: NotRequired["capo_lookoutequipment.types.equipment.Equipment"]
    """<p> Indicates that a label pertains to a particular piece of equipment. </p> <p>Data in this field will be retained for service usage. Follow best practices for the security of your data.</p>"""
    client_token: "capo_lookoutequipment.types.idempotence_token.IdempotenceToken"
    """<p> A unique identifier for the request to create a label. If you do not set the client request token, Lookout for Equipment generates one. </p>"""

client_token instance-attribute 

client_token: IdempotenceToken

A unique identifier for the request to create a label. If you do not set the client request token, Lookout for Equipment generates one.

end_time instance-attribute 

end_time: Timestamp

The end time of the labeled event.

equipment instance-attribute 

equipment: NotRequired[Equipment]

Indicates that a label pertains to a particular piece of equipment.

Data in this field will be retained for service usage. Follow best practices for the security of your data.

fault_code instance-attribute 

fault_code: NotRequired[FaultCode]

Provides additional information about the label. The fault code must be defined in the FaultCodes attribute of the label group.

Data in this field will be retained for service usage. Follow best practices for the security of your data.

label_group_name instance-attribute 

label_group_name: LabelGroupName

The name of a group of labels.

Data in this field will be retained for service usage. Follow best practices for the security of your data.

notes instance-attribute 

notes: NotRequired[Comments]

Metadata providing additional information about the label.

Data in this field will be retained for service usage. Follow best practices for the security of your data.

rating instance-attribute 

rating: LabelRating

Indicates whether a labeled event represents an anomaly.

start_time instance-attribute 

start_time: Timestamp

The start time of the labeled event.