com.ibm.watson.developer_cloud.discovery.v1.model

Class CredentialDetails

java.lang.Object

com.ibm.watson.developer_cloud.service.model.GenericModel

com.ibm.watson.developer_cloud.discovery.v1.model.CredentialDetails

All Implemented Interfaces:

ObjectModel

public class CredentialDetails
extends GenericModel

Object containing details of the stored credentials. Obtain credentials for your source from the administrator of the source.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CredentialDetails.CredentialType The authentication method for this credentials definition.
static interface	CredentialDetails.SourceVersion The type of Sharepoint repository to connect to.

Constructor Summary

Constructors

Constructor and Description
CredentialDetails()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getClientId() Gets the clientId.
java.lang.String	getClientSecret() Gets the clientSecret.
java.lang.String	getCredentialType() Gets the credentialType.
java.lang.String	getDomain() Gets the domain.
java.lang.String	getEnterpriseId() Gets the enterpriseId.
java.lang.String	getGatewayId() Gets the gatewayId.
java.lang.String	getOrganizationUrl() Gets the organizationUrl.
java.lang.String	getPassphrase() Gets the passphrase.
java.lang.String	getPassword() Gets the password.
java.lang.String	getPrivateKey() Gets the privateKey.
java.lang.String	getPublicKeyId() Gets the publicKeyId.
java.lang.String	getSiteCollectionPath() Gets the siteCollectionPath.
java.lang.String	getSourceVersion() Gets the sourceVersion.
java.lang.String	getUrl() Gets the url.
java.lang.String	getUsername() Gets the username.
java.lang.String	getWebApplicationUrl() Gets the webApplicationUrl.
void	setClientId(java.lang.String clientId) Sets the clientId.
void	setClientSecret(java.lang.String clientSecret) Sets the clientSecret.
void	setCredentialType(java.lang.String credentialType) Sets the credentialType.
void	setDomain(java.lang.String domain) Sets the domain.
void	setEnterpriseId(java.lang.String enterpriseId) Sets the enterpriseId.
void	setGatewayId(java.lang.String gatewayId) Sets the gatewayId.
void	setOrganizationUrl(java.lang.String organizationUrl) Sets the organizationUrl.
void	setPassphrase(java.lang.String passphrase) Sets the passphrase.
void	setPassword(java.lang.String password) Sets the password.
void	setPrivateKey(java.lang.String privateKey) Sets the privateKey.
void	setPublicKeyId(java.lang.String publicKeyId) Sets the publicKeyId.
void	setSiteCollectionPath(java.lang.String siteCollectionPath) Sets the siteCollectionPath.
void	setSourceVersion(java.lang.String sourceVersion) Sets the sourceVersion.
void	setUrl(java.lang.String url) Sets the url.
void	setUsername(java.lang.String username) Sets the username.
void	setWebApplicationUrl(java.lang.String webApplicationUrl) Sets the webApplicationUrl.

Methods inherited from class com.ibm.watson.developer_cloud.service.model.GenericModel

equals, hashCode, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

CredentialDetails

public CredentialDetails()

Method Detail

getCredentialType

public java.lang.String getCredentialType()

Gets the credentialType. The authentication method for this credentials definition. The **credential_type** specified must be supported by the **source_type**. The following combinations are possible: - `"source_type": "box"` - valid `credential_type`s: `oauth2` - `"source_type": "salesforce"` - valid `credential_type`s: `username_password` - `"source_type": "sharepoint"` - valid `credential_type`s: `saml` with **source_version** of `online`, or `ntml_v1` with **source_version** of `2016` - `"source_type": "web_crawl"` - valid `credential_type`s: `noauth` or `basic`.

Returns:

the credentialType

getClientId

public java.lang.String getClientId()

Gets the clientId. The **client_id** of the source that these credentials connect to. Only valid, and required, with a **credential_type** of `oauth2`.

Returns:

the clientId

getEnterpriseId

public java.lang.String getEnterpriseId()

Gets the enterpriseId. The **enterprise_id** of the Box site that these credentials connect to. Only valid, and required, with a **source_type** of `box`.

Returns:

the enterpriseId

getUrl

public java.lang.String getUrl()

Gets the url. The **url** of the source that these credentials connect to. Only valid, and required, with a **credential_type** of `username_password`, `noauth`, and `basic`.

Returns:

the url

getUsername

public java.lang.String getUsername()

Gets the username. The **username** of the source that these credentials connect to. Only valid, and required, with a **credential_type** of `saml`, `username_password`, `basic`, or `ntml_v1`.

Returns:

the username

getOrganizationUrl

public java.lang.String getOrganizationUrl()

Gets the organizationUrl. The **organization_url** of the source that these credentials connect to. Only valid, and required, with a **credential_type** of `saml`.

Returns:

the organizationUrl

getSiteCollectionPath

public java.lang.String getSiteCollectionPath()

Gets the siteCollectionPath. The **site_collection.path** of the source that these credentials connect to. Only valid, and required, with a **source_type** of `sharepoint`.

Returns:

the siteCollectionPath

getClientSecret

public java.lang.String getClientSecret()

Gets the clientSecret. The **client_secret** of the source that these credentials connect to. Only valid, and required, with a **credential_type** of `oauth2`. This value is never returned and is only used when creating or modifying **credentials**.

Returns:

the clientSecret

getPublicKeyId

public java.lang.String getPublicKeyId()

Gets the publicKeyId. The **public_key_id** of the source that these credentials connect to. Only valid, and required, with a **credential_type** of `oauth2`. This value is never returned and is only used when creating or modifying **credentials**.

Returns:

the publicKeyId

getPrivateKey

public java.lang.String getPrivateKey()

Gets the privateKey. The **private_key** of the source that these credentials connect to. Only valid, and required, with a **credential_type** of `oauth2`. This value is never returned and is only used when creating or modifying **credentials**.

Returns:

the privateKey

getPassphrase

public java.lang.String getPassphrase()

Gets the passphrase. The **passphrase** of the source that these credentials connect to. Only valid, and required, with a **credential_type** of `oauth2`. This value is never returned and is only used when creating or modifying **credentials**.

Returns:

the passphrase

getPassword

public java.lang.String getPassword()

Gets the password. The **password** of the source that these credentials connect to. Only valid, and required, with **credential_type**s of `saml`, `username_password`, `basic`, or `ntml_v1`. **Note:** When used with a **source_type** of `salesforce`, the password consists of the Salesforce password and a valid Salesforce security token concatenated. This value is never returned and is only used when creating or modifying **credentials**.

Returns:

the password

getGatewayId

public java.lang.String getGatewayId()

Gets the gatewayId. The ID of the **gateway** to be connected through (when connecting to intranet sites). Only valid with a **credential_type** of `noauth`, `basic`, or `ntml_v1`. Gateways are created using the `/v1/environments/{environment_id}/gateways` methods.

Returns:

the gatewayId

getSourceVersion

public java.lang.String getSourceVersion()

Gets the sourceVersion. The type of Sharepoint repository to connect to. Only valid, and required, with a **source_type** of `sharepoint`.

Returns:

the sourceVersion

getWebApplicationUrl

public java.lang.String getWebApplicationUrl()

Gets the webApplicationUrl. SharePoint OnPrem WebApplication URL. Only valid, and required, with a **source_version** of `2016`.

Returns:

the webApplicationUrl

getDomain

public java.lang.String getDomain()

Gets the domain. The domain used to log in to your OnPrem SharePoint account. Only valid, and required, with a **source_version** of `2016`.

Returns:

the domain

setCredentialType

public void setCredentialType(java.lang.String credentialType)

Sets the credentialType.

Parameters:

credentialType - the new credentialType

setClientId

public void setClientId(java.lang.String clientId)

Sets the clientId.

Parameters:

clientId - the new clientId

setEnterpriseId

public void setEnterpriseId(java.lang.String enterpriseId)

Sets the enterpriseId.

Parameters:

enterpriseId - the new enterpriseId

setUrl

public void setUrl(java.lang.String url)

Sets the url.

Parameters:

url - the new url

setUsername

public void setUsername(java.lang.String username)

Sets the username.

Parameters:

username - the new username

setOrganizationUrl

public void setOrganizationUrl(java.lang.String organizationUrl)

Sets the organizationUrl.

Parameters:

organizationUrl - the new organizationUrl

setSiteCollectionPath

public void setSiteCollectionPath(java.lang.String siteCollectionPath)

Sets the siteCollectionPath.

Parameters:

siteCollectionPath - the new siteCollectionPath

setClientSecret

public void setClientSecret(java.lang.String clientSecret)

Sets the clientSecret.

Parameters:

clientSecret - the new clientSecret

setPublicKeyId

public void setPublicKeyId(java.lang.String publicKeyId)

Sets the publicKeyId.

Parameters:

publicKeyId - the new publicKeyId

setPrivateKey

public void setPrivateKey(java.lang.String privateKey)

Sets the privateKey.

Parameters:

privateKey - the new privateKey

setPassphrase

public void setPassphrase(java.lang.String passphrase)

Sets the passphrase.

Parameters:

passphrase - the new passphrase

setPassword

public void setPassword(java.lang.String password)

Sets the password.

Parameters:

password - the new password

setGatewayId

public void setGatewayId(java.lang.String gatewayId)

Sets the gatewayId.

Parameters:

gatewayId - the new gatewayId

setSourceVersion

public void setSourceVersion(java.lang.String sourceVersion)

Sets the sourceVersion.

Parameters:

sourceVersion - the new sourceVersion

setWebApplicationUrl

public void setWebApplicationUrl(java.lang.String webApplicationUrl)

Sets the webApplicationUrl.

Parameters:

webApplicationUrl - the new webApplicationUrl

setDomain

public void setDomain(java.lang.String domain)

Sets the domain.

Parameters:

domain - the new domain