com.ibm.watson.discovery.v1.model

Class Environment

java.lang.Object

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

com.ibm.watson.discovery.v1.model.Environment

All Implemented Interfaces:

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

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

Details about an environment.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Environment.Size Current size of the environment.
static interface	Environment.Status Current status of the environment.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Date	created
protected java.lang.String	description
protected java.lang.String	environmentId
protected IndexCapacity	indexCapacity
protected java.lang.String	name
protected java.lang.Boolean	readOnly
protected java.lang.String	requestedSize
protected SearchStatus	searchStatus
protected java.lang.String	size
protected java.lang.String	status
protected java.util.Date	updated

Constructor Summary

Constructors

Constructor and Description
Environment()

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Date	getCreated() Gets the created.
java.lang.String	getDescription() Gets the description.
java.lang.String	getEnvironmentId() Gets the environmentId.
IndexCapacity	getIndexCapacity() Gets the indexCapacity.
java.lang.String	getName() Gets the name.
java.lang.String	getRequestedSize() Gets the requestedSize.
SearchStatus	getSearchStatus() Gets the searchStatus.
java.lang.String	getSize() Gets the size.
java.lang.String	getStatus() Gets the status.
java.util.Date	getUpdated() Gets the updated.
java.lang.Boolean	isReadOnly() Gets the readOnly.

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

@SerializedName(value="environment_id")
protected java.lang.String environmentId

name

protected java.lang.String name

description

protected java.lang.String description

created

protected java.util.Date created

updated

protected java.util.Date updated

status

protected java.lang.String status

readOnly

@SerializedName(value="read_only")
protected java.lang.Boolean readOnly

size

protected java.lang.String size

requestedSize

@SerializedName(value="requested_size")
protected java.lang.String requestedSize

indexCapacity

@SerializedName(value="index_capacity")
protected IndexCapacity indexCapacity

searchStatus

@SerializedName(value="search_status")
protected SearchStatus searchStatus

Constructor Detail

Environment

public Environment()

Method Detail

getEnvironmentId

public java.lang.String getEnvironmentId()

Gets the environmentId.

Unique identifier for the environment.

Returns:

the environmentId

getName

public java.lang.String getName()

Gets the name.

Name that identifies the environment.

Returns:

the name

getDescription

public java.lang.String getDescription()

Gets the description.

Description of the environment.

Returns:

the description

getCreated

public java.util.Date getCreated()

Gets the created.

Creation date of the environment, in the format `yyyy-MM-dd'T'HH:mm:ss.SSS'Z'`.

Returns:

the created

getUpdated

public java.util.Date getUpdated()

Gets the updated.

Date of most recent environment update, in the format `yyyy-MM-dd'T'HH:mm:ss.SSS'Z'`.

Returns:

the updated

getStatus

public java.lang.String getStatus()

Gets the status.

Current status of the environment. `resizing` is displayed when a request to increase the environment size has been made, but is still in the process of being completed.

Returns:

the status

isReadOnly

public java.lang.Boolean isReadOnly()

Gets the readOnly.

If `true`, the environment contains read-only collections that are maintained by IBM.

Returns:

the readOnly

getSize

public java.lang.String getSize()

Gets the size.

Current size of the environment.

Returns:

the size

getRequestedSize

public java.lang.String getRequestedSize()

Gets the requestedSize.

The new size requested for this environment. Only returned when the environment *status* is `resizing`.

*Note:* Querying and indexing can still be performed during an environment upsize.

Returns:

the requestedSize

getIndexCapacity

public IndexCapacity getIndexCapacity()

Gets the indexCapacity.

Details about the resource usage and capacity of the environment.

Returns:

the indexCapacity

getSearchStatus

public SearchStatus getSearchStatus()

Gets the searchStatus.

Information about the Continuous Relevancy Training for this environment.

Returns:

the searchStatus