@Generated(value="OracleSDKGenerator",
comments="API Version: 20190325")
public final class CreateCustomPropertyDetails
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
Properties used in custom property create operations.
Note: Objects should always be created or deserialized using the CreateCustomPropertyDetails.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 CreateCustomPropertyDetails.Builder, which maintain a
set of all explicitly set fields called CreateCustomPropertyDetails.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 |
CreateCustomPropertyDetails.Builder |
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME| Constructor and Description |
|---|
CreateCustomPropertyDetails(String displayName,
String description,
CustomPropertyDataType dataType,
Boolean isSortable,
Boolean isFilterable,
Boolean isMultiValued,
Boolean isHidden,
Boolean isEditable,
Boolean isShownInList,
Boolean isHiddenInSearch,
Boolean isEventEnabled,
List<String> allowedValues,
Map<String,Map<String,String>> properties)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static CreateCustomPropertyDetails.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
List<String> |
getAllowedValues()
Allowed values for the custom property if any
|
CustomPropertyDataType |
getDataType()
The data type of the custom property
|
String |
getDescription()
Detailed description of the custom property.
|
String |
getDisplayName()
A user-friendly display name.
|
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 |
getIsShownInList()
If this field is displayed in a list view of applicable objects.
|
Boolean |
getIsSortable()
If this field allows to sort from UI
|
Map<String,Map<String,String>> |
getProperties()
A map of maps that contains the properties which are specific to the data asset type.
|
int |
hashCode() |
CreateCustomPropertyDetails.Builder |
toBuilder() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet@Deprecated @ConstructorProperties(value={"displayName","description","dataType","isSortable","isFilterable","isMultiValued","isHidden","isEditable","isShownInList","isHiddenInSearch","isEventEnabled","allowedValues","properties"}) public CreateCustomPropertyDetails(String displayName, String description, CustomPropertyDataType dataType, Boolean isSortable, Boolean isFilterable, Boolean isMultiValued, Boolean isHidden, Boolean isEditable, Boolean isShownInList, Boolean isHiddenInSearch, Boolean isEventEnabled, List<String> allowedValues, Map<String,Map<String,String>> properties)
public static CreateCustomPropertyDetails.Builder builder()
Create a new builder.
public CreateCustomPropertyDetails.Builder toBuilder()
public String getDisplayName()
A user-friendly display name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
public String getDescription()
Detailed description of the custom property.
public CustomPropertyDataType getDataType()
The data type of the custom property
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 getIsHiddenInSearch()
If this field is allowed to pop in search results
public Boolean getIsEventEnabled()
If an OCI Event will be emitted when the custom property is modified.
public List<String> getAllowedValues()
Allowed values for the custom property if any
public Map<String,Map<String,String>> getProperties()
A map of maps that contains the properties which are specific to the data 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. To determine the set of optional and required properties for a data asset
type, a query can be done on ‘/types?type=dataAsset’ that returns a collection of all data
asset types. The appropriate data asset type, which includes definitions of all of it’s
properties, can be identified from this collection. 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.