com.oracle.bmc.dataintegration.requests

Class ListDataEntitiesRequest.Builder

java.lang.Object

com.oracle.bmc.dataintegration.requests.ListDataEntitiesRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListDataEntitiesRequest,Void>

Enclosing class:

ListDataEntitiesRequest

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

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
ListDataEntitiesRequest	build() Build the instance of ListDataEntitiesRequest as configured by this builder
ListDataEntitiesRequest	buildWithoutInvocationCallback() Build the instance of ListDataEntitiesRequest as configured by this builder
ListDataEntitiesRequest.Builder	connectionKey(String connectionKey) The connection key.
ListDataEntitiesRequest.Builder	copy(ListDataEntitiesRequest o) Copy method to populate the builder with values from the given instance.
ListDataEntitiesRequest.Builder	fields(List<String> fields) Specifies the fields to get for an object.
ListDataEntitiesRequest.Builder	fields(String singularValue) Singular setter.
ListDataEntitiesRequest.Builder	includeTypes(List<String> includeTypes) Artifact type which needs to be listed while listing Artifacts.
ListDataEntitiesRequest.Builder	includeTypes(String singularValue) Singular setter.
ListDataEntitiesRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback) Set the invocation callback for the request to be built.
ListDataEntitiesRequest.Builder	isPattern(Boolean isPattern) This parameter can be used to specify whether entity search type is pattern search or not.
ListDataEntitiesRequest.Builder	limit(Integer limit) Sets the maximum number of results per page, or items to return in a paginated List call.
ListDataEntitiesRequest.Builder	name(String name) Used to filter by the name of the object.
ListDataEntitiesRequest.Builder	nameList(List<String> nameList) Used to filter by the name of the object.
ListDataEntitiesRequest.Builder	nameList(String singularValue) Singular setter.
ListDataEntitiesRequest.Builder	opcRequestId(String opcRequestId) Unique Oracle-assigned identifier for the request.
ListDataEntitiesRequest.Builder	page(String page) For list pagination.
ListDataEntitiesRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration) Set the retry configuration for the request to be built.
ListDataEntitiesRequest.Builder	schemaResourceName(String schemaResourceName) The schema resource name used for retrieving schemas.
ListDataEntitiesRequest.Builder	sortBy(ListDataEntitiesRequest.SortBy sortBy) Specifies the field to sort by.
ListDataEntitiesRequest.Builder	sortOrder(ListDataEntitiesRequest.SortOrder sortOrder) Specifies sort order to use, either ASC (ascending) or DESC (descending).
ListDataEntitiesRequest.Builder	type(String type) Type of the object to filter the results with.
ListDataEntitiesRequest.Builder	workspaceId(String workspaceId) The workspace ID.

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

workspaceId

public ListDataEntitiesRequest.Builder workspaceId(String workspaceId)

The workspace ID.

Parameters:

workspaceId - the value to set

Returns:

this builder instance

connectionKey

public ListDataEntitiesRequest.Builder connectionKey(String connectionKey)

The connection key.

Parameters:

connectionKey - the value to set

Returns:

this builder instance

schemaResourceName

public ListDataEntitiesRequest.Builder schemaResourceName(String schemaResourceName)

The schema resource name used for retrieving schemas.

Parameters:

schemaResourceName - the value to set

Returns:

this builder instance

name

public ListDataEntitiesRequest.Builder name(String name)

Used to filter by the name of the object.

Parameters:

name - the value to set

Returns:

this builder instance

page

public ListDataEntitiesRequest.Builder page(String page)

For list pagination. The value for this parameter is the opc-next-page or the opc-prev-page response header from the previous List call. See List Pagination.

Parameters:

page - the value to set

Returns:

this builder instance

type

public ListDataEntitiesRequest.Builder type(String type)

Type of the object to filter the results with.

Parameters:

type - the value to set

Returns:

this builder instance

limit

public ListDataEntitiesRequest.Builder limit(Integer limit)

Sets the maximum number of results per page, or items to return in a paginated List call. See List Pagination.

Parameters:

limit - the value to set

Returns:

this builder instance

fields

public ListDataEntitiesRequest.Builder fields(List<String> fields)

Specifies the fields to get for an object.

Parameters:

fields - the value to set

Returns:

this builder instance

fields

public ListDataEntitiesRequest.Builder fields(String singularValue)

Singular setter. Specifies the fields to get for an object.

Parameters:

singularValue - the singular value to set

Returns:

this builder instance

sortBy

public ListDataEntitiesRequest.Builder sortBy(ListDataEntitiesRequest.SortBy sortBy)

Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter query is present (search operation and sorting order is by relevance score in descending order).

Parameters:

sortBy - the value to set

Returns:

this builder instance

sortOrder

public ListDataEntitiesRequest.Builder sortOrder(ListDataEntitiesRequest.SortOrder sortOrder)

Specifies sort order to use, either ASC (ascending) or DESC (descending).

Parameters:

sortOrder - the value to set

Returns:

this builder instance

opcRequestId

public ListDataEntitiesRequest.Builder opcRequestId(String opcRequestId)

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

nameList

public ListDataEntitiesRequest.Builder nameList(List<String> nameList)

Used to filter by the name of the object.

Parameters:

nameList - the value to set

Returns:

this builder instance

nameList

public ListDataEntitiesRequest.Builder nameList(String singularValue)

Singular setter. Used to filter by the name of the object.

Parameters:

singularValue - the singular value to set

Returns:

this builder instance

isPattern

public ListDataEntitiesRequest.Builder isPattern(Boolean isPattern)

This parameter can be used to specify whether entity search type is pattern search or not.

Parameters:

isPattern - the value to set

Returns:

this builder instance

includeTypes

public ListDataEntitiesRequest.Builder includeTypes(List<String> includeTypes)

Artifact type which needs to be listed while listing Artifacts.

Parameters:

includeTypes - the value to set

Returns:

this builder instance

includeTypes

public ListDataEntitiesRequest.Builder includeTypes(String singularValue)

Singular setter. Artifact type which needs to be listed while listing Artifacts.

Parameters:

singularValue - the singular value to set

Returns:

this builder instance

invocationCallback

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

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

Specified by:

copy in interface BmcRequest.Builder<ListDataEntitiesRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListDataEntitiesRequest build()

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

Returns:

instance of ListDataEntitiesRequest

buildWithoutInvocationCallback

public ListDataEntitiesRequest buildWithoutInvocationCallback()

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