Package com.ibm.watson.discovery.v2.model

Class DeleteDocumentOptions

java.lang.Object

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

com.ibm.watson.discovery.v2.model.DeleteDocumentOptions

All Implemented Interfaces:

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

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

The deleteDocument options.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DeleteDocumentOptions.Builder	Builder.

Method Summary

Modifier and Type	Method	Description
String	collectionId()	Gets the collectionId.
String	documentId()	Gets the documentId.
DeleteDocumentOptions.Builder	newBuilder()	New builder.
String	projectId()	Gets the projectId.
Boolean	xWatsonDiscoveryForce()	Gets the xWatsonDiscoveryForce.

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

Method Details

newBuilder

public DeleteDocumentOptions.Builder newBuilder()

New builder.

Returns:

a DeleteDocumentOptions builder

projectId

public String projectId()

Gets the projectId.

The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.

Returns:

the projectId

collectionId

public String collectionId()

Gets the collectionId.

The ID of the collection.

Returns:

the collectionId

documentId

public String documentId()

Gets the documentId.

The ID of the document.

Returns:

the documentId

xWatsonDiscoveryForce

public Boolean xWatsonDiscoveryForce()

Gets the xWatsonDiscoveryForce.

When `true`, the uploaded document is added to the collection even if the data for that collection is shared with other collections.

Returns:

the xWatsonDiscoveryForce