SearchResult.Builder (Oracle Cloud Infrastructure Java SDK

java.lang.Object
- com.oracle.bmc.datacatalog.model.SearchResult.Builder

Enclosing class:: SearchResult

public static class SearchResult.Builder
extends Object

Constructor Summary

Constructors
Constructor and Description

Builder()

Constructors
Constructor and Description
`Builder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SearchResult.Builder`	`attributeType(String attributeType)` Type name of the attribute.
`SearchResult`	`build()`
`SearchResult.Builder`	`businessName(String businessName)` Optional user friendly business name of the data object.
`SearchResult.Builder`	`copy(SearchResult model)`
`SearchResult.Builder`	`createdById(String createdById)` OCID of the user who created the resource.
`SearchResult.Builder`	`customProperties(List<FacetedSearchCustomProperty> customProperties)` Custom properties defined by users.
`SearchResult.Builder`	`dataAssetKey(String dataAssetKey)` Unique key of the data asset that is the root parent of this object.
`SearchResult.Builder`	`dataAssetName(String dataAssetName)` Name of the data asset that is the root parent of this object.
`SearchResult.Builder`	`dataAssetType(String dataAssetType)` Type name of the data asset.
`SearchResult.Builder`	`description(String description)` Detailed description of the object.
`SearchResult.Builder`	`entitykey(String entitykey)` Unique key of the entity object if this object is an attribute.
`SearchResult.Builder`	`entityName(String entityName)` Name of the parent entity object if this object is an attribute.
`SearchResult.Builder`	`entityType(String entityType)` Type name of the entity.
`SearchResult.Builder`	`expression(String expression)` Expression for logical entities against which names of dataObjects will be matched.
`SearchResult.Builder`	`externalDataType(String externalDataType)` Data type of the object if the object is an attribute.
`SearchResult.Builder`	`externalTypeName(String externalTypeName)` Name of the external object type in the host data asset.
`SearchResult.Builder`	`folderKey(String folderKey)` Unique key of the folder object if this object is a sub folder, entity, or attribute.
`SearchResult.Builder`	`folderName(String folderName)` Name of the parent folder object if this object is a sub folder, entity, or attribute.
`SearchResult.Builder`	`folderType(String folderType)` Type name of the folder.
`SearchResult.Builder`	`glossaryKey(String glossaryKey)` Unique id of the parent glossary.
`SearchResult.Builder`	`glossaryName(String glossaryName)` Name of the parent glossary if this object is a term.
`SearchResult.Builder`	`key(String key)` Unique key of the object returned as part of the search result.
`SearchResult.Builder`	`lifecycleState(LifecycleState lifecycleState)` The current state of the data object.
`SearchResult.Builder`	`name(String name)` Name of the object.
`SearchResult.Builder`	`parentTermKey(String parentTermKey)` This terms parent term key.
`SearchResult.Builder`	`parentTermName(String parentTermName)` Name of the parent term.
`SearchResult.Builder`	`path(String path)` Absolute path of this resource, which could be a term, folder, entity etc, usually resolvable to this resource through a namespace hierarchy.
`SearchResult.Builder`	`properties(Map<String,Map<String,String>> properties)` A map of maps that contains the properties which are specific to the element type in the search result.
`SearchResult.Builder`	`tagSummary(List<SearchTagSummary> tagSummary)` Array of the tags associated with this object.
`SearchResult.Builder`	`termSummary(List<SearchTermSummary> termSummary)` Array of the terms associated with this object.
`SearchResult.Builder`	`timeCreated(Date timeCreated)` The date and time the result object was created, in the format defined by RFC3339.
`SearchResult.Builder`	`timeUpdated(Date timeUpdated)` The date and time the result object was updated, in the format defined by RFC3339.
`SearchResult.Builder`	`typeName(String typeName)` Name of the object type.
`SearchResult.Builder`	`updatedById(String updatedById)` OCID of the user who updated the resource.

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
  - key
```
public SearchResult.Builder key(String key)
```
    Unique key of the object returned as part of the search result.
    
    Parameters:
    
    key - the value to set
    
    Returns:
    
    this builder
  - name
```
public SearchResult.Builder name(String name)
```
    Name of the object.
    
    Parameters:
    
    name - the value to set
    
    Returns:
    
    this builder
  - description
```
public SearchResult.Builder description(String description)
```
    Detailed description of the object.
    
    Parameters:
    
    description - the value to set
    
    Returns:
    
    this builder
  - timeCreated
```
public SearchResult.Builder timeCreated(Date timeCreated)
```
    The date and time the result object was created, in the format defined by RFC3339. Example: 2019-03-25T21:10:29.600Z
    
    Parameters:
    
    timeCreated - the value to set
    
    Returns:
    
    this builder
  - timeUpdated
```
public SearchResult.Builder timeUpdated(Date timeUpdated)
```
    The date and time the result object was updated, in the format defined by RFC3339. Example: 2019-03-25T21:10:29.600Z
    
    Parameters:
    
    timeUpdated - the value to set
    
    Returns:
    
    this builder
  - tagSummary
```
public SearchResult.Builder tagSummary(List<SearchTagSummary> tagSummary)
```
    Array of the tags associated with this object.
    
    Parameters:
    
    tagSummary - the value to set
    
    Returns:
    
    this builder
  - termSummary
```
public SearchResult.Builder termSummary(List<SearchTermSummary> termSummary)
```
    Array of the terms associated with this object.
    
    Parameters:
    
    termSummary - the value to set
    
    Returns:
    
    this builder
  - typeName
```
public SearchResult.Builder typeName(String typeName)
```
    Name of the object type.
    
    Parameters:
    
    typeName - the value to set
    
    Returns:
    
    this builder
  - externalTypeName
```
public SearchResult.Builder externalTypeName(String externalTypeName)
```
    Name of the external object type in the host data asset. For example, column, field, table, view, or file.
    
    Parameters:
    
    externalTypeName - the value to set
    
    Returns:
    
    this builder
  - externalDataType
```
public SearchResult.Builder externalDataType(String externalDataType)
```
    Data type of the object if the object is an attribute. Null otherwise.
    
    Parameters:
    
    externalDataType - the value to set
    
    Returns:
    
    this builder
  - dataAssetKey
```
public SearchResult.Builder dataAssetKey(String dataAssetKey)
```
    Unique key of the data asset that is the root parent of this object.
    
    Parameters:
    
    dataAssetKey - the value to set
    
    Returns:
    
    this builder
  - dataAssetType
```
public SearchResult.Builder dataAssetType(String dataAssetType)
```
    Type name of the data asset. For example, Oracle, MySQL or Oracle Object Storage.
    
    Parameters:
    
    dataAssetType - the value to set
    
    Returns:
    
    this builder
  - dataAssetName
```
public SearchResult.Builder dataAssetName(String dataAssetName)
```
    Name of the data asset that is the root parent of this object.
    
    Parameters:
    
    dataAssetName - the value to set
    
    Returns:
    
    this builder
  - folderKey
```
public SearchResult.Builder folderKey(String folderKey)
```
    Unique key of the folder object if this object is a sub folder, entity, or attribute.
    
    Parameters:
    
    folderKey - the value to set
    
    Returns:
    
    this builder
  - folderType
```
public SearchResult.Builder folderType(String folderType)
```
    Type name of the folder. For example, schema, directory, or topic.
    
    Parameters:
    
    folderType - the value to set
    
    Returns:
    
    this builder
  - folderName
```
public SearchResult.Builder folderName(String folderName)
```
    Name of the parent folder object if this object is a sub folder, entity, or attribute.
    
    Parameters:
    
    folderName - the value to set
    
    Returns:
    
    this builder
  - entitykey
```
public SearchResult.Builder entitykey(String entitykey)
```
    Unique key of the entity object if this object is an attribute.
    
    Parameters:
    
    entitykey - the value to set
    
    Returns:
    
    this builder
  - entityType
```
public SearchResult.Builder entityType(String entityType)
```
    Type name of the entity. For example, table, view, external table, file, or object.
    
    Parameters:
    
    entityType - the value to set
    
    Returns:
    
    this builder
  - entityName
```
public SearchResult.Builder entityName(String entityName)
```
    Name of the parent entity object if this object is an attribute.
    
    Parameters:
    
    entityName - the value to set
    
    Returns:
    
    this builder
  - glossaryKey
```
public SearchResult.Builder glossaryKey(String glossaryKey)
```
    Unique id of the parent glossary.
    
    Parameters:
    
    glossaryKey - the value to set
    
    Returns:
    
    this builder
  - glossaryName
```
public SearchResult.Builder glossaryName(String glossaryName)
```
    Name of the parent glossary if this object is a term.
    
    Parameters:
    
    glossaryName - the value to set
    
    Returns:
    
    this builder
  - parentTermKey
```
public SearchResult.Builder parentTermKey(String parentTermKey)
```
    This terms parent term key. Will be null if the term has no parent term.
    
    Parameters:
    
    parentTermKey - the value to set
    
    Returns:
    
    this builder
  - parentTermName
```
public SearchResult.Builder parentTermName(String parentTermName)
```
    Name of the parent term. Will be null if the term has no parent term.
    
    Parameters:
    
    parentTermName - the value to set
    
    Returns:
    
    this builder
  - createdById
```
public SearchResult.Builder createdById(String createdById)
```
    OCID of the user who created the resource.
    
    Parameters:
    
    createdById - the value to set
    
    Returns:
    
    this builder
  - updatedById
```
public SearchResult.Builder updatedById(String updatedById)
```
    OCID of the user who updated the resource.
    
    Parameters:
    
    updatedById - the value to set
    
    Returns:
    
    this builder
  - path
```
public SearchResult.Builder path(String path)
```
    Absolute path of this resource, which could be a term, folder, entity etc, usually resolvable to this resource through a namespace hierarchy.
    
    Parameters:
    
    path - the value to set
    
    Returns:
    
    this builder
  - businessName
```
public SearchResult.Builder businessName(String businessName)
```
    Optional user friendly business name of the data object. If set, this supplements the harvested display name of the object.
    
    Parameters:
    
    businessName - the value to set
    
    Returns:
    
    this builder
  - lifecycleState
```
public SearchResult.Builder lifecycleState(LifecycleState lifecycleState)
```
    The current state of the data object.
    
    Parameters:
    
    lifecycleState - the value to set
    
    Returns:
    
    this builder
  - attributeType
```
public SearchResult.Builder attributeType(String attributeType)
```
    Type name of the attribute. For example - complex, primitive, or array.
    
    Parameters:
    
    attributeType - the value to set
    
    Returns:
    
    this builder
  - expression
```
public SearchResult.Builder expression(String expression)
```
    Expression for logical entities against which names of dataObjects will be matched.
    
    Parameters:
    
    expression - the value to set
    
    Returns:
    
    this builder
  - customProperties
```
public SearchResult.Builder customProperties(List<FacetedSearchCustomProperty> customProperties)
```
    Custom properties defined by users.
    
    Parameters:
    
    customProperties - the value to set
    
    Returns:
    
    this builder
  - properties
```
public SearchResult.Builder properties(Map<String,Map<String,String>> properties)
```
    A map of maps that contains the properties which are specific to the element type in the search result. 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 element types have required properties within the “default” category. Example: {"properties": { "default": { "key1": "value1"}}}
    
    Parameters:
    
    properties - the value to set
    
    Returns:
    
    this builder
  - build
```
public SearchResult build()
```
  - copy
```
public SearchResult.Builder copy(SearchResult model)
```

Class SearchResult.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

key

name

description

timeCreated

timeUpdated

tagSummary

termSummary

typeName

externalTypeName

externalDataType

dataAssetKey

dataAssetType

dataAssetName

folderKey

folderType

folderName

entitykey

entityType

entityName

glossaryKey

glossaryName

parentTermKey

parentTermName

createdById

updatedById

path

businessName

lifecycleState

attributeType

expression

customProperties

properties

build

copy