Package com.ibm.cloud.cloudant.v1.model

Class DocumentResult

java.lang.Object

com.ibm.cloud.sdk.core.service.model.GenericModel

com.ibm.cloud.cloudant.v1.model.DocumentResult

All Implemented Interfaces:

com.ibm.cloud.sdk.core.service.model.ObjectModel

public class DocumentResult
extends com.ibm.cloud.sdk.core.service.model.GenericModel

Schema for the result of a document modification.

Constructor Summary

Constructors

Constructor	Description
DocumentResult()

Method Summary

Modifier and Type	Method	Description
String	getCausedBy()	Gets the causedBy.
String	getError()	Gets the error.
String	getId()	Gets the id.
String	getReason()	Gets the reason.
String	getRev()	Gets the rev.
Boolean	isOk()	Gets the ok.

Methods inherited from class com.ibm.cloud.sdk.core.service.model.GenericModel

equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DocumentResult

public DocumentResult()

Method Detail

getId

public String getId()

Gets the id. Schema for a document ID.

Returns:

the id

getRev

public String getRev()

Gets the rev. Schema for a document revision identifier.

Returns:

the rev

isOk

public Boolean isOk()

Gets the ok. ok.

Returns:

the ok

getCausedBy

public String getCausedBy()

Gets the causedBy. The cause of the error (if available).

Returns:

the causedBy

getError

public String getError()

Gets the error. The name of the error.

Returns:

the error

getReason

public String getReason()

Gets the reason. The reason the error occurred (if available).

Returns:

the reason