com.ibm.watson.discovery.v1.model

Class CreateCredentialsOptions

java.lang.Object

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

com.ibm.watson.discovery.v1.model.CreateCredentialsOptions

All Implemented Interfaces:

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

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

The createCredentials options.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CreateCredentialsOptions.Builder Builder.
static interface	CreateCredentialsOptions.SourceType The source that this credentials object connects to.
static interface	CreateCredentialsOptions.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	environmentId
protected java.lang.String	sourceType
protected java.lang.String	status

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
CredentialDetails	credentialDetails() Gets the credentialDetails.
java.lang.String	environmentId() Gets the environmentId.
CreateCredentialsOptions.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

environmentId

protected java.lang.String environmentId

sourceType

protected java.lang.String sourceType

credentialDetails

protected CredentialDetails credentialDetails

status

protected java.lang.String status

Constructor Detail

CreateCredentialsOptions

protected CreateCredentialsOptions(CreateCredentialsOptions.Builder builder)

Method Detail

newBuilder

public CreateCredentialsOptions.Builder newBuilder()

New builder.

Returns:

a CreateCredentialsOptions builder

environmentId

public java.lang.String environmentId()

Gets the environmentId.

The ID of the environment.

Returns:

the environmentId

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