Package com.oracle.bmc.datacatalog.requests

Class ListTypesRequest.Builder

java.lang.Object

com.oracle.bmc.datacatalog.requests.ListTypesRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListTypesRequest,Void>

Enclosing class:

ListTypesRequest

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListTypesRequest	build()	Build the instance of ListTypesRequest as configured by this builder
ListTypesRequest	buildWithoutInvocationCallback()	Build the instance of ListTypesRequest as configured by this builder
ListTypesRequest.Builder	catalogId(String catalogId)	Unique catalog identifier.
ListTypesRequest.Builder	copy(ListTypesRequest o)	Copy method to populate the builder with values from the given instance.
ListTypesRequest.Builder	externalTypeName(String externalTypeName)	Data type as defined in an external system.
ListTypesRequest.Builder	fields(ListTypesRequest.Fields singularValue)	Singular setter.
ListTypesRequest.Builder	fields(List<ListTypesRequest.Fields> fields)	Specifies the fields to return in a type summary response.
ListTypesRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListTypesRequest.Builder	isApproved(String isApproved)	Indicates whether the type is approved for use as a classifying object.
ListTypesRequest.Builder	isInternal(String isInternal)	Indicates whether the type is internal, making it unavailable for use by metadata elements.
ListTypesRequest.Builder	isTag(String isTag)	Indicates whether the type can be used for tagging metadata elements.
ListTypesRequest.Builder	lifecycleState(LifecycleState lifecycleState)	A filter to return only resources that match the specified lifecycle state.
ListTypesRequest.Builder	limit(Integer limit)	The maximum number of items to return.
ListTypesRequest.Builder	name(String name)	Immutable resource name.
ListTypesRequest.Builder	opcRequestId(String opcRequestId)	The client request ID for tracing.
ListTypesRequest.Builder	page(String page)	The page token representing the page at which to start retrieving results.
ListTypesRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListTypesRequest.Builder	sortBy(ListTypesRequest.SortBy sortBy)	The field to sort by.
ListTypesRequest.Builder	sortOrder(ListTypesRequest.SortOrder sortOrder)	The sort order to use, either ‘asc’ or ‘desc’.
ListTypesRequest.Builder	typeCategory(String typeCategory)	Indicates the category of this type .

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 ListTypesRequest.Builder catalogId(String catalogId)

Unique catalog identifier.

Parameters:

catalogId - the value to set

Returns:

this builder instance

name

public ListTypesRequest.Builder name(String name)

Immutable resource name.

Parameters:

name - the value to set

Returns:

this builder instance

lifecycleState

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

isInternal

public ListTypesRequest.Builder isInternal(String isInternal)

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

Parameters:

isInternal - the value to set

Returns:

this builder instance

isTag

public ListTypesRequest.Builder isTag(String isTag)

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

Parameters:

isTag - the value to set

Returns:

this builder instance

isApproved

public ListTypesRequest.Builder isApproved(String isApproved)

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

Parameters:

isApproved - the value to set

Returns:

this builder instance

externalTypeName

public ListTypesRequest.Builder externalTypeName(String externalTypeName)

Data type as defined in an external system.

Parameters:

externalTypeName - the value to set

Returns:

this builder instance

typeCategory

public ListTypesRequest.Builder typeCategory(String typeCategory)

Indicates the category of this type .

For example, data assets or connections.

Parameters:

typeCategory - the value to set

Returns:

this builder instance

fields

public ListTypesRequest.Builder fields(List<ListTypesRequest.Fields> fields)

Specifies the fields to return in a type summary response.

Parameters:

fields - the value to set

Returns:

this builder instance

fields

public ListTypesRequest.Builder fields(ListTypesRequest.Fields singularValue)

Singular setter.

Specifies the fields to return in a type summary response.

Parameters:

singularValue - the singular value to set

Returns:

this builder instance

sortBy

public ListTypesRequest.Builder sortBy(ListTypesRequest.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 ListTypesRequest.Builder sortOrder(ListTypesRequest.SortOrder sortOrder)

The sort order to use, either ‘asc’ or ‘desc’.

Parameters:

sortOrder - the value to set

Returns:

this builder instance

limit

public ListTypesRequest.Builder limit(Integer limit)

The maximum number of items to return.

Parameters:

limit - the value to set

Returns:

this builder instance

page

public ListTypesRequest.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 ListTypesRequest.Builder opcRequestId(String opcRequestId)

The client request ID for tracing.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

invocationCallback

public ListTypesRequest.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 ListTypesRequest.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 ListTypesRequest.Builder copy(ListTypesRequest o)

Copy method to populate the builder with values from the given instance.

Specified by:

copy in interface BmcRequest.Builder<ListTypesRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListTypesRequest build()

Build the instance of ListTypesRequest 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<ListTypesRequest,Void>

Returns:

instance of ListTypesRequest

buildWithoutInvocationCallback

public ListTypesRequest buildWithoutInvocationCallback()

Build the instance of ListTypesRequest 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 ListTypesRequest