ListEntitiesRequest.Builder (Oracle Cloud Infrastructure Java SDK

java.lang.Object
- com.oracle.bmc.datacatalog.requests.ListEntitiesRequest.Builder

All Implemented Interfaces:: BmcRequest.Builder<ListEntitiesRequest,Void>

Enclosing class:: ListEntitiesRequest

public static class ListEntitiesRequest.Builder
extends Object
implements BmcRequest.Builder<ListEntitiesRequest,Void>

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
`ListEntitiesRequest`	`build()` Build the instance of ListEntitiesRequest as configured by this builder
`ListEntitiesRequest`	`buildWithoutInvocationCallback()` Build the instance of ListEntitiesRequest as configured by this builder
`ListEntitiesRequest.Builder`	`businessName(String businessName)` A filter to return only resources that match the entire business name given.
`ListEntitiesRequest.Builder`	`catalogId(String catalogId)` Unique catalog identifier.
`ListEntitiesRequest.Builder`	`copy(ListEntitiesRequest o)` Copy method to populate the builder with values from the given instance.
`ListEntitiesRequest.Builder`	`createdById(String createdById)` OCID of the user who created the resource.
`ListEntitiesRequest.Builder`	`dataAssetKey(String dataAssetKey)` Unique data asset key.
`ListEntitiesRequest.Builder`	`displayName(String displayName)` A filter to return only resources that match the entire display name given.
`ListEntitiesRequest.Builder`	`displayNameContains(String displayNameContains)` A filter to return only resources that match display name pattern given.
`ListEntitiesRequest.Builder`	`displayOrBusinessNameContains(String displayOrBusinessNameContains)` A filter to return only resources that match display name or business name pattern given.
`ListEntitiesRequest.Builder`	`externalKey(String externalKey)` Unique external identifier of this resource in the external source system.
`ListEntitiesRequest.Builder`	`fields(List<ListEntitiesRequest.Fields> fields)` Specifies the fields to return in an entity summary response.
`ListEntitiesRequest.Builder`	`fields(ListEntitiesRequest.Fields singularValue)` Singular setter.
`ListEntitiesRequest.Builder`	`folderKey(String folderKey)` Key of the associated folder.
`ListEntitiesRequest.Builder`	`harvestStatus(HarvestStatus harvestStatus)` Harvest status of the harvestable resource as updated by the harvest process.
`ListEntitiesRequest.Builder`	`invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)` Set the invocation callback for the request to be built.
`ListEntitiesRequest.Builder`	`isLogical(Boolean isLogical)` Identifies if the object is a physical object (materialized) or virtual/logical object defined on other objects.
`ListEntitiesRequest.Builder`	`isPartition(Boolean isPartition)` Identifies if an object is a sub object (partition) of a physical or materialized parent object.
`ListEntitiesRequest.Builder`	`lastJobKey(String lastJobKey)` Key of the last harvest process to update this resource.
`ListEntitiesRequest.Builder`	`lifecycleState(LifecycleState lifecycleState)` A filter to return only resources that match the specified lifecycle state.
`ListEntitiesRequest.Builder`	`limit(Integer limit)` The maximum number of items to return.
`ListEntitiesRequest.Builder`	`opcRequestId(String opcRequestId)` The client request ID for tracing.
`ListEntitiesRequest.Builder`	`page(String page)` The page token representing the page at which to start retrieving results.
`ListEntitiesRequest.Builder`	`path(String path)` Full path of the resource for resources that support paths.
`ListEntitiesRequest.Builder`	`patternKey(String patternKey)` Unique pattern key.
`ListEntitiesRequest.Builder`	`retryConfiguration(RetryConfiguration retryConfiguration)` Set the retry configuration for the request to be built.
`ListEntitiesRequest.Builder`	`sortBy(ListEntitiesRequest.SortBy sortBy)` The field to sort by.
`ListEntitiesRequest.Builder`	`sortOrder(ListEntitiesRequest.SortOrder sortOrder)` The sort order to use, either ‘asc’ or ‘desc’.
`ListEntitiesRequest.Builder`	`timeCreated(Date timeCreated)` Time that the resource was created.
`ListEntitiesRequest.Builder`	`timeExternal(Date timeExternal)` Last modified timestamp of this object in the external system.
`ListEntitiesRequest.Builder`	`timeStatusUpdated(Date timeStatusUpdated)` Time that the resource’s status was last updated.
`ListEntitiesRequest.Builder`	`timeUpdated(Date timeUpdated)` Time that the resource was updated.
`ListEntitiesRequest.Builder`	`typeKey(String typeKey)` The key of the object type.
`ListEntitiesRequest.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

Methods inherited from interface com.oracle.bmc.requests.BmcRequest.Builder
body$

- Constructor Detail
  - Builder
```
public Builder()
```
- Method Detail
  - catalogId
```
public ListEntitiesRequest.Builder catalogId(String catalogId)
```
    Unique catalog identifier.
    
    Parameters:
    
    catalogId - the value to set
    
    Returns:
    
    this builder instance
  - dataAssetKey
```
public ListEntitiesRequest.Builder dataAssetKey(String dataAssetKey)
```
    Unique data asset key.
    
    Parameters:
    
    dataAssetKey - the value to set
    
    Returns:
    
    this builder instance
  - displayName
```
public ListEntitiesRequest.Builder displayName(String displayName)
```
    A filter to return only resources that match the entire display name given. The match is not case sensitive.
    
    Parameters:
    
    displayName - the value to set
    
    Returns:
    
    this builder instance
  - businessName
```
public ListEntitiesRequest.Builder businessName(String businessName)
```
    A filter to return only resources that match the entire business name given. The match is not case sensitive.
    
    Parameters:
    
    businessName - the value to set
    
    Returns:
    
    this builder instance
  - displayOrBusinessNameContains
```
public ListEntitiesRequest.Builder displayOrBusinessNameContains(String displayOrBusinessNameContains)
```
    A filter to return only resources that match display name or business name pattern given. The match is not case sensitive. For Example : /folders?displayOrBusinessNameContains=Cu.* The above would match all folders with display name or business name that starts with “Cu” or has the pattern “Cu” anywhere in between.
    
    Parameters:
    
    displayOrBusinessNameContains - the value to set
    
    Returns:
    
    this builder instance
  - typeKey
```
public ListEntitiesRequest.Builder typeKey(String typeKey)
```
    The key of the object type.
    
    Parameters:
    
    typeKey - the value to set
    
    Returns:
    
    this builder instance
  - displayNameContains
```
public ListEntitiesRequest.Builder displayNameContains(String displayNameContains)
```
    A filter to return only resources that match display name pattern given. The match is not case sensitive. For Example : /folders?displayNameContains=Cu.* The above would match all folders with display name that starts with “Cu” or has the pattern “Cu” anywhere in between.
    
    Parameters:
    
    displayNameContains - the value to set
    
    Returns:
    
    this builder instance
  - lifecycleState
```
public ListEntitiesRequest.Builder lifecycleState(LifecycleState lifecycleState)
```
    A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
    
    Parameters:
    
    lifecycleState - the value to set
    
    Returns:
    
    this builder instance
  - timeCreated
```
public ListEntitiesRequest.Builder timeCreated(Date timeCreated)
```
    Time that the resource was created. An RFC3339 formatted datetime string.
    
    Parameters:
    
    timeCreated - the value to set
    
    Returns:
    
    this builder instance
  - timeUpdated
```
public ListEntitiesRequest.Builder timeUpdated(Date timeUpdated)
```
    Time that the resource was updated. An RFC3339 formatted datetime string.
    
    Parameters:
    
    timeUpdated - the value to set
    
    Returns:
    
    this builder instance
  - createdById
```
public ListEntitiesRequest.Builder createdById(String createdById)
```
    OCID of the user who created the resource.
    
    Parameters:
    
    createdById - the value to set
    
    Returns:
    
    this builder instance
  - updatedById
```
public ListEntitiesRequest.Builder updatedById(String updatedById)
```
    OCID of the user who updated the resource.
    
    Parameters:
    
    updatedById - the value to set
    
    Returns:
    
    this builder instance
  - externalKey
```
public ListEntitiesRequest.Builder externalKey(String externalKey)
```
    Unique external identifier of this resource in the external source system.
    
    Parameters:
    
    externalKey - the value to set
    
    Returns:
    
    this builder instance
  - patternKey
```
public ListEntitiesRequest.Builder patternKey(String patternKey)
```
    Unique pattern key.
    
    Parameters:
    
    patternKey - the value to set
    
    Returns:
    
    this builder instance
  - timeExternal
```
public ListEntitiesRequest.Builder timeExternal(Date timeExternal)
```
    Last modified timestamp of this object in the external system.
    
    Parameters:
    
    timeExternal - the value to set
    
    Returns:
    
    this builder instance
  - timeStatusUpdated
```
public ListEntitiesRequest.Builder timeStatusUpdated(Date timeStatusUpdated)
```
    Time that the resource’s status was last updated. An RFC3339 formatted datetime string.
    
    Parameters:
    
    timeStatusUpdated - the value to set
    
    Returns:
    
    this builder instance
  - isLogical
```
public ListEntitiesRequest.Builder isLogical(Boolean isLogical)
```
    Identifies if the object is a physical object (materialized) or virtual/logical object defined on other objects.
    
    Parameters:
    
    isLogical - the value to set
    
    Returns:
    
    this builder instance
  - isPartition
```
public ListEntitiesRequest.Builder isPartition(Boolean isPartition)
```
    Identifies if an object is a sub object (partition) of a physical or materialized parent object.
    
    Parameters:
    
    isPartition - the value to set
    
    Returns:
    
    this builder instance
  - folderKey
```
public ListEntitiesRequest.Builder folderKey(String folderKey)
```
    Key of the associated folder.
    
    Parameters:
    
    folderKey - the value to set
    
    Returns:
    
    this builder instance
  - path
```
public ListEntitiesRequest.Builder path(String path)
```
    Full path of the resource for resources that support paths.
    
    Parameters:
    
    path - the value to set
    
    Returns:
    
    this builder instance
  - harvestStatus
```
public ListEntitiesRequest.Builder harvestStatus(HarvestStatus harvestStatus)
```
    Harvest status of the harvestable resource as updated by the harvest process.
    
    Parameters:
    
    harvestStatus - the value to set
    
    Returns:
    
    this builder instance
  - lastJobKey
```
public ListEntitiesRequest.Builder lastJobKey(String lastJobKey)
```
    Key of the last harvest process to update this resource.
    
    Parameters:
    
    lastJobKey - the value to set
    
    Returns:
    
    this builder instance
  - fields
```
public ListEntitiesRequest.Builder fields(List<ListEntitiesRequest.Fields> fields)
```
    Specifies the fields to return in an entity summary response.
    
    Parameters:
    
    fields - the value to set
    
    Returns:
    
    this builder instance
  - fields
```
public ListEntitiesRequest.Builder fields(ListEntitiesRequest.Fields singularValue)
```
    Singular setter. Specifies the fields to return in an entity summary response.
    
    Parameters:
    
    singularValue - the singular value to set
    
    Returns:
    
    this builder instance
  - sortBy
```
public ListEntitiesRequest.Builder sortBy(ListEntitiesRequest.SortBy sortBy)
```
    The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.
    
    Parameters:
    
    sortBy - the value to set
    
    Returns:
    
    this builder instance
  - sortOrder
```
public ListEntitiesRequest.Builder sortOrder(ListEntitiesRequest.SortOrder sortOrder)
```
    The sort order to use, either ‘asc’ or ‘desc’.
    
    Parameters:
    
    sortOrder - the value to set
    
    Returns:
    
    this builder instance
  - limit
```
public ListEntitiesRequest.Builder limit(Integer limit)
```
    The maximum number of items to return.
    
    Parameters:
    
    limit - the value to set
    
    Returns:
    
    this builder instance
  - page
```
public ListEntitiesRequest.Builder page(String page)
```
    The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
    
    Parameters:
    
    page - the value to set
    
    Returns:
    
    this builder instance
  - opcRequestId
```
public ListEntitiesRequest.Builder opcRequestId(String opcRequestId)
```
    The client request ID for tracing.
    
    Parameters:
    
    opcRequestId - the value to set
    
    Returns:
    
    this builder instance
  - invocationCallback
```
public ListEntitiesRequest.Builder invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)
```
    Set the invocation callback for the request to be built.
    
    Parameters:
    
    invocationCallback - the invocation callback to be set for the request
    
    Returns:
    
    this builder instance
  - retryConfiguration
```
public ListEntitiesRequest.Builder retryConfiguration(RetryConfiguration retryConfiguration)
```
    Set the retry configuration for the request to be built.
    
    Parameters:
    
    retryConfiguration - the retry configuration to be used for the request
    
    Returns:
    
    this builder instance
  - copy
```
public ListEntitiesRequest.Builder copy(ListEntitiesRequest o)
```
    Copy method to populate the builder with values from the given instance.
    
    Specified by:
    
    copy in interface BmcRequest.Builder<ListEntitiesRequest,Void>
    
    Parameters:
    
    o - other request from which to copy values
    
    Returns:
    
    this builder instance
  - build
```
public ListEntitiesRequest build()
```
    Build the instance of ListEntitiesRequest as configured by this builder
    
    Note that this method takes calls to invocationCallback(com.oracle.bmc.http.client.RequestInterceptor) into account, while the method buildWithoutInvocationCallback() does not.
    This is the preferred method to build an instance.
    
    Specified by:
    
    build in interface BmcRequest.Builder<ListEntitiesRequest,Void>
    
    Returns:
    
    instance of ListEntitiesRequest
  - buildWithoutInvocationCallback
```
public ListEntitiesRequest buildWithoutInvocationCallback()
```
    Build the instance of ListEntitiesRequest as configured by this builder
    
    Note that this method does not take calls to invocationCallback(com.oracle.bmc.http.client.RequestInterceptor) into account, while the method build() does
    
    Returns:
    
    instance of ListEntitiesRequest

Class ListEntitiesRequest.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.oracle.bmc.requests.BmcRequest.Builder

Constructor Detail

Builder

Method Detail

catalogId

dataAssetKey

displayName

businessName

displayOrBusinessNameContains

typeKey

displayNameContains

lifecycleState

timeCreated

timeUpdated

createdById

updatedById

externalKey

patternKey

timeExternal

timeStatusUpdated

isLogical

isPartition

folderKey

path

harvestStatus

lastJobKey

fields

fields

sortBy

sortOrder

limit

page

opcRequestId

invocationCallback

retryConfiguration

copy

build

buildWithoutInvocationCallback