@Generated(value="OracleSDKGenerator",
comments="API Version: 20190325")
public final class FolderSummary
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
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 FolderSummary.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set
fields into account. The constructor, on the other hand, does not take the explicitly set fields
into account (since the constructor cannot distinguish explicit null from unset null).
| Modifier and Type | Class and Description |
|---|---|
static class |
FolderSummary.Builder |
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME| Constructor and Description |
|---|
FolderSummary(String key,
String displayName,
String businessName,
String description,
String dataAssetKey,
String parentFolderKey,
String typeKey,
String path,
String externalKey,
Date timeExternal,
Date timeCreated,
Date timeUpdated,
String uri,
String objectStorageUrl,
LifecycleState lifecycleState,
String lifecycleDetails)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static FolderSummary.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
String |
getBusinessName()
Optional user friendly business name of the folder.
|
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.
|
String |
getLifecycleDetails()
A message describing the current state in more detail.
|
LifecycleState |
getLifecycleState()
State of the folder.
|
String |
getObjectStorageUrl()
URL of the folder in the object store.
|
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.
|
Date |
getTimeUpdated()
The date and time the folder was last updated, in the format defined by
RFC3339.
|
String |
getTypeKey()
The type of folder object.
|
String |
getUri()
URI of the folder resource within the data catalog API.
|
int |
hashCode() |
FolderSummary.Builder |
toBuilder() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet@Deprecated @ConstructorProperties(value={"key","displayName","businessName","description","dataAssetKey","parentFolderKey","typeKey","path","externalKey","timeExternal","timeCreated","timeUpdated","uri","objectStorageUrl","lifecycleState","lifecycleDetails"}) public FolderSummary(String key, String displayName, String businessName, String description, String dataAssetKey, String parentFolderKey, String typeKey, String path, String externalKey, Date timeExternal, Date timeCreated, Date timeUpdated, String uri, String objectStorageUrl, LifecycleState lifecycleState, String lifecycleDetails)
public static FolderSummary.Builder builder()
Create a new builder.
public FolderSummary.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 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 getTypeKey()
The type of folder object. Type keys can be found via the ‘/types’ endpoint.
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 Date getTimeUpdated()
The date and time the folder was last updated, 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 String getObjectStorageUrl()
URL of the folder in the object store.
public LifecycleState getLifecycleState()
State of the folder.
public String getLifecycleDetails()
A message describing the current state in more detail. An object not in ACTIVE state may have functional limitations, see service documentation for details.
public String toString()
toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic String toString(boolean includeByteArrayContents)
Return a string representation of the object.
includeByteArrayContents - true to include the full contents of byte arrayspublic boolean equals(Object o)
equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic int hashCode()
hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelCopyright © 2016–2024. All rights reserved.