ListAttributesRequest (Oracle Cloud Infrastructure Java SDK

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

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

Example: Click here to see how to use ListAttributesRequest.

Nested Class Summary

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

Constructor Summary

Constructors
Constructor and Description

ListAttributesRequest()

Constructors
Constructor and Description
`ListAttributesRequest()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ListAttributesRequest.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`	`getEntityKey()` Unique entity key.
`String`	`getExternalKey()` Unique external identifier of this resource in the external source system.
`String`	`getExternalTypeName()` Data type as defined in an external system.
`List<ListAttributesRequest.Fields>`	`getFields()` Specifies the fields to return in an entity attribute summary response.
`Boolean`	`getIsIncrementalData()` Identifies whether this attribute can be used as a watermark to extract incremental data.
`Boolean`	`getIsNullable()` Identifies whether this attribute can be assigned null value.
`Long`	`getLength()` Max allowed length of the attribute value.
`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.
`Integer`	`getPosition()` Position of the attribute in the record definition.
`Integer`	`getPrecision()` Precision of the attribute value usually applies to float data type.
`Integer`	`getScale()` Scale of the attribute value usually applies to float data type.
`ListAttributesRequest.SortBy`	`getSortBy()` The field to sort by.
`ListAttributesRequest.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`	`getTimeUpdated()` Time that the resource was updated.
`String`	`getUpdatedById()` OCID of the user who updated the resource.
`int`	`hashCode()` Uses getInvocationCallback and getRetryConfiguration to generate a hash.
`ListAttributesRequest.Builder`	`toBuilder()` Return an instance of `ListAttributesRequest.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
  - ListAttributesRequest
```
public ListAttributesRequest()
```
- Method Detail
  - getCatalogId
```
public String getCatalogId()
```
    Unique catalog identifier.
  - getDataAssetKey
```
public String getDataAssetKey()
```
    Unique data asset key.
  - getEntityKey
```
public String getEntityKey()
```
    Unique entity 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.
  - 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.
  - getTimeExternal
```
public Date getTimeExternal()
```
    Last modified timestamp of this object in the external system.
  - getExternalTypeName
```
public String getExternalTypeName()
```
    Data type as defined in an external system.
  - getIsIncrementalData
```
public Boolean getIsIncrementalData()
```
    Identifies whether this attribute can be used as a watermark to extract incremental data.
  - getIsNullable
```
public Boolean getIsNullable()
```
    Identifies whether this attribute can be assigned null value.
  - getLength
```
public Long getLength()
```
    Max allowed length of the attribute value.
  - getPosition
```
public Integer getPosition()
```
    Position of the attribute in the record definition.
  - getPrecision
```
public Integer getPrecision()
```
    Precision of the attribute value usually applies to float data type.
  - getScale
```
public Integer getScale()
```
    Scale of the attribute value usually applies to float data type.
  - getFields
```
public List<ListAttributesRequest.Fields> getFields()
```
    Specifies the fields to return in an entity attribute summary response.
  - getSortBy
```
public ListAttributesRequest.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, POSITION and DISPLAYORBUSINESSNAME is ascending. If no order is specified, POSITION is the default.
  - getSortOrder
```
public ListAttributesRequest.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.
  - toBuilder
```
public ListAttributesRequest.Builder toBuilder()
```
    Return an instance of ListAttributesRequest.Builder that allows you to modify request properties.
    
    Returns:
    
    instance of ListAttributesRequest.Builder that allows you to modify request properties.
  - builder
```
public static ListAttributesRequest.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 ListAttributesRequest

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

ListAttributesRequest

Method Detail

getCatalogId

getDataAssetKey

getEntityKey

getDisplayName

getBusinessName

getDisplayOrBusinessNameContains

getDisplayNameContains

getLifecycleState

getTimeCreated

getTimeUpdated

getCreatedById

getUpdatedById

getExternalKey

getTimeExternal

getExternalTypeName

getIsIncrementalData

getIsNullable

getLength

getPosition

getPrecision

getScale

getFields

getSortBy

getSortOrder

getLimit

getPage

getOpcRequestId

toBuilder

builder

toString

equals

hashCode