Package com.oracle.bmc.managementdashboard.model

Class ManagementSavedSearch

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.managementdashboard.model.ManagementSavedSearch

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20200901")
public final class ManagementSavedSearch
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

Properties of a saved search.
Note: Objects should always be created or deserialized using the ManagementSavedSearch.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 ManagementSavedSearch.Builder, which maintain a set of all explicitly set fields called ManagementSavedSearch.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	ManagementSavedSearch.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

ManagementSavedSearch(String id, String displayName, String providerId, String providerVersion, String providerName, String compartmentId, Boolean isOobSavedSearch, 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, List<Object> drilldownConfig, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags)

Deprecated.

Method Summary

Modifier and Type	Method	Description
static ManagementSavedSearch.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.
List<Object>	getDrilldownConfig()	Drill-down configuration to define the destination of a drill-down action.
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()	Name of the service (for example, Logging Analytics) that owns the saved search.
String	getProviderVersion()	Version of the service that owns this saved search.
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()
ManagementSavedSearch.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

ManagementSavedSearch

@Deprecated
@ConstructorProperties({"id","displayName","providerId","providerVersion","providerName","compartmentId","isOobSavedSearch","description","nls","type","uiConfig","dataConfig","createdBy","updatedBy","timeCreated","timeUpdated","screenImage","metadataVersion","widgetTemplate","widgetVM","lifecycleState","parametersConfig","featuresConfig","drilldownConfig","freeformTags","definedTags"})
public ManagementSavedSearch(String id,
                             String displayName,
                             String providerId,
                             String providerVersion,
                             String providerName,
                             String compartmentId,
                             Boolean isOobSavedSearch,
                             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,
                             List<Object> drilldownConfig,
                             Map<String,String> freeformTags,
                             Map<String,Map<String,Object>> definedTags)

Deprecated.

Method Detail

builder

public static ManagementSavedSearch.Builder builder()

Create a new builder.

toBuilder

public ManagementSavedSearch.Builder toBuilder()

getId

public String getId()

ID of the saved search.

Returns:

the value

getDisplayName

public String getDisplayName()

Display name of the saved search.

Returns:

the value

getProviderId

public String getProviderId()

ID of the service (for example log-analytics) that owns the saved search.

Each service has a unique ID.

Returns:

the value

getProviderVersion

public String getProviderVersion()

Version of the service that owns this saved search.

Returns:

the value

getProviderName

public String getProviderName()

Name of the service (for example, Logging Analytics) that owns the saved search.

Returns:

the value

getCompartmentId

public String getCompartmentId()

OCID of the compartment in which the saved search resides.

Returns:

the value

getIsOobSavedSearch

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.

Returns:

the value

getDescription

public String getDescription()

Description of the saved search.

Returns:

the value

getNls

public Object getNls()

JSON that contains internationalization options.

Returns:

the value

getType

public SavedSearchTypes getType()

Determines how the saved search is displayed in a dashboard.

Returns:

the value

getUiConfig

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.

Returns:

the value

getDataConfig

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.

Returns:

the value

getCreatedBy

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.

Returns:

the value

getUpdatedBy

public String getUpdatedBy()

The principle id of the user that updated this saved search.

Returns:

the value

getTimeCreated

public Date getTimeCreated()

Date and time the saved search was created.

Returns:

the value

getTimeUpdated

public Date getTimeUpdated()

Date and time the saved search was updated.

Returns:

the value

getScreenImage

public String getScreenImage()

Screen image of the saved search.

Returns:

the value

getMetadataVersion

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.

Returns:

the value

getWidgetTemplate

public String getWidgetTemplate()

The UI template that the saved search uses to render itself.

Returns:

the value

getWidgetVM

public String getWidgetVM()

The View Model that the saved search uses to render itself.

Returns:

the value

getLifecycleState

public LifecycleStates getLifecycleState()

OCI lifecycle status.

This is automatically managed by the system.

Returns:

the value

getParametersConfig

public List<Object> getParametersConfig()

Defines parameters for the saved search.

Returns:

the value

getFeaturesConfig

public Object getFeaturesConfig()

Contains configuration for enabling features.

Returns:

the value

getDrilldownConfig

public List<Object> getDrilldownConfig()

Drill-down configuration to define the destination of a drill-down action.

Returns:

the value

getFreeformTags

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”}

Returns:

the value

getDefinedTags

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”}}

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