@Generated(value="OracleSDKGenerator",
comments="API Version: 20190325")
public final class CustomProperty
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
Custom Property Definition
Note: Objects should always be created or deserialized using the CustomProperty.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 CustomProperty.Builder, which maintain a
set of all explicitly set fields called CustomProperty.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 |
CustomProperty.Builder |
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME| Constructor and Description |
|---|
CustomProperty(String key,
String displayName,
CustomPropertyDataType dataType,
String description,
String namespaceName,
Boolean isListType,
Boolean isSortable,
Boolean isFilterable,
Boolean isMultiValued,
Boolean isHidden,
Boolean isEditable,
Boolean isShownInList,
Boolean isServiceDefined,
Boolean isHiddenInSearch,
LifecycleState lifecycleState,
Date timeCreated,
Date timeUpdated,
String createdById,
String updatedById,
Integer usageCount,
Boolean isEventEnabled,
List<CustomPropertyTypeUsage> scope,
List<String> allowedValues,
List<EventConfig> events,
Map<String,Map<String,String>> properties)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static CustomProperty.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 for 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 |
getIsListType()
Is this property allowed to have list of values
|
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 data asset key that is immutable.
|
LifecycleState |
getLifecycleState()
The current state of the custom property.
|
String |
getNamespaceName()
Namespace name of the custom property
|
Map<String,Map<String,String>> |
getProperties()
A map of maps that contains the properties which are specific to the asset type.
|
List<CustomPropertyTypeUsage> |
getScope()
The set of object types to which the custom property applies.
|
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() |
CustomProperty.Builder |
toBuilder() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet@Deprecated @ConstructorProperties(value={"key","displayName","dataType","description","namespaceName","isListType","isSortable","isFilterable","isMultiValued","isHidden","isEditable","isShownInList","isServiceDefined","isHiddenInSearch","lifecycleState","timeCreated","timeUpdated","createdById","updatedById","usageCount","isEventEnabled","scope","allowedValues","events","properties"}) public CustomProperty(String key, String displayName, CustomPropertyDataType dataType, String description, String namespaceName, Boolean isListType, Boolean isSortable, Boolean isFilterable, Boolean isMultiValued, Boolean isHidden, Boolean isEditable, Boolean isShownInList, Boolean isServiceDefined, Boolean isHiddenInSearch, LifecycleState lifecycleState, Date timeCreated, Date timeUpdated, String createdById, String updatedById, Integer usageCount, Boolean isEventEnabled, List<CustomPropertyTypeUsage> scope, List<String> allowedValues, List<EventConfig> events, Map<String,Map<String,String>> properties)
public static CustomProperty.Builder builder()
Create a new builder.
public CustomProperty.Builder toBuilder()
public String getKey()
Unique data asset key that is immutable.
public String getDisplayName()
Display name of the custom property
public CustomPropertyDataType getDataType()
Data type of the custom property
public String getDescription()
Description for the custom property
public String getNamespaceName()
Namespace name of the custom property
public Boolean getIsListType()
Is this property allowed to have list of values
public Boolean getIsSortable()
If this field allows to sort from UI
public Boolean getIsFilterable()
If this field allows to filter or create facets from UI
public Boolean getIsMultiValued()
If this field allows multiple values to be set
public Boolean getIsHidden()
If this field is a hidden field
public Boolean getIsEditable()
If this field is a editable field
public Boolean getIsShownInList()
If this field is displayed in a list view of applicable objects.
public Boolean getIsServiceDefined()
If this field is defined by service or by a user
public Boolean getIsHiddenInSearch()
If this field is allowed to pop in search results
public LifecycleState getLifecycleState()
The current state of the custom property.
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
public Date getTimeUpdated()
The last time that any change was made to the custom property. An RFC3339 formatted datetime string.
public String getCreatedById()
OCID of the user who created the custom property.
public String getUpdatedById()
OCID of the user who last modified the custom property.
public Integer getUsageCount()
Total number of first class objects using this custom property
public Boolean getIsEventEnabled()
If an OCI Event will be emitted when the custom property is modified.
public List<CustomPropertyTypeUsage> getScope()
The set of object types to which the custom property applies.
public List<String> getAllowedValues()
Allowed values for the custom property if any
public List<EventConfig> getEvents()
Event configuration for this custom property, against the desired subset of object types to which the property applies.
public Map<String,Map<String,String>> getProperties()
A map of maps that contains the properties which are specific to the asset type. Each data
asset type definition defines it’s set of required and optional properties. The map keys are
category names and the values are maps of property name to property value. Every property is
contained inside of a category. Most data assets have required properties within the
“default” category. Example: {"properties": { "default": { "host": "host1", "port":
"1521", "database": "orcl"}}}
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.