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 and Description
static class	DeleteDocumentOptions.Builder Builder.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	collectionId
protected java.lang.String	documentId
protected java.lang.String	projectId
protected java.lang.Boolean	xWatsonDiscoveryForce

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DeleteDocumentOptions(DeleteDocumentOptions.Builder builder)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	collectionId() Gets the collectionId.
java.lang.String	documentId() Gets the documentId.
DeleteDocumentOptions.Builder	newBuilder() New builder.
java.lang.String	projectId() Gets the projectId.
java.lang.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

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

Field Detail

projectId

protected java.lang.String projectId

collectionId

protected java.lang.String collectionId

documentId

protected java.lang.String documentId

xWatsonDiscoveryForce

protected java.lang.Boolean xWatsonDiscoveryForce

Constructor Detail

DeleteDocumentOptions

protected DeleteDocumentOptions(DeleteDocumentOptions.Builder builder)

Method Detail

newBuilder

public DeleteDocumentOptions.Builder newBuilder()

New builder.

Returns:

a DeleteDocumentOptions builder

projectId

public java.lang.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 java.lang.String collectionId()

Gets the collectionId.

The ID of the collection.

Returns:

the collectionId

documentId

public java.lang.String documentId()

Gets the documentId.

The ID of the document.

Returns:

the documentId

xWatsonDiscoveryForce

public java.lang.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