Package 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.

  • Method Details

    • newBuilder

      public CredentialDetails.Builder newBuilder()
      New builder.
      Returns:
      a CredentialDetails builder

    • credentialType

      public 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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