Package com.oracle.bmc.datacatalog.model

Class FolderSummary

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.datacatalog.model.FolderSummary

@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).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FolderSummary.Builder

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor	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.

Method Summary

Modifier and Type	Method	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.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

FolderSummary

@Deprecated
@ConstructorProperties({"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)

Deprecated.

Method Detail

builder

public static FolderSummary.Builder builder()

Create a new builder.

toBuilder

public FolderSummary.Builder toBuilder()

getKey

public String getKey()

Unique folder key that is immutable.

Returns:

the value

getDisplayName

public String getDisplayName()

A user-friendly display name.

Does not have to be unique, and it’s changeable. Avoid entering confidential information.

Returns:

the value

getBusinessName

public String getBusinessName()

Optional user friendly business name of the folder.

If set, this supplements the harvested display name of the object.

Returns:

the value

getDescription

public String getDescription()

Detailed description of a folder.

Returns:

the value

getDataAssetKey

public String getDataAssetKey()

The unique key of the parent data asset.

Returns:

the value

getParentFolderKey

public String getParentFolderKey()

The key of the containing folder or null if there is no parent.

Returns:

the value

getTypeKey

public String getTypeKey()

The type of folder object.

Type keys can be found via the ‘/types’ endpoint.

Returns:

the value

getPath

public String getPath()

Full path of the folder.

Returns:

the value

getExternalKey

public String getExternalKey()

Unique external key of this object from the source systems.

Returns:

the value

getTimeExternal

public Date getTimeExternal()

Last modified timestamp of this object in the external system.

Returns:

the value

getTimeCreated

public Date getTimeCreated()

The date and time the folder was created, in the format defined by RFC3339.

Example: 2019-03-25T21:10:29.600Z

Returns:

the value

getTimeUpdated

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

Returns:

the value

getUri

public String getUri()

URI of the folder resource within the data catalog API.

Returns:

the value

getObjectStorageUrl

public String getObjectStorageUrl()

URL of the folder in the object store.

Returns:

the value

getLifecycleState

public LifecycleState getLifecycleState()

State of the folder.

Returns:

the value

getLifecycleDetails

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.

Returns:

the value

toString

public String toString()

Overrides:

toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

hashCode

public int hashCode()

Overrides:

hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel