public static class AttributePinResponse.Builder extends Object
Constructor and Description |
---|
Builder() |
Modifier and Type | Method and Description |
---|---|
AttributePinResponse.Builder |
attributeName(String attributeName)
Attribute that was pinned by this bulk operation.
|
AttributePinResponse.Builder |
attributeNameSpace(AttributePinResponse.AttributeNameSpace attributeNameSpace)
Namespace of the attribute whose properties were updated.
|
AttributePinResponse.Builder |
attributeStatus(AttributePinResponse.AttributeStatus attributeStatus)
Status of the attribute after this operation.
|
AttributePinResponse |
build() |
AttributePinResponse.Builder |
copy(AttributePinResponse model) |
AttributePinResponse.Builder |
notes(String notes)
Notes added to this attribute.
|
AttributePinResponse.Builder |
operationType(AttributePinResponse.OperationType operationType)
Type of operation - pin.
|
AttributePinResponse.Builder |
timeUpdated(Date timeUpdated)
Time when the attribute was activated or deactivated.
|
public AttributePinResponse.Builder attributeName(String attributeName)
Attribute that was pinned by this bulk operation.
attributeName
- the value to setpublic AttributePinResponse.Builder notes(String notes)
Notes added to this attribute.
notes
- the value to setpublic AttributePinResponse.Builder operationType(AttributePinResponse.OperationType operationType)
Type of operation - pin.
operationType
- the value to setpublic AttributePinResponse.Builder attributeNameSpace(AttributePinResponse.AttributeNameSpace attributeNameSpace)
Namespace of the attribute whose properties were updated. The attributeNameSpace will default to TRACES if it is not passed in.
attributeNameSpace
- the value to setpublic AttributePinResponse.Builder attributeStatus(AttributePinResponse.AttributeStatus attributeStatus)
Status of the attribute after this operation. The attribute can have one of the following statuses after the pin operation. The attribute can have either a success status or an error status. The status of the attribute must be correlated with the operation status property in the bulk operation metadata object. The bulk operation will be successful only when all attributes in the bulk request are processed successfully and they get a success status back. The following are successful status values of individual attribute items in a bulk attribute pin operation. ATTRIBUTE_PINNED - The attribute is marked pinned and associated notes have been added. ATTRIBUTE_ALREADY_PINNED - The caller is trying to pin an attribute that has already been pinned. DUPLICATE_ATTRIBUTE - The attribute is a duplicate of an attribute that was present in this bulk request. Note that we deduplicate the attribute collection, process only unique attributes, and call out duplicates. A duplicate attribute in a bulk request will not prevent the processing of further attributes in the bulk operation. The following values are error statuses and the bulk processing is stopped when the first error is encountered. PIN_NOT_ALLOWED - The caller has asked to pin an active attribute which is not allowed. INVALID_ATTRIBUTE - The attribute is invalid. ATTRIBUTE_NOT_PROCESSED - The attribute was not processed, as there was another attribute in this bulk request collection that resulted in a processing error.
attributeStatus
- the value to setpublic AttributePinResponse.Builder timeUpdated(Date timeUpdated)
Time when the attribute was activated or deactivated. Note that ingest might not have picked up the changes even if this time has elapsed.
timeUpdated
- the value to setpublic AttributePinResponse build()
public AttributePinResponse.Builder copy(AttributePinResponse model)
Copyright © 2016–2024. All rights reserved.