java.lang.Object
- com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
- - com.oracle.bmc.datacatalog.model.CustomPropertySummary

```
@Generated(value="OracleSDKGenerator",
           comments="API Version: 20190325")
public final class CustomPropertySummary
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
```
Summary of a custom property
Note: Objects should always be created or deserialized using the CustomPropertySummary.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 CustomPropertySummary.Builder, which maintain a set of all explicitly set fields called CustomPropertySummary.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 CustomPropertySummary.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
CustomPropertySummary(String key, String displayName, String description, CustomPropertyDataType dataType, String namespaceName, Boolean isSortable, Boolean isFilterable, Boolean isMultiValued, Boolean isHidden, Boolean isEditable, Boolean isShownInList, Boolean isServiceDefined, Boolean isHiddenInSearch, Date timeCreated, LifecycleState lifecycleState, Integer usageCount, List<CustomPropertyTypeUsage> scope, List<String> allowedValues, Date timeUpdated, String createdById, String updatedById, Boolean isEventEnabled, List<EventConfig> events)	Deprecated.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static CustomPropertySummary.Builder`	`builder()`	Create a new builder.
`boolean`	`equals(Object o)`
`List<String>`	`getAllowedValues()`	Allowed values for the custom property if any
`String`	`getCreatedById()`	OCID of the user who created the custom property.
`CustomPropertyDataType`	`getDataType()`	Data type of the custom property
`String`	`getDescription()`	Description of the custom property
`String`	`getDisplayName()`	Display name of the custom property
`List<EventConfig>`	`getEvents()`	Event configuration for this custom property, against the desired subset of object types to which the property applies.
`Boolean`	`getIsEditable()`	If this field is a editable field
`Boolean`	`getIsEventEnabled()`	If an OCI Event will be emitted when the custom property is modified.
`Boolean`	`getIsFilterable()`	If this field allows to filter or create facets from UI
`Boolean`	`getIsHidden()`	If this field is a hidden field
`Boolean`	`getIsHiddenInSearch()`	If this field is allowed to pop in search results
`Boolean`	`getIsMultiValued()`	If this field allows multiple values to be set
`Boolean`	`getIsServiceDefined()`	If this field is defined by service or by a user
`Boolean`	`getIsShownInList()`	If this field is displayed in a list view of applicable objects.
`Boolean`	`getIsSortable()`	If this field allows to sort from UI
`String`	`getKey()`	Unique custom property key that is immutable.
`LifecycleState`	`getLifecycleState()`	The current state of the custom property.
`String`	`getNamespaceName()`	Namespace name of the custom property
`List<CustomPropertyTypeUsage>`	`getScope()`	Type or scope of the custom property belongs to.
`Date`	`getTimeCreated()`	The date and time the custom property was created, in the format defined by RFC3339.
`Date`	`getTimeUpdated()`	The last time that any change was made to the custom property.
`String`	`getUpdatedById()`	OCID of the user who last modified the custom property.
`Integer`	`getUsageCount()`	Total number of first class objects using this custom property
`int`	`hashCode()`
`CustomPropertySummary.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

CustomPropertySummary

@Deprecated
@ConstructorProperties({"key","displayName","description","dataType","namespaceName","isSortable","isFilterable","isMultiValued","isHidden","isEditable","isShownInList","isServiceDefined","isHiddenInSearch","timeCreated","lifecycleState","usageCount","scope","allowedValues","timeUpdated","createdById","updatedById","isEventEnabled","events"})
public CustomPropertySummary(String key,
                             String displayName,
                             String description,
                             CustomPropertyDataType dataType,
                             String namespaceName,
                             Boolean isSortable,
                             Boolean isFilterable,
                             Boolean isMultiValued,
                             Boolean isHidden,
                             Boolean isEditable,
                             Boolean isShownInList,
                             Boolean isServiceDefined,
                             Boolean isHiddenInSearch,
                             Date timeCreated,
                             LifecycleState lifecycleState,
                             Integer usageCount,
                             List<CustomPropertyTypeUsage> scope,
                             List<String> allowedValues,
                             Date timeUpdated,
                             String createdById,
                             String updatedById,
                             Boolean isEventEnabled,
                             List<EventConfig> events)

Deprecated.

Method Detail
- builder
```
public static CustomPropertySummary.Builder builder()
```
  Create a new builder.
- toBuilder
```
public CustomPropertySummary.Builder toBuilder()
```
- getKey
```
public String getKey()
```
  Unique custom property key that is immutable.
  
  Returns:
  
  the value
- getDisplayName
```
public String getDisplayName()
```
  Display name of the custom property
  
  Returns:
  
  the value
- getDescription
```
public String getDescription()
```
  Description of the custom property
  
  Returns:
  
  the value
- getDataType
```
public CustomPropertyDataType getDataType()
```
  Data type of the custom property
  
  Returns:
  
  the value
- getNamespaceName
```
public String getNamespaceName()
```
  Namespace name of the custom property
  
  Returns:
  
  the value
- getIsSortable
```
public Boolean getIsSortable()
```
  If this field allows to sort from UI
  
  Returns:
  
  the value
- getIsFilterable
```
public Boolean getIsFilterable()
```
  If this field allows to filter or create facets from UI
  
  Returns:
  
  the value
- getIsMultiValued
```
public Boolean getIsMultiValued()
```
  If this field allows multiple values to be set
  
  Returns:
  
  the value
- getIsHidden
```
public Boolean getIsHidden()
```
  If this field is a hidden field
  
  Returns:
  
  the value
- getIsEditable
```
public Boolean getIsEditable()
```
  If this field is a editable field
  
  Returns:
  
  the value
- getIsShownInList
```
public Boolean getIsShownInList()
```
  If this field is displayed in a list view of applicable objects.
  
  Returns:
  
  the value
- getIsServiceDefined
```
public Boolean getIsServiceDefined()
```
  If this field is defined by service or by a user
  
  Returns:
  
  the value
- getIsHiddenInSearch
```
public Boolean getIsHiddenInSearch()
```
  If this field is allowed to pop in search results
  
  Returns:
  
  the value
- getTimeCreated
```
public Date getTimeCreated()
```
  The date and time the custom property was created, in the format defined by RFC3339.
  Example: 2019-03-25T21:10:29.600Z
  
  Returns:
  
  the value
- getLifecycleState
```
public LifecycleState getLifecycleState()
```
  The current state of the custom property.
  
  Returns:
  
  the value
- getUsageCount
```
public Integer getUsageCount()
```
  Total number of first class objects using this custom property
  
  Returns:
  
  the value
- getScope
```
public List<CustomPropertyTypeUsage> getScope()
```
  Type or scope of the custom property belongs to.
  This will be an array of type id it will be belongs to
  
  Returns:
  
  the value
- getAllowedValues
```
public List<String> getAllowedValues()
```
  Allowed values for the custom property if any
  
  Returns:
  
  the value
- getTimeUpdated
```
public Date getTimeUpdated()
```
  The last time that any change was made to the custom property.
  An RFC3339 formatted datetime string.
  
  Returns:
  
  the value
- getCreatedById
```
public String getCreatedById()
```
  OCID of the user who created the custom property.
  
  Returns:
  
  the value
- getUpdatedById
```
public String getUpdatedById()
```
  OCID of the user who last modified the custom property.
  
  Returns:
  
  the value
- getIsEventEnabled
```
public Boolean getIsEventEnabled()
```
  If an OCI Event will be emitted when the custom property is modified.
  
  Returns:
  
  the value
- getEvents
```
public List<EventConfig> getEvents()
```
  Event configuration for this custom property, against the desired subset of object types to which the property applies.
  
  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

Class CustomPropertySummary

Nested Class Summary

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

CustomPropertySummary

Method Detail

builder

toBuilder

getKey

getDisplayName

getDescription

getDataType

getNamespaceName

getIsSortable

getIsFilterable

getIsMultiValued

getIsHidden

getIsEditable

getIsShownInList

getIsServiceDefined

getIsHiddenInSearch

getTimeCreated

getLifecycleState

getUsageCount

getScope

getAllowedValues

getTimeUpdated

getCreatedById

getUpdatedById

getIsEventEnabled

getEvents

toString

toString

equals

hashCode