public class Environment
extends com.ibm.cloud.sdk.core.service.model.GenericModel
Modifier and Type | Class and Description |
---|---|
static interface |
Environment.Size
Current size of the environment.
|
static interface |
Environment.Status
Current status of the environment.
|
Modifier and Type | Method and Description |
---|---|
Date |
getCreated()
Gets the created.
|
String |
getDescription()
Gets the description.
|
String |
getEnvironmentId()
Gets the environmentId.
|
IndexCapacity |
getIndexCapacity()
Gets the indexCapacity.
|
String |
getName()
Gets the name.
|
String |
getRequestedSize()
Gets the requestedSize.
|
SearchStatus |
getSearchStatus()
Gets the searchStatus.
|
String |
getSize()
Gets the size.
|
String |
getStatus()
Gets the status.
|
Date |
getUpdated()
Gets the updated.
|
Boolean |
isReadOnly()
Gets the readOnly.
|
public String getEnvironmentId()
Unique identifier for the environment.
public String getName()
Name that identifies the environment.
public String getDescription()
Description of the environment.
public Date getCreated()
Creation date of the environment, in the format `yyyy-MM-dd'T'HH:mm:ss.SSS'Z'`.
public Date getUpdated()
Date of most recent environment update, in the format `yyyy-MM-dd'T'HH:mm:ss.SSS'Z'`.
public String getStatus()
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.
public Boolean isReadOnly()
If `true`, the environment contains read-only collections that are maintained by IBM.
public String getSize()
Current size of the environment.
public String getRequestedSize()
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.
public IndexCapacity getIndexCapacity()
Details about the resource usage and capacity of the environment.
public SearchStatus getSearchStatus()
Information about the Continuous Relevancy Training for this environment.
Copyright © 2023 IBM Cloud. All rights reserved.