public class UpdateEntityOptions
extends com.ibm.cloud.sdk.core.service.model.GenericModel
Modifier and Type | Class and Description |
---|---|
static class |
UpdateEntityOptions.Builder
Builder.
|
Modifier and Type | Method and Description |
---|---|
Boolean |
append()
Gets the append.
|
String |
entity()
Gets the entity.
|
Boolean |
includeAudit()
Gets the includeAudit.
|
UpdateEntityOptions.Builder |
newBuilder()
New builder.
|
String |
newDescription()
Gets the newDescription.
|
String |
newEntity()
Gets the newEntity.
|
Boolean |
newFuzzyMatch()
Gets the newFuzzyMatch.
|
Map<String,Object> |
newMetadata()
Gets the newMetadata.
|
List<CreateValue> |
newValues()
Gets the newValues.
|
String |
workspaceId()
Gets the workspaceId.
|
public UpdateEntityOptions.Builder newBuilder()
public String workspaceId()
Unique identifier of the workspace.
public String entity()
The name of the entity.
public String newEntity()
The name of the entity. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, underscore, and hyphen characters. - It cannot begin with the reserved prefix `sys-`.
public String newDescription()
The description of the entity. This string cannot contain carriage return, newline, or tab characters.
public Map<String,Object> newMetadata()
Any metadata related to the entity.
public Boolean newFuzzyMatch()
Whether to use fuzzy matching for the entity.
public List<CreateValue> newValues()
An array of objects describing the entity values.
public Boolean append()
Whether the new data is to be appended to the existing data in the entity. If **append**=`false`, elements included in the new data completely replace the corresponding existing elements, including all subelements. For example, if the new data for the entity includes **values** and **append**=`false`, all existing values for the entity are discarded and replaced with the new values.
If **append**=`true`, existing elements are preserved, and the new elements are added. If any elements in the new data collide with existing elements, the update request fails.
public Boolean includeAudit()
Whether to include the audit properties (`created` and `updated` timestamps) in the response.
Copyright © 2023 IBM Cloud. All rights reserved.