com.oracle.bmc.datacatalog.model

Class Type

java.lang.Object

com.oracle.bmc.datacatalog.model.Type

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20190325")
public final class Type
extends Object

Full data catalog type definition. Fully defines a type of the data catalog. All types are statically defined in the system and are immutable. It isn’t possible to create new types or update existing types via the API.

Note: Objects should always be created or deserialized using the Type.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 Type.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).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Type.Builder

Constructor Summary

Constructors

Constructor and Description
Type(String key, String name, String description, String catalogId, Map<String,List<PropertyDefinition>> properties, LifecycleState lifecycleState, Boolean isInternal, Boolean isTag, Boolean isApproved, String typeCategory, String externalTypeName, String uri, List<CustomPropertySummary> customProperties) Deprecated.

Method Summary

Modifier and Type	Method and Description
static Type.Builder	builder() Create a new builder.
boolean	equals(Object o)
Set<String>	get__explicitlySet__()
String	getCatalogId() The data catalog’s OCID.
List<CustomPropertySummary>	getCustomProperties() Custom properties associated with this Type.
String	getDescription() Detailed description of the type.
String	getExternalTypeName() Mapping type equivalence in the external system.
Boolean	getIsApproved() Indicates whether the type is approved for use as a classifying object.
Boolean	getIsInternal() Indicates whether the type is internal, making it unavailable for use by metadata elements.
Boolean	getIsTag() Indicates whether the type can be used for tagging metadata elements.
String	getKey() Unique type key that is immutable.
LifecycleState	getLifecycleState() The current state of the type.
String	getName() The immutable name of the type.
Map<String,List<PropertyDefinition>>	getProperties() A map of arrays which defines the type specific properties, both required and optional.
String	getTypeCategory() Indicates the category this type belongs to.
String	getUri() URI to the type instance in the API.
int	hashCode()
Type.Builder	toBuilder()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Type

@ConstructorProperties(value={"key","name","description","catalogId","properties","lifecycleState","isInternal","isTag","isApproved","typeCategory","externalTypeName","uri","customProperties"})
 @Deprecated
public Type(String key,
                                                                                                                                                                                                                           String name,
                                                                                                                                                                                                                           String description,
                                                                                                                                                                                                                           String catalogId,
                                                                                                                                                                                                                           Map<String,List<PropertyDefinition>> properties,
                                                                                                                                                                                                                           LifecycleState lifecycleState,
                                                                                                                                                                                                                           Boolean isInternal,
                                                                                                                                                                                                                           Boolean isTag,
                                                                                                                                                                                                                           Boolean isApproved,
                                                                                                                                                                                                                           String typeCategory,
                                                                                                                                                                                                                           String externalTypeName,
                                                                                                                                                                                                                           String uri,
                                                                                                                                                                                                                           List<CustomPropertySummary> customProperties)

Deprecated.

Method Detail

builder

public static Type.Builder builder()

Create a new builder.

toBuilder

public Type.Builder toBuilder()

getKey

public String getKey()

Unique type key that is immutable.

getName

public String getName()

The immutable name of the type.

getDescription

public String getDescription()

Detailed description of the type.

getCatalogId

public String getCatalogId()

The data catalog’s OCID.

getProperties

public Map<String,List<PropertyDefinition>> getProperties()

A map of arrays which defines the type specific properties, both required and optional. The map keys are category names and the values are arrays contiaing all property details. Every property is contained inside of a category. Most types have required properties within the "default" category. Example: { \"properties\": { \"default\": { \"attributes:\": [ { \"name\": \"host\", \"type\": \"string\", \"isRequired\": true, \"isUpdatable\": false }, ... ] } } }

getLifecycleState

public LifecycleState getLifecycleState()

The current state of the type.

getIsInternal

public Boolean getIsInternal()

Indicates whether the type is internal, making it unavailable for use by metadata elements.

getIsTag

public Boolean getIsTag()

Indicates whether the type can be used for tagging metadata elements.

getIsApproved

public Boolean getIsApproved()

Indicates whether the type is approved for use as a classifying object.

getTypeCategory

public String getTypeCategory()

Indicates the category this type belongs to. For instance, data assets, connections.

getExternalTypeName

public String getExternalTypeName()

Mapping type equivalence in the external system.

getUri

public String getUri()

URI to the type instance in the API.

getCustomProperties

public List<CustomPropertySummary> getCustomProperties()

Custom properties associated with this Type.

get__explicitlySet__

public Set<String> get__explicitlySet__()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object