Package com.oracle.bmc.managementdashboard.model

Class CreateManagementSavedSearchDetails.Builder

java.lang.Object

com.oracle.bmc.managementdashboard.model.CreateManagementSavedSearchDetails.Builder

Enclosing class:

CreateManagementSavedSearchDetails

public static class CreateManagementSavedSearchDetails.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CreateManagementSavedSearchDetails	build()
CreateManagementSavedSearchDetails.Builder	compartmentId(String compartmentId)	OCID of the compartment in which the saved search resides.
CreateManagementSavedSearchDetails.Builder	copy(CreateManagementSavedSearchDetails model)
CreateManagementSavedSearchDetails.Builder	dataConfig(List<Object> dataConfig)	It defines how data is fetched.
CreateManagementSavedSearchDetails.Builder	definedTags(Map<String,Map<String,Object>> definedTags)	Defined tags for this resource.
CreateManagementSavedSearchDetails.Builder	description(String description)	Description of the saved search.
CreateManagementSavedSearchDetails.Builder	displayName(String displayName)	Display name of the saved search.
CreateManagementSavedSearchDetails.Builder	drilldownConfig(List<Object> drilldownConfig)	Drill-down configuration to define the destination of a drill-down action.
CreateManagementSavedSearchDetails.Builder	featuresConfig(Object featuresConfig)	Contains configuration for enabling features.
CreateManagementSavedSearchDetails.Builder	freeformTags(Map<String,String> freeformTags)	Simple key-value pair that is applied without any predefined name, type or scope.
CreateManagementSavedSearchDetails.Builder	id(String id)	ID of the saved search, which must only be provided for Out-of-the-Box (OOB) saved search.
CreateManagementSavedSearchDetails.Builder	isOobSavedSearch(Boolean isOobSavedSearch)	Determines whether the saved search is an Out-of-the-Box (OOB) saved search.
CreateManagementSavedSearchDetails.Builder	metadataVersion(String metadataVersion)	The version of the metadata defined in the API.
CreateManagementSavedSearchDetails.Builder	nls(Object nls)	JSON that contains internationalization options.
CreateManagementSavedSearchDetails.Builder	parametersConfig(List<Object> parametersConfig)	Defines parameters for the saved search.
CreateManagementSavedSearchDetails.Builder	providerId(String providerId)	ID of the service (for example log-analytics) that owns the saved search.
CreateManagementSavedSearchDetails.Builder	providerName(String providerName)	The user friendly name of the service (for example, Logging Analytics) that owns the saved search.
CreateManagementSavedSearchDetails.Builder	providerVersion(String providerVersion)	The version of the metadata of the provider.
CreateManagementSavedSearchDetails.Builder	screenImage(String screenImage)	Screen image of the saved search.
CreateManagementSavedSearchDetails.Builder	type(SavedSearchTypes type)	Determines how the saved search is displayed in a dashboard.
CreateManagementSavedSearchDetails.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.
CreateManagementSavedSearchDetails.Builder	widgetTemplate(String widgetTemplate)	The UI template that the saved search uses to render itself.
CreateManagementSavedSearchDetails.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 CreateManagementSavedSearchDetails.Builder id(String id)

ID of the saved search, which must only be provided for Out-of-the-Box (OOB) saved search.

Parameters:

id - the value to set

Returns:

this builder

displayName

public CreateManagementSavedSearchDetails.Builder displayName(String displayName)

Display name of the saved search.

Parameters:

displayName - the value to set

Returns:

this builder

providerId

public CreateManagementSavedSearchDetails.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 CreateManagementSavedSearchDetails.Builder providerVersion(String providerVersion)

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.

Parameters:

providerVersion - the value to set

Returns:

this builder

providerName

public CreateManagementSavedSearchDetails.Builder providerName(String providerName)

The user friendly name of the service (for example, Logging Analytics) that owns the saved search.

Parameters:

providerName - the value to set

Returns:

this builder

compartmentId

public CreateManagementSavedSearchDetails.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 CreateManagementSavedSearchDetails.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 CreateManagementSavedSearchDetails.Builder description(String description)

Description of the saved search.

Parameters:

description - the value to set

Returns:

this builder

nls

public CreateManagementSavedSearchDetails.Builder nls(Object nls)

JSON that contains internationalization options.

Parameters:

nls - the value to set

Returns:

this builder

type

public CreateManagementSavedSearchDetails.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 CreateManagementSavedSearchDetails.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 CreateManagementSavedSearchDetails.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

screenImage

public CreateManagementSavedSearchDetails.Builder screenImage(String screenImage)

Screen image of the saved search.

Parameters:

screenImage - the value to set

Returns:

this builder

metadataVersion

public CreateManagementSavedSearchDetails.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 CreateManagementSavedSearchDetails.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 CreateManagementSavedSearchDetails.Builder widgetVM(String widgetVM)

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

Parameters:

widgetVM - the value to set

Returns:

this builder

parametersConfig

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

Defines parameters for the saved search.

Parameters:

parametersConfig - the value to set

Returns:

this builder

featuresConfig

public CreateManagementSavedSearchDetails.Builder featuresConfig(Object featuresConfig)

Contains configuration for enabling features.

Parameters:

featuresConfig - the value to set

Returns:

this builder

drilldownConfig

public CreateManagementSavedSearchDetails.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 CreateManagementSavedSearchDetails.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 CreateManagementSavedSearchDetails.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 CreateManagementSavedSearchDetails build()

copy

public CreateManagementSavedSearchDetails.Builder copy(CreateManagementSavedSearchDetails model)