Entity.Builder (Oracle Cloud Infrastructure Java SDK

java.lang.Object
- com.oracle.bmc.datacatalog.model.Entity.Builder

Enclosing class:: Entity

public static class Entity.Builder
extends Object

Constructor Summary

Constructors
Constructor and Description

Builder()

Constructors
Constructor and Description
`Builder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Entity`	`build()`
`Entity.Builder`	`businessName(String businessName)` Optional user friendly business name of the data entity.
`Entity.Builder`	`copy(Entity model)`
`Entity.Builder`	`createdById(String createdById)` OCID of the user who created this object in the data catalog.
`Entity.Builder`	`customPropertyMembers(List<CustomPropertyGetUsage> customPropertyMembers)` The list of customized properties along with the values for this object
`Entity.Builder`	`dataAssetKey(String dataAssetKey)` Unique key of the parent data asset.
`Entity.Builder`	`description(String description)` Detailed description of a data entity.
`Entity.Builder`	`displayName(String displayName)` A user-friendly display name.
`Entity.Builder`	`externalKey(String externalKey)` Unique external key of this object in the source system.
`Entity.Builder`	`folderKey(String folderKey)` Key of the associated folder.
`Entity.Builder`	`folderName(String folderName)` Name of the associated folder.
`Entity.Builder`	`harvestStatus(HarvestStatus harvestStatus)` Status of the object as updated by the harvest process.
`Entity.Builder`	`isLogical(Boolean isLogical)` Property that identifies if the object is a physical object (materialized) or virtual/logical object defined on other objects.
`Entity.Builder`	`isPartition(Boolean isPartition)` Property that identifies if an object is a sub object of a physical or materialized parent object.
`Entity.Builder`	`key(String key)` Unique data entity key that is immutable.
`Entity.Builder`	`lastJobKey(String lastJobKey)` Key of the last harvest process to update this object.
`Entity.Builder`	`lifecycleDetails(String lifecycleDetails)` A message describing the current state in more detail.
`Entity.Builder`	`lifecycleState(LifecycleState lifecycleState)` The current state of the data entity.
`Entity.Builder`	`objectRelationships(List<ObjectRelationship> objectRelationships)` List of objects and their relationships to this entity.
`Entity.Builder`	`objectStorageUrl(String objectStorageUrl)` URL of the data entity in the object store.
`Entity.Builder`	`path(String path)` Full path of the data entity.
`Entity.Builder`	`patternKey(String patternKey)` Key of the associated pattern if this is a logical entity.
`Entity.Builder`	`properties(Map<String,Map<String,String>> properties)` A map of maps that contains the properties which are specific to the entity type.
`Entity.Builder`	`realizedExpression(String realizedExpression)` The expression realized after resolving qualifiers .
`Entity.Builder`	`timeCreated(Date timeCreated)` The date and time the data entity was created, in the format defined by RFC3339.
`Entity.Builder`	`timeExternal(Date timeExternal)` Last modified timestamp of this object in the external system.
`Entity.Builder`	`timeHarvested(Date timeHarvested)` The date and time the entity was harvested, in the format defined by RFC3339.
`Entity.Builder`	`timeStatusUpdated(Date timeStatusUpdated)` Time that the data entities status was last updated.
`Entity.Builder`	`timeUpdated(Date timeUpdated)` The last time that any change was made to the data entity.
`Entity.Builder`	`typeKey(String typeKey)` The type of data entity object.
`Entity.Builder`	`updatedById(String updatedById)` OCID of the user who updated this object in the data catalog.
`Entity.Builder`	`uri(String uri)` URI to the data entity instance in the API.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Builder
```
public Builder()
```
- Method Detail
  - key
```
public Entity.Builder key(String key)
```
    Unique data entity key that is immutable.
    
    Parameters:
    
    key - the value to set
    
    Returns:
    
    this builder
  - displayName
```
public Entity.Builder displayName(String displayName)
```
    A user-friendly display name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
    
    Parameters:
    
    displayName - the value to set
    
    Returns:
    
    this builder
  - businessName
```
public Entity.Builder businessName(String businessName)
```
    Optional user friendly business name of the data entity. If set, this supplements the harvested display name of the object.
    
    Parameters:
    
    businessName - the value to set
    
    Returns:
    
    this builder
  - description
```
public Entity.Builder description(String description)
```
    Detailed description of a data entity.
    
    Parameters:
    
    description - the value to set
    
    Returns:
    
    this builder
  - timeCreated
```
public Entity.Builder timeCreated(Date timeCreated)
```
    The date and time the data entity was created, in the format defined by RFC3339. Example: 2019-03-25T21:10:29.600Z
    
    Parameters:
    
    timeCreated - the value to set
    
    Returns:
    
    this builder
  - timeUpdated
```
public Entity.Builder timeUpdated(Date timeUpdated)
```
    The last time that any change was made to the data entity. An RFC3339 formatted datetime string.
    
    Parameters:
    
    timeUpdated - the value to set
    
    Returns:
    
    this builder
  - createdById
```
public Entity.Builder createdById(String createdById)
```
    OCID of the user who created this object in the data catalog.
    
    Parameters:
    
    createdById - the value to set
    
    Returns:
    
    this builder
  - updatedById
```
public Entity.Builder updatedById(String updatedById)
```
    OCID of the user who updated this object in the data catalog.
    
    Parameters:
    
    updatedById - the value to set
    
    Returns:
    
    this builder
  - lifecycleState
```
public Entity.Builder lifecycleState(LifecycleState lifecycleState)
```
    The current state of the data entity.
    
    Parameters:
    
    lifecycleState - the value to set
    
    Returns:
    
    this builder
  - lifecycleDetails
```
public Entity.Builder lifecycleDetails(String lifecycleDetails)
```
    A message describing the current state in more detail. An object not in ACTIVE state may have functional limitations, see service documentation for details.
    
    Parameters:
    
    lifecycleDetails - the value to set
    
    Returns:
    
    this builder
  - externalKey
```
public Entity.Builder externalKey(String externalKey)
```
    Unique external key of this object in the source system.
    
    Parameters:
    
    externalKey - the value to set
    
    Returns:
    
    this builder
  - patternKey
```
public Entity.Builder patternKey(String patternKey)
```
    Key of the associated pattern if this is a logical entity.
    
    Parameters:
    
    patternKey - the value to set
    
    Returns:
    
    this builder
  - realizedExpression
```
public Entity.Builder realizedExpression(String realizedExpression)
```
    The expression realized after resolving qualifiers . Used in deriving this logical entity
    
    Parameters:
    
    realizedExpression - the value to set
    
    Returns:
    
    this builder
  - timeExternal
```
public Entity.Builder timeExternal(Date timeExternal)
```
    Last modified timestamp of this object in the external system.
    
    Parameters:
    
    timeExternal - the value to set
    
    Returns:
    
    this builder
  - timeHarvested
```
public Entity.Builder timeHarvested(Date timeHarvested)
```
    The date and time the entity was harvested, in the format defined by RFC3339.
    
    Parameters:
    
    timeHarvested - the value to set
    
    Returns:
    
    this builder
  - objectRelationships
```
public Entity.Builder objectRelationships(List<ObjectRelationship> objectRelationships)
```
    List of objects and their relationships to this entity.
    
    Parameters:
    
    objectRelationships - the value to set
    
    Returns:
    
    this builder
  - timeStatusUpdated
```
public Entity.Builder timeStatusUpdated(Date timeStatusUpdated)
```
    Time that the data entities status was last updated. An RFC3339 formatted datetime string.
    
    Parameters:
    
    timeStatusUpdated - the value to set
    
    Returns:
    
    this builder
  - isLogical
```
public Entity.Builder isLogical(Boolean isLogical)
```
    Property that identifies if the object is a physical object (materialized) or virtual/logical object defined on other objects.
    
    Parameters:
    
    isLogical - the value to set
    
    Returns:
    
    this builder
  - isPartition
```
public Entity.Builder isPartition(Boolean isPartition)
```
    Property that identifies if an object is a sub object of a physical or materialized parent object.
    
    Parameters:
    
    isPartition - the value to set
    
    Returns:
    
    this builder
  - dataAssetKey
```
public Entity.Builder dataAssetKey(String dataAssetKey)
```
    Unique key of the parent data asset.
    
    Parameters:
    
    dataAssetKey - the value to set
    
    Returns:
    
    this builder
  - folderKey
```
public Entity.Builder folderKey(String folderKey)
```
    Key of the associated folder.
    
    Parameters:
    
    folderKey - the value to set
    
    Returns:
    
    this builder
  - folderName
```
public Entity.Builder folderName(String folderName)
```
    Name of the associated folder. This name is harvested from the source data asset when the parent folder for the entiy is harvested.
    
    Parameters:
    
    folderName - the value to set
    
    Returns:
    
    this builder
  - path
```
public Entity.Builder path(String path)
```
    Full path of the data entity.
    
    Parameters:
    
    path - the value to set
    
    Returns:
    
    this builder
  - harvestStatus
```
public Entity.Builder harvestStatus(HarvestStatus harvestStatus)
```
    Status of the object as updated by the harvest process.
    
    Parameters:
    
    harvestStatus - the value to set
    
    Returns:
    
    this builder
  - lastJobKey
```
public Entity.Builder lastJobKey(String lastJobKey)
```
    Key of the last harvest process to update this object.
    
    Parameters:
    
    lastJobKey - the value to set
    
    Returns:
    
    this builder
  - typeKey
```
public Entity.Builder typeKey(String typeKey)
```
    The type of data entity object. Type key’s can be found via the ‘/types’ endpoint.
    
    Parameters:
    
    typeKey - the value to set
    
    Returns:
    
    this builder
  - uri
```
public Entity.Builder uri(String uri)
```
    URI to the data entity instance in the API.
    
    Parameters:
    
    uri - the value to set
    
    Returns:
    
    this builder
  - objectStorageUrl
```
public Entity.Builder objectStorageUrl(String objectStorageUrl)
```
    URL of the data entity in the object store.
    
    Parameters:
    
    objectStorageUrl - the value to set
    
    Returns:
    
    this builder
  - customPropertyMembers
```
public Entity.Builder customPropertyMembers(List<CustomPropertyGetUsage> customPropertyMembers)
```
    The list of customized properties along with the values for this object
    
    Parameters:
    
    customPropertyMembers - the value to set
    
    Returns:
    
    this builder
  - properties
```
public Entity.Builder properties(Map<String,Map<String,String>> properties)
```
    A map of maps that contains the properties which are specific to the entity type. Each entity type definition defines it’s set of required and optional properties. The map keys are category names and the values are maps of property name to property value. Every property is contained inside of a category. Most data entities have required properties within the “default” category. Example: {"properties": { "default": { "key1": "value1"}}}
    
    Parameters:
    
    properties - the value to set
    
    Returns:
    
    this builder
  - build
```
public Entity build()
```
  - copy
```
public Entity.Builder copy(Entity model)
```

Class Entity.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

key

displayName

businessName

description

timeCreated

timeUpdated

createdById

updatedById

lifecycleState

lifecycleDetails

externalKey

patternKey

realizedExpression

timeExternal

timeHarvested

objectRelationships

timeStatusUpdated

isLogical

isPartition

dataAssetKey

folderKey

folderName

path

harvestStatus

lastJobKey

typeKey

uri

objectStorageUrl

customPropertyMembers

properties

build

copy