@Generated(value="OracleSDKGenerator",
comments="API Version: 20200901")
public final class ManagementSavedSearchSummary
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
Summary of the properties of a saved search.
Note: Objects should always be created or deserialized using the ManagementSavedSearchSummary.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 ManagementSavedSearchSummary.Builder, which maintain a
set of all explicitly set fields called ManagementSavedSearchSummary.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 |
ManagementSavedSearchSummary.Builder |
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME| Constructor and Description |
|---|
ManagementSavedSearchSummary(String id,
String displayName,
Boolean isOobSavedSearch,
String compartmentId,
String providerId,
String providerVersion,
String providerName,
String description,
Object nls,
SavedSearchTypes type,
Object uiConfig,
List<Object> dataConfig,
String createdBy,
String updatedBy,
Date timeCreated,
Date timeUpdated,
String screenImage,
String metadataVersion,
String widgetTemplate,
String widgetVM,
LifecycleStates lifecycleState,
List<Object> parametersConfig,
Object featuresConfig,
Map<String,String> freeformTags,
Map<String,Map<String,Object>> definedTags)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static ManagementSavedSearchSummary.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
String |
getCompartmentId()
OCID of the compartment in which the saved search resides.
|
String |
getCreatedBy()
The principle id of the user that created this saved search.
|
List<Object> |
getDataConfig()
It defines how data is fetched.
|
Map<String,Map<String,Object>> |
getDefinedTags()
Defined tags for this resource.
|
String |
getDescription()
Description of the saved search.
|
String |
getDisplayName()
Display name of the saved search.
|
Object |
getFeaturesConfig()
Contains configuration for enabling features.
|
Map<String,String> |
getFreeformTags()
Simple key-value pair that is applied without any predefined name, type or scope.
|
String |
getId()
ID of the saved search.
|
Boolean |
getIsOobSavedSearch()
Determines whether the saved search is an Out-of-the-Box (OOB) saved search.
|
LifecycleStates |
getLifecycleState()
OCI lifecycle status.
|
String |
getMetadataVersion()
The version of the metadata defined in the API.
|
Object |
getNls()
JSON that contains internationalization options.
|
List<Object> |
getParametersConfig()
Defines parameters for the saved search.
|
String |
getProviderId()
ID of the service (for example log-analytics) that owns the saved search.
|
String |
getProviderName()
The user friendly name of the service (for example, Logging Analytics) that owns the saved
search.
|
String |
getProviderVersion()
The version of the metadata of the provider.
|
String |
getScreenImage()
Screen image of the saved search.
|
Date |
getTimeCreated()
Date and time the saved search was created.
|
Date |
getTimeUpdated()
Date and time the saved search was updated.
|
SavedSearchTypes |
getType()
Determines how the saved search is displayed in a dashboard.
|
Object |
getUiConfig()
It defines the visualization type of the widget saved search, the UI options of that
visualization type, the binding of data to the visualization.
|
String |
getUpdatedBy()
The principle id of the user that updated this saved search
|
String |
getWidgetTemplate()
The UI template that the saved search uses to render itself.
|
String |
getWidgetVM()
The View Model that the saved search uses to render itself.
|
int |
hashCode() |
ManagementSavedSearchSummary.Builder |
toBuilder() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet@Deprecated @ConstructorProperties(value={"id","displayName","isOobSavedSearch","compartmentId","providerId","providerVersion","providerName","description","nls","type","uiConfig","dataConfig","createdBy","updatedBy","timeCreated","timeUpdated","screenImage","metadataVersion","widgetTemplate","widgetVM","lifecycleState","parametersConfig","featuresConfig","freeformTags","definedTags"}) public ManagementSavedSearchSummary(String id, String displayName, Boolean isOobSavedSearch, String compartmentId, String providerId, String providerVersion, String providerName, String description, Object nls, SavedSearchTypes type, Object uiConfig, List<Object> dataConfig, String createdBy, String updatedBy, Date timeCreated, Date timeUpdated, String screenImage, String metadataVersion, String widgetTemplate, String widgetVM, LifecycleStates lifecycleState, List<Object> parametersConfig, Object featuresConfig, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags)
public static ManagementSavedSearchSummary.Builder builder()
Create a new builder.
public ManagementSavedSearchSummary.Builder toBuilder()
public String getId()
ID of the saved search.
public String getDisplayName()
Display name of the saved search.
public Boolean getIsOobSavedSearch()
Determines whether the saved search is an Out-of-the-Box (OOB) saved search. Note that OOB saved searches are only provided by Oracle and cannot be modified.
public String getCompartmentId()
OCID of the compartment in which the saved search resides.
public String getProviderId()
ID of the service (for example log-analytics) that owns the saved search. Each service has a unique ID.
public String getProviderVersion()
The version of the metadata of the provider. This is useful for provider to version its features and metadata. Any newly created saved search (or dashboard) should use providerVersion 3.0.0.
public String getProviderName()
The user friendly name of the service (for example, Logging Analytics) that owns the saved search.
public String getDescription()
Description of the saved search.
public Object getNls()
JSON that contains internationalization options.
public SavedSearchTypes getType()
Determines how the saved search is displayed in a dashboard.
public Object getUiConfig()
It defines the visualization type of the widget saved search, the UI options of that visualization type, the binding of data to the visualization.
public List<Object> getDataConfig()
It defines how data is fetched. A functional saved search needs a valid dataConfig. See examples on how it can be constructed for various data sources.
public String getCreatedBy()
The principle id of the user that created this saved search. This is automatically managed by the system. In OCI the value is ignored. In EM it can skipped or otherwise it is ignored in both create and update API and system automatically sets its value.
public String getUpdatedBy()
The principle id of the user that updated this saved search
public Date getTimeCreated()
Date and time the saved search was created.
public Date getTimeUpdated()
Date and time the saved search was updated.
public String getScreenImage()
Screen image of the saved search.
public String getMetadataVersion()
The version of the metadata defined in the API. This is maintained and enforced by dashboard server. Currently it is 2.0.
public String getWidgetTemplate()
The UI template that the saved search uses to render itself.
public String getWidgetVM()
The View Model that the saved search uses to render itself.
public LifecycleStates getLifecycleState()
OCI lifecycle status. This is automatically managed by the system.
public List<Object> getParametersConfig()
Defines parameters for the saved search.
public Object getFeaturesConfig()
Contains configuration for enabling features.
public Map<String,String> getFreeformTags()
Simple key-value pair that is applied without any predefined name, type or scope. Exists for
cross-compatibility only. Example: {"bar-key": "value"}
public Map<String,Map<String,Object>> getDefinedTags()
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace": {"bar-key": "value"}}
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.