@Generated(value="OracleSDKGenerator", comments="API Version: 20190325") public final class Folder extends Object
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.
Folder.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 Folder.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 |
Folder.Builder |
| Constructor and Description |
|---|
Folder(String key,
String displayName,
String businessName,
String description,
String parentFolderKey,
String typeKey,
Date timeHarvested,
List<ObjectRelationship> objectRelationships,
String path,
String dataAssetKey,
List<CustomPropertyGetUsage> customPropertyMembers,
Map<String,Map<String,String>> properties,
String externalKey,
Date timeCreated,
Date timeUpdated,
String createdById,
String updatedById,
Date timeExternal,
LifecycleState lifecycleState,
HarvestStatus harvestStatus,
String lastJobKey,
String uri,
String objectStorageUrl)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static Folder.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
Set<String> |
get__explicitlySet__() |
String |
getBusinessName()
Optional user friendly business name of the folder.
|
String |
getCreatedById()
OCID of the user who created the folder.
|
List<CustomPropertyGetUsage> |
getCustomPropertyMembers()
The list of customized properties along with the values for this object
|
String |
getDataAssetKey()
The key of the associated data asset.
|
String |
getDescription()
Detailed description of a folder.
|
String |
getDisplayName()
A user-friendly display name.
|
String |
getExternalKey()
Unique external key of this object in the source system.
|
HarvestStatus |
getHarvestStatus()
Status of the object as updated by the harvest process.
|
String |
getKey()
Unique folder key that is immutable.
|
String |
getLastJobKey()
The key of the last harvest process to update the metadata of this object.
|
LifecycleState |
getLifecycleState()
The current state of the folder.
|
List<ObjectRelationship> |
getObjectRelationships()
List of objects and their relationships to this folder.
|
String |
getObjectStorageUrl()
URL of the folder in the object store.
|
String |
getParentFolderKey()
The unique key of the containing folder or null if there is no parent folder.
|
String |
getPath()
Full path of the folder.
|
Map<String,Map<String,String>> |
getProperties()
A map of maps that contains the properties which are specific to the folder type.
|
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.
|
Date |
getTimeHarvested()
The date and time the folder was harvested, in the format defined by RFC3339.
|
Date |
getTimeUpdated()
The last time that any change was made to the folder.
|
String |
getTypeKey()
The type of folder object.
|
String |
getUpdatedById()
OCID of the user who modified the folder.
|
String |
getUri()
URI to the folder instance in the API.
|
int |
hashCode() |
Folder.Builder |
toBuilder() |
String |
toString() |
@ConstructorProperties(value={"key","displayName","businessName","description","parentFolderKey","typeKey","timeHarvested","objectRelationships","path","dataAssetKey","customPropertyMembers","properties","externalKey","timeCreated","timeUpdated","createdById","updatedById","timeExternal","lifecycleState","harvestStatus","lastJobKey","uri","objectStorageUrl"}) @Deprecated public Folder(String key, String displayName, String businessName, String description, String parentFolderKey, String typeKey, Date timeHarvested, List<ObjectRelationship> objectRelationships, String path, String dataAssetKey, List<CustomPropertyGetUsage> customPropertyMembers, Map<String,Map<String,String>> properties, String externalKey, Date timeCreated, Date timeUpdated, String createdById, String updatedById, Date timeExternal, LifecycleState lifecycleState, HarvestStatus harvestStatus, String lastJobKey, String uri, String objectStorageUrl)
public static Folder.Builder builder()
Create a new builder.
public Folder.Builder toBuilder()
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 getBusinessName()
Optional user friendly business name of the folder. If set, this supplements the harvested display name of the object.
public String getDescription()
Detailed description of a folder.
public String getParentFolderKey()
The unique key of the containing folder or null if there is no parent folder.
public String getTypeKey()
The type of folder object. Type keys can be found via the ‘/types’ endpoint.
public Date getTimeHarvested()
The date and time the folder was harvested, in the format defined by RFC3339.
public List<ObjectRelationship> getObjectRelationships()
List of objects and their relationships to this folder.
public String getPath()
Full path of the folder.
public String getDataAssetKey()
The key of the associated data asset.
public List<CustomPropertyGetUsage> getCustomPropertyMembers()
The list of customized properties along with the values for this object
public Map<String,Map<String,String>> getProperties()
A map of maps that contains the properties which are specific to the folder type. Each folder 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
folders have required properties within the “default” category.
Example: {"properties": { "default": { "key1": "value1"}}}
public String getExternalKey()
Unique external key of this object in the source 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 Date getTimeUpdated()
The last time that any change was made to the folder. An RFC3339 formatted datetime string.
public String getCreatedById()
OCID of the user who created the folder.
public String getUpdatedById()
OCID of the user who modified the folder.
public Date getTimeExternal()
Last modified timestamp of this object in the external system.
public LifecycleState getLifecycleState()
The current state of the folder.
public HarvestStatus getHarvestStatus()
Status of the object as updated by the harvest process.
public String getLastJobKey()
The key of the last harvest process to update the metadata of this object.
public String getUri()
URI to the folder instance in the API.
public String getObjectStorageUrl()
URL of the folder in the object store.
Copyright © 2016–2022. All rights reserved.