com.oracle.bmc.managementdashboard.model

Class ManagementSavedSearch.Builder

java.lang.Object

com.oracle.bmc.managementdashboard.model.ManagementSavedSearch.Builder

Enclosing class:

ManagementSavedSearch

public static class ManagementSavedSearch.Builder
extends Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
ManagementSavedSearch	build()
ManagementSavedSearch.Builder	compartmentId(String compartmentId) OCID of the compartment in which the saved search resides.
ManagementSavedSearch.Builder	copy(ManagementSavedSearch model)
ManagementSavedSearch.Builder	createdBy(String createdBy) The principle id of the user that created this saved search.
ManagementSavedSearch.Builder	dataConfig(List<Object> dataConfig) It defines how data is fetched.
ManagementSavedSearch.Builder	definedTags(Map<String,Map<String,Object>> definedTags) Defined tags for this resource.
ManagementSavedSearch.Builder	description(String description) Description of the saved search.
ManagementSavedSearch.Builder	displayName(String displayName) Display name of the saved search.
ManagementSavedSearch.Builder	drilldownConfig(List<Object> drilldownConfig) Drill-down configuration to define the destination of a drill-down action.
ManagementSavedSearch.Builder	featuresConfig(Object featuresConfig) Contains configuration for enabling features.
ManagementSavedSearch.Builder	freeformTags(Map<String,String> freeformTags) Simple key-value pair that is applied without any predefined name, type or scope.
ManagementSavedSearch.Builder	id(String id) ID of the saved search.
ManagementSavedSearch.Builder	isOobSavedSearch(Boolean isOobSavedSearch) Determines whether the saved search is an Out-of-the-Box (OOB) saved search.
ManagementSavedSearch.Builder	lifecycleState(LifecycleStates lifecycleState) OCI lifecycle status.
ManagementSavedSearch.Builder	metadataVersion(String metadataVersion) The version of the metadata defined in the API.
ManagementSavedSearch.Builder	nls(Object nls) JSON that contains internationalization options.
ManagementSavedSearch.Builder	parametersConfig(List<Object> parametersConfig) Defines parameters for the saved search.
ManagementSavedSearch.Builder	providerId(String providerId) ID of the service (for example log-analytics) that owns the saved search.
ManagementSavedSearch.Builder	providerName(String providerName) Name of the service (for example, Logging Analytics) that owns the saved search.
ManagementSavedSearch.Builder	providerVersion(String providerVersion) Version of the service that owns this saved search.
ManagementSavedSearch.Builder	screenImage(String screenImage) Screen image of the saved search.
ManagementSavedSearch.Builder	timeCreated(Date timeCreated) Date and time the saved search was created.
ManagementSavedSearch.Builder	timeUpdated(Date timeUpdated) Date and time the saved search was updated.
ManagementSavedSearch.Builder	type(SavedSearchTypes type) Determines how the saved search is displayed in a dashboard.
ManagementSavedSearch.Builder	uiConfig(Object uiConfig) It defines the visualization type of the widget saved search, the UI options of that visualization type, the binding of data to the visualization.
ManagementSavedSearch.Builder	updatedBy(String updatedBy) The principle id of the user that updated this saved search.
ManagementSavedSearch.Builder	widgetTemplate(String widgetTemplate) The UI template that the saved search uses to render itself.
ManagementSavedSearch.Builder	widgetVM(String widgetVM) The View Model that the saved search uses to render itself.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

id

public ManagementSavedSearch.Builder id(String id)

ID of the saved search.

Parameters:

id - the value to set

Returns:

this builder

displayName

public ManagementSavedSearch.Builder displayName(String displayName)

Display name of the saved search.

Parameters:

displayName - the value to set

Returns:

this builder

providerId

public ManagementSavedSearch.Builder providerId(String providerId)

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

Parameters:

providerId - the value to set

Returns:

this builder

providerVersion

public ManagementSavedSearch.Builder providerVersion(String providerVersion)

Version of the service that owns this saved search.

Parameters:

providerVersion - the value to set

Returns:

this builder

providerName

public ManagementSavedSearch.Builder providerName(String providerName)

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

Parameters:

providerName - the value to set

Returns:

this builder

compartmentId

public ManagementSavedSearch.Builder compartmentId(String compartmentId)

OCID of the compartment in which the saved search resides.

Parameters:

compartmentId - the value to set

Returns:

this builder

isOobSavedSearch

public ManagementSavedSearch.Builder isOobSavedSearch(Boolean isOobSavedSearch)

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.

Parameters:

isOobSavedSearch - the value to set

Returns:

this builder

description

public ManagementSavedSearch.Builder description(String description)

Description of the saved search.

Parameters:

description - the value to set

Returns:

this builder

nls

public ManagementSavedSearch.Builder nls(Object nls)

JSON that contains internationalization options.

Parameters:

nls - the value to set

Returns:

this builder

type

public ManagementSavedSearch.Builder type(SavedSearchTypes type)

Determines how the saved search is displayed in a dashboard.

Parameters:

type - the value to set

Returns:

this builder

uiConfig

public ManagementSavedSearch.Builder uiConfig(Object uiConfig)

It defines the visualization type of the widget saved search, the UI options of that visualization type, the binding of data to the visualization.

Parameters:

uiConfig - the value to set

Returns:

this builder

dataConfig

public ManagementSavedSearch.Builder dataConfig(List<Object> dataConfig)

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.

Parameters:

dataConfig - the value to set

Returns:

this builder

createdBy

public ManagementSavedSearch.Builder createdBy(String createdBy)

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.

Parameters:

createdBy - the value to set

Returns:

this builder

updatedBy

public ManagementSavedSearch.Builder updatedBy(String updatedBy)

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

Parameters:

updatedBy - the value to set

Returns:

this builder

timeCreated

public ManagementSavedSearch.Builder timeCreated(Date timeCreated)

Date and time the saved search was created.

Parameters:

timeCreated - the value to set

Returns:

this builder

timeUpdated

public ManagementSavedSearch.Builder timeUpdated(Date timeUpdated)

Date and time the saved search was updated.

Parameters:

timeUpdated - the value to set

Returns:

this builder

screenImage

public ManagementSavedSearch.Builder screenImage(String screenImage)

Screen image of the saved search.

Parameters:

screenImage - the value to set

Returns:

this builder

metadataVersion

public ManagementSavedSearch.Builder metadataVersion(String metadataVersion)

The version of the metadata defined in the API. This is maintained and enforced by dashboard server. Currently it is 2.0.

Parameters:

metadataVersion - the value to set

Returns:

this builder

widgetTemplate

public ManagementSavedSearch.Builder widgetTemplate(String widgetTemplate)

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

Parameters:

widgetTemplate - the value to set

Returns:

this builder

widgetVM

public ManagementSavedSearch.Builder widgetVM(String widgetVM)

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

Parameters:

widgetVM - the value to set

Returns:

this builder

lifecycleState

public ManagementSavedSearch.Builder lifecycleState(LifecycleStates lifecycleState)

OCI lifecycle status. This is automatically managed by the system.

Parameters:

lifecycleState - the value to set

Returns:

this builder

parametersConfig

public ManagementSavedSearch.Builder parametersConfig(List<Object> parametersConfig)

Defines parameters for the saved search.

Parameters:

parametersConfig - the value to set

Returns:

this builder

featuresConfig

public ManagementSavedSearch.Builder featuresConfig(Object featuresConfig)

Contains configuration for enabling features.

Parameters:

featuresConfig - the value to set

Returns:

this builder

drilldownConfig

public ManagementSavedSearch.Builder drilldownConfig(List<Object> drilldownConfig)

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

Parameters:

drilldownConfig - the value to set

Returns:

this builder

freeformTags

public ManagementSavedSearch.Builder freeformTags(Map<String,String> freeformTags)

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

Parameters:

freeformTags - the value to set

Returns:

this builder

definedTags

public ManagementSavedSearch.Builder definedTags(Map<String,Map<String,Object>> definedTags)

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}}

Parameters:

definedTags - the value to set

Returns:

this builder

build

public ManagementSavedSearch build()

copy

public ManagementSavedSearch.Builder copy(ManagementSavedSearch model)