com.ibm.watson.discovery.v1.model

Class Credentials

java.lang.Object

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

com.ibm.watson.discovery.v1.model.Credentials

All Implemented Interfaces:

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

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

Object containing credential information.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
protected CredentialDetails	credentialDetails
protected java.lang.String	credentialId
protected java.lang.String	sourceType
protected java.lang.String	status

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
CredentialDetails	credentialDetails() Gets the credentialDetails.
java.lang.String	credentialId() Gets the credentialId.
Credentials.Builder	newBuilder() New builder.
java.lang.String	sourceType() Gets the sourceType.
java.lang.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

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

Field Detail

credentialId

@SerializedName(value="credential_id")
protected java.lang.String credentialId

sourceType

@SerializedName(value="source_type")
protected java.lang.String sourceType

credentialDetails

@SerializedName(value="credential_details")
protected CredentialDetails credentialDetails

status

protected java.lang.String status

Constructor Detail

Credentials

protected Credentials(Credentials.Builder builder)

Method Detail

newBuilder

public Credentials.Builder newBuilder()

New builder.

Returns:

a Credentials builder

credentialId

public java.lang.String credentialId()

Gets the credentialId.

Unique identifier for this set of credentials.

Returns:

the credentialId

sourceType

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