com.ibm.watson.discovery.v1.model

Class CredentialDetails

java.lang.Object

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

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

All Implemented Interfaces:

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

public class CredentialDetails
extends com.ibm.cloud.sdk.core.service.model.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 class	CredentialDetails.Builder Builder.
static interface	CredentialDetails.CredentialType The authentication method for this credentials definition.
static interface	CredentialDetails.SourceVersion The type of Sharepoint repository to connect to.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	accessKeyId
protected java.lang.String	clientId
protected java.lang.String	clientSecret
protected java.lang.String	credentialType
protected java.lang.String	domain
protected java.lang.String	endpoint
protected java.lang.String	enterpriseId
protected java.lang.String	gatewayId
protected java.lang.String	organizationUrl
protected java.lang.String	passphrase
protected java.lang.String	password
protected java.lang.String	privateKey
protected java.lang.String	publicKeyId
protected java.lang.String	secretAccessKey
protected java.lang.String	siteCollectionPath
protected java.lang.String	sourceVersion
protected java.lang.String	url
protected java.lang.String	username
protected java.lang.String	webApplicationUrl

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	accessKeyId() Gets the accessKeyId.
java.lang.String	clientId() Gets the clientId.
java.lang.String	clientSecret() Gets the clientSecret.
java.lang.String	credentialType() Gets the credentialType.
java.lang.String	domain() Gets the domain.
java.lang.String	endpoint() Gets the endpoint.
java.lang.String	enterpriseId() Gets the enterpriseId.
java.lang.String	gatewayId() Gets the gatewayId.
CredentialDetails.Builder	newBuilder() New builder.
java.lang.String	organizationUrl() Gets the organizationUrl.
java.lang.String	passphrase() Gets the passphrase.
java.lang.String	password() Gets the password.
java.lang.String	privateKey() Gets the privateKey.
java.lang.String	publicKeyId() Gets the publicKeyId.
java.lang.String	secretAccessKey() Gets the secretAccessKey.
java.lang.String	siteCollectionPath() Gets the siteCollectionPath.
java.lang.String	sourceVersion() Gets the sourceVersion.
java.lang.String	url() Gets the url.
java.lang.String	username() Gets the username.
java.lang.String	webApplicationUrl() Gets the webApplicationUrl.

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

credentialType

@SerializedName(value="credential_type")
protected java.lang.String credentialType

clientId

@SerializedName(value="client_id")
protected java.lang.String clientId

enterpriseId

@SerializedName(value="enterprise_id")
protected java.lang.String enterpriseId

url

protected java.lang.String url

username

protected java.lang.String username

organizationUrl

@SerializedName(value="organization_url")
protected java.lang.String organizationUrl

siteCollectionPath

@SerializedName(value="site_collection.path")
protected java.lang.String siteCollectionPath

clientSecret

@SerializedName(value="client_secret")
protected java.lang.String clientSecret

publicKeyId

@SerializedName(value="public_key_id")
protected java.lang.String publicKeyId

privateKey

@SerializedName(value="private_key")
protected java.lang.String privateKey

passphrase

protected java.lang.String passphrase

password

protected java.lang.String password

gatewayId

@SerializedName(value="gateway_id")
protected java.lang.String gatewayId

sourceVersion

@SerializedName(value="source_version")
protected java.lang.String sourceVersion

webApplicationUrl

@SerializedName(value="web_application_url")
protected java.lang.String webApplicationUrl

domain

protected java.lang.String domain

endpoint

protected java.lang.String endpoint

accessKeyId

@SerializedName(value="access_key_id")
protected java.lang.String accessKeyId

secretAccessKey

@SerializedName(value="secret_access_key")
protected java.lang.String secretAccessKey

Constructor Detail

CredentialDetails

protected CredentialDetails(CredentialDetails.Builder builder)

Method Detail

newBuilder

public CredentialDetails.Builder newBuilder()

New builder.

Returns:

a CredentialDetails builder

credentialType

public java.lang.String credentialType()

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 `ntlm_v1` with **source_version** of `2016` - `"source_type": "web_crawl"` - valid `credential_type`s: `noauth` or `basic` - "source_type": "cloud_object_storage"` - valid `credential_type`s: `aws4_hmac`.

Returns:

the credentialType

clientId

public java.lang.String clientId()

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

enterpriseId

public java.lang.String enterpriseId()

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

url

public java.lang.String url()

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

username

public java.lang.String username()

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 `ntlm_v1`.

Returns:

the username

organizationUrl

public java.lang.String organizationUrl()

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

siteCollectionPath

public java.lang.String siteCollectionPath()

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

clientSecret

public java.lang.String clientSecret()

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

publicKeyId

public java.lang.String publicKeyId()

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

privateKey

public java.lang.String privateKey()

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

passphrase

public java.lang.String passphrase()

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

password

public java.lang.String password()

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 `ntlm_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

gatewayId

public java.lang.String gatewayId()

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 `ntlm_v1`. Gateways are created using the `/v1/environments/{environment_id}/gateways` methods.

Returns:

the gatewayId

sourceVersion

public java.lang.String sourceVersion()

Gets the sourceVersion.

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

Returns:

the sourceVersion

webApplicationUrl

public java.lang.String webApplicationUrl()

Gets the webApplicationUrl.

SharePoint OnPrem WebApplication URL. Only valid, and required, with a **source_version** of `2016`. If a port is not supplied, the default to port `80` for http and port `443` for https connections are used.

Returns:

the webApplicationUrl

domain

public java.lang.String domain()

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

endpoint

public java.lang.String endpoint()

Gets the endpoint.

The endpoint associated with the cloud object store that your are connecting to. Only valid, and required, with a **credential_type** of `aws4_hmac`.

Returns:

the endpoint

accessKeyId

public java.lang.String accessKeyId()

Gets the accessKeyId.

The access key ID associated with the cloud object store. Only valid, and required, with a **credential_type** of `aws4_hmac`. This value is never returned and is only used when creating or modifying **credentials**. For more infomation, see the [cloud object store documentation](https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-using-hmac-credentials#using-hmac-credentials).

Returns:

the accessKeyId

secretAccessKey

public java.lang.String secretAccessKey()

Gets the secretAccessKey.

The secret access key associated with the cloud object store. Only valid, and required, with a **credential_type** of `aws4_hmac`. This value is never returned and is only used when creating or modifying **credentials**. For more infomation, see the [cloud object store documentation](https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-using-hmac-credentials#using-hmac-credentials).

Returns:

the secretAccessKey