ListEntitiesRequest (Oracle Cloud Infrastructure Java SDK

java.lang.Object
- com.oracle.bmc.requests.BmcRequest<Void>
- - com.oracle.bmc.datacatalog.requests.ListEntitiesRequest

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20190325")
public class ListEntitiesRequest
extends BmcRequest<Void>

Example: Click here to see how to use ListEntitiesRequest.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ListEntitiesRequest.Builder`
`static class`	`ListEntitiesRequest.Fields` Specifies the fields to return in an entity summary response.
`static class`	`ListEntitiesRequest.SortBy` The field to sort by.
`static class`	`ListEntitiesRequest.SortOrder` The sort order to use, either ‘asc’ or ‘desc’.

Constructor Summary

Constructors
Constructor and Description

ListEntitiesRequest()

Constructors
Constructor and Description
`ListEntitiesRequest()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ListEntitiesRequest.Builder`	`builder()` Return a new builder for this request object.
`boolean`	`equals(Object o)` Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.
`String`	`getBusinessName()` A filter to return only resources that match the entire business name given.
`String`	`getCatalogId()` Unique catalog identifier.
`String`	`getCreatedById()` OCID of the user who created the resource.
`String`	`getDataAssetKey()` Unique data asset key.
`String`	`getDisplayName()` A filter to return only resources that match the entire display name given.
`String`	`getDisplayNameContains()` A filter to return only resources that match display name pattern given.
`String`	`getDisplayOrBusinessNameContains()` A filter to return only resources that match display name or business name pattern given.
`String`	`getExternalKey()` Unique external identifier of this resource in the external source system.
`List<ListEntitiesRequest.Fields>`	`getFields()` Specifies the fields to return in an entity summary response.
`String`	`getFolderKey()` Key of the associated folder.
`HarvestStatus`	`getHarvestStatus()` Harvest status of the harvestable resource as updated by the harvest process.
`Boolean`	`getIsLogical()` Identifies if the object is a physical object (materialized) or virtual/logical object defined on other objects.
`Boolean`	`getIsPartition()` Identifies if an object is a sub object (partition) of a physical or materialized parent object.
`Boolean`	`getIsProcess()` A filter to return only process entities.
`String`	`getLastJobKey()` Key of the last harvest process to update this resource.
`LifecycleState`	`getLifecycleState()` A filter to return only resources that match the specified lifecycle state.
`Integer`	`getLimit()` The maximum number of items to return.
`String`	`getOpcRequestId()` The client request ID for tracing.
`String`	`getPage()` The page token representing the page at which to start retrieving results.
`String`	`getPath()` Full path of the resource for resources that support paths.
`String`	`getPatternKey()` Unique pattern key.
`ListEntitiesRequest.SortBy`	`getSortBy()` The field to sort by.
`ListEntitiesRequest.SortOrder`	`getSortOrder()` The sort order to use, either ‘asc’ or ‘desc’.
`Date`	`getTimeCreated()` Time that the resource was created.
`Date`	`getTimeExternal()` Last modified timestamp of this object in the external system.
`Date`	`getTimeStatusUpdated()` Time that the resource’s status was last updated.
`Date`	`getTimeUpdated()` Time that the resource was updated.
`String`	`getTypeKey()` The key of the object type.
`String`	`getUpdatedById()` OCID of the user who updated the resource.
`int`	`hashCode()` Uses getInvocationCallback and getRetryConfiguration to generate a hash.
`ListEntitiesRequest.Builder`	`toBuilder()` Return an instance of `ListEntitiesRequest.Builder` that allows you to modify request properties.
`String`	`toString()`

Methods inherited from class com.oracle.bmc.requests.BmcRequest
getBody$, getInvocationCallback, getRetryConfiguration, setInvocationCallback, setRetryConfiguration, supportsExpect100Continue

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ListEntitiesRequest
```
public ListEntitiesRequest()
```
- Method Detail
  - getCatalogId
```
public String getCatalogId()
```
    Unique catalog identifier.
  - getDataAssetKey
```
public String getDataAssetKey()
```
    Unique data asset key.
  - getDisplayName
```
public String getDisplayName()
```
    A filter to return only resources that match the entire display name given. The match is not case sensitive.
  - getBusinessName
```
public String getBusinessName()
```
    A filter to return only resources that match the entire business name given. The match is not case sensitive.
  - getDisplayOrBusinessNameContains
```
public String getDisplayOrBusinessNameContains()
```
    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.
  - getTypeKey
```
public String getTypeKey()
```
    The key of the object type.
  - getDisplayNameContains
```
public String getDisplayNameContains()
```
    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.
  - getLifecycleState
```
public LifecycleState getLifecycleState()
```
    A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
  - getTimeCreated
```
public Date getTimeCreated()
```
    Time that the resource was created. An RFC3339 formatted datetime string.
  - getTimeUpdated
```
public Date getTimeUpdated()
```
    Time that the resource was updated. An RFC3339 formatted datetime string.
  - getCreatedById
```
public String getCreatedById()
```
    OCID of the user who created the resource.
  - getUpdatedById
```
public String getUpdatedById()
```
    OCID of the user who updated the resource.
  - getExternalKey
```
public String getExternalKey()
```
    Unique external identifier of this resource in the external source system.
  - getPatternKey
```
public String getPatternKey()
```
    Unique pattern key.
  - getTimeExternal
```
public Date getTimeExternal()
```
    Last modified timestamp of this object in the external system.
  - getTimeStatusUpdated
```
public Date getTimeStatusUpdated()
```
    Time that the resource’s status was last updated. An RFC3339 formatted datetime string.
  - getIsLogical
```
public Boolean getIsLogical()
```
    Identifies if the object is a physical object (materialized) or virtual/logical object defined on other objects.
  - getIsPartition
```
public Boolean getIsPartition()
```
    Identifies if an object is a sub object (partition) of a physical or materialized parent object.
  - getFolderKey
```
public String getFolderKey()
```
    Key of the associated folder.
  - getPath
```
public String getPath()
```
    Full path of the resource for resources that support paths.
  - getHarvestStatus
```
public HarvestStatus getHarvestStatus()
```
    Harvest status of the harvestable resource as updated by the harvest process.
  - getLastJobKey
```
public String getLastJobKey()
```
    Key of the last harvest process to update this resource.
  - getFields
```
public List<ListEntitiesRequest.Fields> getFields()
```
    Specifies the fields to return in an entity summary response.
  - getSortBy
```
public ListEntitiesRequest.SortBy getSortBy()
```
    The field to sort by. Only one sort order may be provided. DISPLAYORBUSINESSNAME considers businessName of a given object if set, else its displayName is used. Default sort order for TIMECREATED is descending and default sort order for DISPLAYNAME and DISPLAYORBUSINESSNAME is ascending. If no order is specified, TIMECREATED is the default.
  - getSortOrder
```
public ListEntitiesRequest.SortOrder getSortOrder()
```
    The sort order to use, either ‘asc’ or ‘desc’.
  - getLimit
```
public Integer getLimit()
```
    The maximum number of items to return.
  - getPage
```
public String getPage()
```
    The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  - getOpcRequestId
```
public String getOpcRequestId()
```
    The client request ID for tracing.
  - getIsProcess
```
public Boolean getIsProcess()
```
    A filter to return only process entities.
  - toBuilder
```
public ListEntitiesRequest.Builder toBuilder()
```
    Return an instance of ListEntitiesRequest.Builder that allows you to modify request properties.
    
    Returns:
    
    instance of ListEntitiesRequest.Builder that allows you to modify request properties.
  - builder
```
public static ListEntitiesRequest.Builder builder()
```
    Return a new builder for this request object.
    
    Returns:
    
    builder for the request object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object o)
```
    Description copied from class: BmcRequest
    
    Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.
    
    Overrides:
    
    equals in class BmcRequest<Void>
  - hashCode
```
public int hashCode()
```
    Description copied from class: BmcRequest
    
    Uses getInvocationCallback and getRetryConfiguration to generate a hash.
    
    Overrides:
    
    hashCode in class BmcRequest<Void>

Class ListEntitiesRequest

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class com.oracle.bmc.requests.BmcRequest

Methods inherited from class java.lang.Object

Constructor Detail

ListEntitiesRequest

Method Detail

getCatalogId

getDataAssetKey

getDisplayName

getBusinessName

getDisplayOrBusinessNameContains

getTypeKey

getDisplayNameContains

getLifecycleState

getTimeCreated

getTimeUpdated

getCreatedById

getUpdatedById

getExternalKey

getPatternKey

getTimeExternal

getTimeStatusUpdated

getIsLogical

getIsPartition

getFolderKey

getPath

getHarvestStatus

getLastJobKey

getFields

getSortBy

getSortOrder

getLimit

getPage

getOpcRequestId

getIsProcess

toBuilder

builder

toString

equals

hashCode