com.oracle.bmc.datacatalog.requests

Class ListTypesRequest

java.lang.Object

com.oracle.bmc.requests.BmcRequest<Void>

com.oracle.bmc.datacatalog.requests.ListTypesRequest

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

Example: Click here to see how to use ListTypesRequest.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListTypesRequest.Builder
static class	ListTypesRequest.Fields Specifies the fields to return in a type summary response.
static class	ListTypesRequest.SortBy The field to sort by.
static class	ListTypesRequest.SortOrder The sort order to use, either ‘asc’ or ‘desc’.

Method Summary

Modifier and Type	Method and Description
static ListTypesRequest.Builder	builder()
String	getCatalogId() Unique catalog identifier.
String	getExternalTypeName() Data type as defined in an external system.
List<ListTypesRequest.Fields>	getFields() Specifies the fields to return in a type summary response.
String	getIsApproved() Indicates whether the type is approved for use as a classifying object.
String	getIsInternal() Indicates whether the type is internal, making it unavailable for use by metadata elements.
String	getIsTag() Indicates whether the type can be used for tagging metadata elements.
LifecycleState	getLifecycleState() A filter to return only resources that match the specified lifecycle state.
Integer	getLimit() The maximum number of items to return.
String	getName() Immutable resource name.
String	getOpcRequestId() The client request ID for tracing.
String	getPage() The page token representing the page at which to start retrieving results.
ListTypesRequest.SortBy	getSortBy() The field to sort by.
ListTypesRequest.SortOrder	getSortOrder() The sort order to use, either ‘asc’ or ‘desc’.
String	getTypeCategory() Indicates the category of this type .

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

getBody$, getInvocationCallback, getRetryConfiguration, setInvocationCallback, setRetryConfiguration

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static ListTypesRequest.Builder builder()

getCatalogId

public String getCatalogId()

Unique catalog identifier.

getName

public String getName()

Immutable resource name.

getLifecycleState

public LifecycleState getLifecycleState()

A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

getIsInternal

public String getIsInternal()

Indicates whether the type is internal, making it unavailable for use by metadata elements.

getIsTag

public String getIsTag()

Indicates whether the type can be used for tagging metadata elements.

getIsApproved

public String getIsApproved()

Indicates whether the type is approved for use as a classifying object.

getExternalTypeName

public String getExternalTypeName()

Data type as defined in an external system.

getTypeCategory

public String getTypeCategory()

Indicates the category of this type . For example, data assets or connections.

getFields

public List<ListTypesRequest.Fields> getFields()

Specifies the fields to return in a type summary response.

getSortBy

public ListTypesRequest.SortBy getSortBy()

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.

getSortOrder

public ListTypesRequest.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.