Class ListAttributesRequest
- 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 <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/datacatalog/ListAttributesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListAttributesRequest.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classListAttributesRequest.Builderstatic classListAttributesRequest.FieldsSpecifies the fields to return in an entity attribute summary response.static classListAttributesRequest.SortByThe field to sort by.static classListAttributesRequest.SortOrderThe sort order to use, either ‘asc’ or ‘desc’.
-
Constructor Summary
Constructors Constructor Description ListAttributesRequest()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ListAttributesRequest.Builderbuilder()Return a new builder for this request object.booleanequals(Object o)Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.StringgetBusinessName()A filter to return only resources that match the entire business name given.StringgetCatalogId()Unique catalog identifier.StringgetCreatedById()OCID of the user who created the resource.StringgetDataAssetKey()Unique data asset key.StringgetDisplayName()A filter to return only resources that match the entire display name given.StringgetDisplayNameContains()A filter to return only resources that match display name pattern given.StringgetDisplayOrBusinessNameContains()A filter to return only resources that match display name or business name pattern given.StringgetEntityKey()Unique entity key.StringgetExternalKey()Unique external identifier of this resource in the external source system.StringgetExternalTypeName()Data type as defined in an external system.List<ListAttributesRequest.Fields>getFields()Specifies the fields to return in an entity attribute summary response.BooleangetIsIncrementalData()Identifies whether this attribute can be used as a watermark to extract incremental data.BooleangetIsNullable()Identifies whether this attribute can be assigned null value.LonggetLength()Max allowed length of the attribute value.LifecycleStategetLifecycleState()A filter to return only resources that match the specified lifecycle state.IntegergetLimit()The maximum number of items to return.StringgetOpcRequestId()The client request ID for tracing.StringgetPage()The page token representing the page at which to start retrieving results.IntegergetPosition()Position of the attribute in the record definition.IntegergetPrecision()Precision of the attribute value usually applies to float data type.IntegergetScale()Scale of the attribute value usually applies to float data type.ListAttributesRequest.SortBygetSortBy()The field to sort by.ListAttributesRequest.SortOrdergetSortOrder()The sort order to use, either ‘asc’ or ‘desc’.DategetTimeCreated()Time that the resource was created.DategetTimeExternal()Last modified timestamp of this object in the external system.DategetTimeUpdated()Time that the resource was updated.StringgetUpdatedById()OCID of the user who updated the resource.inthashCode()Uses getInvocationCallback and getRetryConfiguration to generate a hash.ListAttributesRequest.BuildertoBuilder()Return an instance ofListAttributesRequest.Builderthat allows you to modify request properties.StringtoString()-
Methods inherited from class com.oracle.bmc.requests.BmcRequest
getBody$, getInvocationCallback, getRetryConfiguration, setInvocationCallback, setRetryConfiguration, supportsExpect100Continue
-
-
-
-
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 ofListAttributesRequest.Builderthat allows you to modify request properties.- Returns:
- instance of
ListAttributesRequest.Builderthat 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
-
equals
public boolean equals(Object o)
Description copied from class:BmcRequestUses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.- Overrides:
equalsin classBmcRequest<Void>
-
hashCode
public int hashCode()
Description copied from class:BmcRequestUses getInvocationCallback and getRetryConfiguration to generate a hash.- Overrides:
hashCodein classBmcRequest<Void>
-
-