Package com.oracle.bmc.apmtraces.model

Class AttributeResponse

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20200630")
public final class AttributeResponse
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    Response of an individual attribute item in the bulk activate or deactivate operation.
    Note: Objects should always be created or deserialized using the AttributeResponse.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the AttributeResponse.Builder, which maintain a set of all explicitly set fields called AttributeResponse.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

    • Method Detail

      • getAttributeName

        public String getAttributeName()
        Attribute that was activated or deactivated by this bulk operation.
        Returns:
        the value

      • getNotes

        public String getNotes()
        Notes for the activated attribute.
        Returns:
        the value

      • getAttributeNameSpace

        public AttributeResponse.AttributeNameSpace getAttributeNameSpace()
        Namespace of the attribute whose properties were updated.

        The attributeNamespace will default to TRACES if it is not passed in.

        Returns:
        the value

      • getAttributeStatus

        public AttributeResponse.AttributeStatus getAttributeStatus()
        Status of the attribute after this operation.

        The attribute can have one of the following statuses after the activate or deactivate 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 successful and they get a success status back. The following are successful status values of individual attribute items in a bulk attribute activation operation. ATTRIBUTE_ACTIVATED - The attribute is activated and is available to be queried. Note that ingest might still have not picked up the changes, and the associated caches would not have refreshed yet to pick up the changes. ATTRIBUTE_ALREADY_ACTIVE - The caller is trying to activate an attribute that is already active or in the process of getting activated. ATTRIBUTE_DEACTIVATED - The attribute is deactivated and will not appear in searches. Ingest might not have picked up the new changes and the associated caches might not have refreshed yet. ATTRIBUTE_ALREADY_DEACTIVATED - The caller is trying to deactivate an attribute that has already been deactivated or in the process of deactivation. 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. None of the attributes in the bulk request would have been activated or deactivated by this bulk operation. DEACTIVATION_NOT_ALLOWED - The caller has asked for the deactivation of an out of box tag which is not permitted. ATTRIBUTE_DOES_NOT_EXIST - The caller tries to deactivate an attribute that doesn’t exist in the APM Domain. INVALID_ATTRIBUTE - The attribute is invalid. INVALID_ATTRIBUTE_TYPE_CONFLICT - The attribute is invalid. There were two attributes with same name but different type in the bulk request. ATTRIBUTE_NOT_PROCESSED - The attribute was not processed, as there was another attribute in this bulk request collection that resulted in a processing error. ATTRIBUTE_UPDATE_NOT_ALLOWED - The unit of the attribute cannot be updated as it is an in-built system attribute.

        Returns:
        the value

      • getTimeUpdated

        public Date getTimeUpdated()
        Time when the attribute was activated or deactivated.

        Note that ingest might not have picked up the changes even if this time has elapsed.

        Returns:
        the value

      • toString

        public String toString()
        Overrides:
        toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • toString

        public String toString​(boolean includeByteArrayContents)
        Return a string representation of the object.
        Parameters:
        includeByteArrayContents - true to include the full contents of byte arrays
        Returns:
        string representation

      • equals

        public boolean equals​(Object o)
        Overrides:
        equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel