EntitySummary.Builder (Oracle Cloud Infrastructure Java SDK

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

Enclosing class:: EntitySummary

public static class EntitySummary.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
`EntitySummary`	`build()`
`EntitySummary.Builder`	`businessName(String businessName)` Optional user friendly business name of the data entity.
`EntitySummary.Builder`	`copy(EntitySummary model)`
`EntitySummary.Builder`	`dataAssetKey(String dataAssetKey)` Unique key of the parent data asset.
`EntitySummary.Builder`	`description(String description)` Detailed description of a data entity.
`EntitySummary.Builder`	`displayName(String displayName)` A user-friendly display name.
`EntitySummary.Builder`	`externalKey(String externalKey)` Unique external key of this object in the source system.
`EntitySummary.Builder`	`folderKey(String folderKey)` Key of the associated folder.
`EntitySummary.Builder`	`folderName(String folderName)` Name of the associated folder.
`EntitySummary.Builder`	`isLogical(Boolean isLogical)` Property that identifies if the object is a physical object (materialized) or virtual/logical object defined on other objects.
`EntitySummary.Builder`	`isPartition(Boolean isPartition)` Property that identifies if an object is a sub object of a physical or materialized parent object.
`EntitySummary.Builder`	`key(String key)` Unique data entity key that is immutable.
`EntitySummary.Builder`	`lifecycleDetails(String lifecycleDetails)` A message describing the current state in more detail.
`EntitySummary.Builder`	`lifecycleState(LifecycleState lifecycleState)` State of the data entity.
`EntitySummary.Builder`	`objectStorageUrl(String objectStorageUrl)` URL of the data entity in the object store.
`EntitySummary.Builder`	`path(String path)` Full path of the data entity.
`EntitySummary.Builder`	`patternKey(String patternKey)` Key of the associated pattern if this is a logical entity.
`EntitySummary.Builder`	`properties(Map<String,Map<String,String>> properties)` A map of maps that contains the properties which are specific to the entity type.
`EntitySummary.Builder`	`realizedExpression(String realizedExpression)` The expression realized after resolving qualifiers .
`EntitySummary.Builder`	`timeCreated(Date timeCreated)` The date and time the data entity was created, in the format defined by RFC3339.
`EntitySummary.Builder`	`timeUpdated(Date timeUpdated)` The last time that any change was made to the data entity.
`EntitySummary.Builder`	`typeKey(String typeKey)` The type of data entity object.
`EntitySummary.Builder`	`updatedById(String updatedById)` OCID of the user who updated this object in the data catalog.
`EntitySummary.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 EntitySummary.Builder key(String key)
```
    Unique data entity key that is immutable.
    
    Parameters:
    
    key - the value to set
    
    Returns:
    
    this builder
  - displayName
```
public EntitySummary.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 EntitySummary.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 EntitySummary.Builder description(String description)
```
    Detailed description of a data entity.
    
    Parameters:
    
    description - the value to set
    
    Returns:
    
    this builder
  - isLogical
```
public EntitySummary.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 EntitySummary.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 EntitySummary.Builder dataAssetKey(String dataAssetKey)
```
    Unique key of the parent data asset.
    
    Parameters:
    
    dataAssetKey - the value to set
    
    Returns:
    
    this builder
  - folderKey
```
public EntitySummary.Builder folderKey(String folderKey)
```
    Key of the associated folder.
    
    Parameters:
    
    folderKey - the value to set
    
    Returns:
    
    this builder
  - folderName
```
public EntitySummary.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
  - externalKey
```
public EntitySummary.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 EntitySummary.Builder patternKey(String patternKey)
```
    Key of the associated pattern if this is a logical entity.
    
    Parameters:
    
    patternKey - the value to set
    
    Returns:
    
    this builder
  - typeKey
```
public EntitySummary.Builder typeKey(String typeKey)
```
    The type of data entity object. Type keys can be found via the ‘/types’ endpoint.
    
    Parameters:
    
    typeKey - the value to set
    
    Returns:
    
    this builder
  - realizedExpression
```
public EntitySummary.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
  - path
```
public EntitySummary.Builder path(String path)
```
    Full path of the data entity.
    
    Parameters:
    
    path - the value to set
    
    Returns:
    
    this builder
  - timeCreated
```
public EntitySummary.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 EntitySummary.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
  - updatedById
```
public EntitySummary.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
  - uri
```
public EntitySummary.Builder uri(String uri)
```
    URI to the data entity instance in the API.
    
    Parameters:
    
    uri - the value to set
    
    Returns:
    
    this builder
  - objectStorageUrl
```
public EntitySummary.Builder objectStorageUrl(String objectStorageUrl)
```
    URL of the data entity in the object store.
    
    Parameters:
    
    objectStorageUrl - the value to set
    
    Returns:
    
    this builder
  - lifecycleState
```
public EntitySummary.Builder lifecycleState(LifecycleState lifecycleState)
```
    State of the data entity.
    
    Parameters:
    
    lifecycleState - the value to set
    
    Returns:
    
    this builder
  - lifecycleDetails
```
public EntitySummary.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
  - properties
```
public EntitySummary.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 EntitySummary build()
```
  - copy
```
public EntitySummary.Builder copy(EntitySummary model)
```

Class EntitySummary.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

key

displayName

businessName

description

isLogical

isPartition

dataAssetKey

folderKey

folderName

externalKey

patternKey

typeKey

realizedExpression

path

timeCreated

timeUpdated

updatedById

uri

objectStorageUrl

lifecycleState

lifecycleDetails

properties

build

copy