com.oracle.bmc.apmtraces.model

Class AttributePinResponse

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.apmtraces.model.AttributePinResponse

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20200630")
public final class AttributePinResponse
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

Response of an individual attribute item in the bulk pin operation.
Note: Objects should always be created or deserialized using the AttributePinResponse.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 AttributePinResponse.Builder, which maintain a set of all explicitly set fields called AttributePinResponse.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).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AttributePinResponse.AttributeNameSpace Namespace of the attribute whose properties were updated.
static class	AttributePinResponse.AttributeStatus Status of the attribute after this operation.
static class	AttributePinResponse.Builder
static class	AttributePinResponse.OperationType Type of operation - pin.

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor and Description
AttributePinResponse(String attributeName, String notes, AttributePinResponse.OperationType operationType, AttributePinResponse.AttributeNameSpace attributeNameSpace, AttributePinResponse.AttributeStatus attributeStatus, Date timeUpdated) Deprecated.

Method Summary

Modifier and Type	Method and Description
static AttributePinResponse.Builder	builder() Create a new builder.
boolean	equals(Object o)
String	getAttributeName() Attribute that was pinned by this bulk operation.
AttributePinResponse.AttributeNameSpace	getAttributeNameSpace() Namespace of the attribute whose properties were updated.
AttributePinResponse.AttributeStatus	getAttributeStatus() Status of the attribute after this operation.
String	getNotes() Notes added to this attribute.
AttributePinResponse.OperationType	getOperationType() Type of operation - pin.
Date	getTimeUpdated() Time when the attribute was activated or deactivated.
int	hashCode()
AttributePinResponse.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents) Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AttributePinResponse

@Deprecated
 @ConstructorProperties(value={"attributeName","notes","operationType","attributeNameSpace","attributeStatus","timeUpdated"})
public AttributePinResponse(String attributeName,
                                                                                                                                                                      String notes,
                                                                                                                                                                      AttributePinResponse.OperationType operationType,
                                                                                                                                                                      AttributePinResponse.AttributeNameSpace attributeNameSpace,
                                                                                                                                                                      AttributePinResponse.AttributeStatus attributeStatus,
                                                                                                                                                                      Date timeUpdated)

Deprecated.

Method Detail

builder

public static AttributePinResponse.Builder builder()

Create a new builder.

toBuilder

public AttributePinResponse.Builder toBuilder()

getAttributeName

public String getAttributeName()

Attribute that was pinned by this bulk operation.

Returns:

the value

getNotes

public String getNotes()

Notes added to this attribute.

Returns:

the value

getOperationType

public AttributePinResponse.OperationType getOperationType()

Type of operation - pin.

Returns:

the value

getAttributeNameSpace

public AttributePinResponse.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 AttributePinResponse.AttributeStatus getAttributeStatus()

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.

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