Package com.ibm.watson.discovery.v1.model

Class UpdateCredentialsOptions

java.lang.Object

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

com.ibm.watson.discovery.v1.model.UpdateCredentialsOptions

All Implemented Interfaces:

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

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

The updateCredentials options.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UpdateCredentialsOptions.Builder	Builder.
static interface	UpdateCredentialsOptions.SourceType	The source that this credentials object connects to.
static interface	UpdateCredentialsOptions.Status	The current status of this set of credentials.

Method Summary

Modifier and Type	Method	Description
CredentialDetails	credentialDetails()	Gets the credentialDetails.
String	credentialId()	Gets the credentialId.
String	environmentId()	Gets the environmentId.
UpdateCredentialsOptions.Builder	newBuilder()	New builder.
String	sourceType()	Gets the sourceType.
String	status()	Gets the status.

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 UpdateCredentialsOptions.Builder newBuilder()

New builder.

Returns:

a UpdateCredentialsOptions builder

environmentId

public String environmentId()

Gets the environmentId.

The ID of the environment.

Returns:

the environmentId

credentialId

public String credentialId()

Gets the credentialId.

The unique identifier for a set of source credentials.

Returns:

the credentialId

sourceType

public String sourceType()

Gets the sourceType.

The source that this credentials object connects to. - `box` indicates the credentials are used to connect an instance of Enterprise Box. - `salesforce` indicates the credentials are used to connect to Salesforce. - `sharepoint` indicates the credentials are used to connect to Microsoft SharePoint Online. - `web_crawl` indicates the credentials are used to perform a web crawl. = `cloud_object_storage` indicates the credentials are used to connect to an IBM Cloud Object Store.

Returns:

the sourceType

credentialDetails

public CredentialDetails credentialDetails()

Gets the credentialDetails.

Object containing details of the stored credentials.

Obtain credentials for your source from the administrator of the source.

Returns:

the credentialDetails

status

public String status()

Gets the status.

The current status of this set of credentials. `connected` indicates that the credentials are available to use with the source configuration of a collection. `invalid` refers to the credentials (for example, the password provided has expired) and must be corrected before they can be used with a collection.

Returns:

the status