@Generated(value="OracleSDKGenerator", comments="API Version: 20190325") public final class Type extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
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 Type.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 |
Type.Builder |
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME
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,
String parentTypeKey,
String parentTypeName)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
static Type.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
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.
|
String |
getParentTypeKey()
Unique key of the parent type.
|
String |
getParentTypeName()
Name of the parent 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() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet
@Deprecated @ConstructorProperties(value={"key","name","description","catalogId","properties","lifecycleState","isInternal","isTag","isApproved","typeCategory","externalTypeName","uri","customProperties","parentTypeKey","parentTypeName"}) 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, String parentTypeKey, String parentTypeName)
public static Type.Builder builder()
Create a new builder.
public Type.Builder toBuilder()
public String getKey()
Unique type key that is immutable.
public String getName()
The immutable name of the type.
public String getDescription()
Detailed description of the type.
public String getCatalogId()
The data catalog’s OCID.
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 }, … ] } } }
public LifecycleState getLifecycleState()
The current state of the type.
public Boolean getIsInternal()
Indicates whether the type is internal, making it unavailable for use by metadata elements.
public Boolean getIsTag()
Indicates whether the type can be used for tagging metadata elements.
public Boolean getIsApproved()
Indicates whether the type is approved for use as a classifying object.
public String getTypeCategory()
Indicates the category this type belongs to. For instance, data assets, connections.
public String getExternalTypeName()
Mapping type equivalence in the external system.
public String getUri()
URI to the type instance in the API.
public List<CustomPropertySummary> getCustomProperties()
Custom properties associated with this Type.
public String getParentTypeKey()
Unique key of the parent type.
public String getParentTypeName()
Name of the parent type.
public String toString()
toString
in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
public 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.ExplicitlySetBmcModel
public int hashCode()
hashCode
in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
Copyright © 2016–2024. All rights reserved.