@Generated(value="OracleSDKGenerator", comments="API Version: 20190325") public final class FolderSummary extends Object
Summary of a folder. A generic term used in the data catalog for an external organization concept used for a collection of data entities or processes within a data asset. This term is an internal term which models multiple external types of folder, such as file directories, database schemas, and so on. Some data assets, such as Object Store containers, may contain many levels of folders.
Note: Objects should always be created or deserialized using the FolderSummary.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the FolderSummary.Builder, which maintain a set of all explicitly set fields called __explicitlySet__. The hashCode() and equals(Object) methods are implemented to take __explicitlySet__ into account. The constructor, on the other hand, does not set __explicitlySet__ (since the constructor cannot distinguish explicit null from unset null).
| Modifier and Type | Class and Description |
|---|---|
static class |
FolderSummary.Builder |
| Constructor and Description |
|---|
FolderSummary(String key,
String displayName,
String description,
String dataAssetKey,
String parentFolderKey,
String path,
String externalKey,
Date timeExternal,
Date timeCreated,
String uri,
LifecycleState lifecycleState)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static FolderSummary.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
Set<String> |
get__explicitlySet__() |
String |
getDataAssetKey()
The unique key of the parent data asset.
|
String |
getDescription()
Detailed description of a folder.
|
String |
getDisplayName()
A user-friendly display name.
|
String |
getExternalKey()
Unique external key of this object from the source systems.
|
String |
getKey()
Unique folder key that is immutable.
|
LifecycleState |
getLifecycleState()
State of the folder.
|
String |
getParentFolderKey()
The key of the containing folder or null if there is no parent.
|
String |
getPath()
Full path of the folder.
|
Date |
getTimeCreated()
The date and time the folder was created, in the format defined by RFC3339.
|
Date |
getTimeExternal()
Last modified timestamp of this object in the external system.
|
String |
getUri()
URI of the folder resource within the data catalog API.
|
int |
hashCode() |
String |
toString() |
@ConstructorProperties(value={"key","displayName","description","dataAssetKey","parentFolderKey","path","externalKey","timeExternal","timeCreated","uri","lifecycleState"}) @Deprecated public FolderSummary(String key, String displayName, String description, String dataAssetKey, String parentFolderKey, String path, String externalKey, Date timeExternal, Date timeCreated, String uri, LifecycleState lifecycleState)
public static FolderSummary.Builder builder()
Create a new builder.
public String getKey()
Unique folder key that is immutable.
public String getDisplayName()
A user-friendly display name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
public String getDescription()
Detailed description of a folder.
public String getDataAssetKey()
The unique key of the parent data asset.
public String getParentFolderKey()
The key of the containing folder or null if there is no parent.
public String getPath()
Full path of the folder.
public String getExternalKey()
Unique external key of this object from the source systems.
public Date getTimeExternal()
Last modified timestamp of this object in the external system.
public Date getTimeCreated()
The date and time the folder was created, in the format defined by RFC3339. Example: 2019-03-25T21:10:29.600Z
public String getUri()
URI of the folder resource within the data catalog API.
public LifecycleState getLifecycleState()
State of the folder.
Copyright © 2016–2020. All rights reserved.