ControllerResponse (venice API)

java.lang.Object
- com.linkedin.venice.controllerapi.ControllerResponse

Direct Known Subclasses:

AclResponse, AdminCommandExecutionResponse, AdminTopicMetadataResponse, ChildAwareResponse, ClusterStaleDataAuditResponse, D2ServiceDiscoveryResponse, HybridStoreQuotaStatusResponse, IncrementalPushVersionsResponse, JobStatusQueryResponse, LastSucceedExecutionIdResponse, LeaderControllerResponse, MigrationPushStrategyResponse, MultiNodeResponse, MultiNodesStatusResponse, MultiReplicaResponse, MultiSchemaIdResponse, MultiSchemaResponse, MultiStoragePersonaResponse, MultiStoreInfoResponse, MultiStoreResponse, MultiStoreStatusResponse, MultiStoreTopicsResponse, MultiVersionStatusResponse, NewStoreResponse, NodeReplicasReadinessResponse, NodeStatusResponse, OwnerResponse, PartitionResponse, PubSubTopicConfigResponse, PushJobStatusUploadResponse, PushStatusResponse, ReadyForDataRecoveryResponse, RegionPushDetailsResponse, RepushInfoResponse, ResourceStateResponse, RoutersClusterConfigResponse, SchemaResponse, SchemaUsageResponse, StorageEngineOverheadRatioResponse, StoragePersonaResponse, StoreComparisonResponse, StoreHealthAuditResponse, StoreMigrationResponse, StoreResponse, SystemStoreHeartbeatResponse, TrackableControllerResponse, VersionResponse
```
public class ControllerResponse
extends java.lang.Object
```
Extend this class to create response objects for the controller Any fields that must be in all responses can go here.

Constructor Summary

Constructors
Constructor Description

ControllerResponse()

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`java.lang.String`	`getCluster()`
`java.lang.String`	`getError()`
`ErrorType`	`getErrorType()`
`ExceptionType`	`getExceptionType()`	Deprecated.
`java.lang.String`	`getName()`
`boolean`	`isError()`	Starting with Jackson 1.9, if this is the only annotation: `JsonIgnore` associated with a property, it will also cause the whole property to be ignored.
`void`	`setCluster(java.lang.String cluster)`
`void`	`setError(java.lang.String error)`
`void`	`setError(java.lang.String error, java.lang.Throwable e)`
`void`	`setError(java.lang.Throwable e)`
`void`	`setErrorType(ErrorType errorType)`
`void`	`setName(java.lang.String name)`
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail
- ControllerResponse
```
public ControllerResponse()
```

Method Detail

isError
```
public boolean isError()
```
Starting with Jackson 1.9, if this is the only annotation: JsonIgnore associated with a property, it will also cause the whole property to be ignored. So we need to explicitly specify JsonProperty with getError() and setError(String)

Returns:

getCluster
```
public java.lang.String getCluster()
```

setCluster

public void setCluster(java.lang.String cluster)

getName
```
public java.lang.String getName()
```

getErrorType
```
public ErrorType getErrorType()
```

getExceptionType

@Deprecated
public ExceptionType getExceptionType()

Deprecated.

setName

public void setName(java.lang.String name)

getError
```
public java.lang.String getError()
```

setError

public void setError(java.lang.String error)

setError

public void setError(java.lang.String error,
                     java.lang.Throwable e)

setError

public void setError(java.lang.Throwable e)

setErrorType

public void setErrorType(ErrorType errorType)

toString
```
public java.lang.String toString()
```
Overrides:

toString in class java.lang.Object