com.oracle.bmc.datasafe.requests

Class ListSqlCollectionsRequest.Builder

java.lang.Object

com.oracle.bmc.datasafe.requests.ListSqlCollectionsRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListSqlCollectionsRequest,Void>

Enclosing class:

ListSqlCollectionsRequest

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

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
ListSqlCollectionsRequest.Builder	accessLevel(ListSqlCollectionsRequest.AccessLevel accessLevel) Valid values are RESTRICTED and ACCESSIBLE.
ListSqlCollectionsRequest	build() Build the instance of ListSqlCollectionsRequest as configured by this builder
ListSqlCollectionsRequest	buildWithoutInvocationCallback() Build the instance of ListSqlCollectionsRequest as configured by this builder
ListSqlCollectionsRequest.Builder	compartmentId(String compartmentId) A filter to return only resources that match the specified compartment OCID.
ListSqlCollectionsRequest.Builder	compartmentIdInSubtree(Boolean compartmentIdInSubtree) Default is false.
ListSqlCollectionsRequest.Builder	copy(ListSqlCollectionsRequest o) Copy method to populate the builder with values from the given instance.
ListSqlCollectionsRequest.Builder	dbUserName(String dbUserName) A filter to return only items that match the specified user name.
ListSqlCollectionsRequest.Builder	displayName(String displayName) A filter to return only resources that match the specified display name.
ListSqlCollectionsRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback) Set the invocation callback for the request to be built.
ListSqlCollectionsRequest.Builder	lifecycleState(SqlCollectionLifecycleState lifecycleState) The current state of the SQL collection.
ListSqlCollectionsRequest.Builder	limit(Integer limit) For list pagination.
ListSqlCollectionsRequest.Builder	opcRequestId(String opcRequestId) Unique identifier for the request.
ListSqlCollectionsRequest.Builder	page(String page) For list pagination.
ListSqlCollectionsRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration) Set the retry configuration for the request to be built.
ListSqlCollectionsRequest.Builder	sortBy(ListSqlCollectionsRequest.SortBy sortBy) The field used for sorting.
ListSqlCollectionsRequest.Builder	sortOrder(ListSqlCollectionsRequest.SortOrder sortOrder) The sort order to use, either ascending (ASC) or descending (DESC).
ListSqlCollectionsRequest.Builder	sqlCollectionId(String sqlCollectionId) An optional filter to return only resources that match the specified OCID of the SQL collection resource.
ListSqlCollectionsRequest.Builder	targetId(String targetId) A filter to return only items related to a specific target OCID.
ListSqlCollectionsRequest.Builder	timeCreatedGreaterThanOrEqualTo(Date timeCreatedGreaterThanOrEqualTo) A filter to return only the resources that were created after the specified date and time, as defined by RFC3339.
ListSqlCollectionsRequest.Builder	timeCreatedLessThan(Date timeCreatedLessThan) Search for resources that were created before a specific date.

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

compartmentId

public ListSqlCollectionsRequest.Builder compartmentId(String compartmentId)

A filter to return only resources that match the specified compartment OCID.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

compartmentIdInSubtree

public ListSqlCollectionsRequest.Builder compartmentIdInSubtree(Boolean compartmentIdInSubtree)

Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the ‘accessLevel’ setting.

Parameters:

compartmentIdInSubtree - the value to set

Returns:

this builder instance

accessLevel

public ListSqlCollectionsRequest.Builder accessLevel(ListSqlCollectionsRequest.AccessLevel accessLevel)

Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.

Parameters:

accessLevel - the value to set

Returns:

this builder instance

displayName

public ListSqlCollectionsRequest.Builder displayName(String displayName)

A filter to return only resources that match the specified display name.

Parameters:

displayName - the value to set

Returns:

this builder instance

limit

public ListSqlCollectionsRequest.Builder limit(Integer limit)

For list pagination. The maximum number of items to return per page in a paginated “List” call. For details about how pagination works, see List Pagination.

Parameters:

limit - the value to set

Returns:

this builder instance

page

public ListSqlCollectionsRequest.Builder page(String page)

For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous “List” call. For details about how pagination works, see List Pagination.

Parameters:

page - the value to set

Returns:

this builder instance

lifecycleState

public ListSqlCollectionsRequest.Builder lifecycleState(SqlCollectionLifecycleState lifecycleState)

The current state of the SQL collection.

Parameters:

lifecycleState - the value to set

Returns:

this builder instance

sqlCollectionId

public ListSqlCollectionsRequest.Builder sqlCollectionId(String sqlCollectionId)

An optional filter to return only resources that match the specified OCID of the SQL collection resource.

Parameters:

sqlCollectionId - the value to set

Returns:

this builder instance

timeCreatedGreaterThanOrEqualTo

public ListSqlCollectionsRequest.Builder timeCreatedGreaterThanOrEqualTo(Date timeCreatedGreaterThanOrEqualTo)

A filter to return only the resources that were created after the specified date and time, as defined by RFC3339. Using TimeCreatedGreaterThanOrEqualToQueryParam parameter retrieves all resources created after that date.

*Example:** 2016-12-19T16:39:57.600Z

Parameters:

timeCreatedGreaterThanOrEqualTo - the value to set

Returns:

this builder instance

timeCreatedLessThan

public ListSqlCollectionsRequest.Builder timeCreatedLessThan(Date timeCreatedLessThan)

Search for resources that were created before a specific date. Specifying this parameter corresponding timeCreatedLessThan parameter will retrieve all resources created before the specified created date, in “YYYY-MM-ddThh:mmZ” format with a Z offset, as defined by RFC 3339.

*Example:** 2016-12-19T16:39:57.600Z

Parameters:

timeCreatedLessThan - the value to set

Returns:

this builder instance

targetId

public ListSqlCollectionsRequest.Builder targetId(String targetId)

A filter to return only items related to a specific target OCID.

Parameters:

targetId - the value to set

Returns:

this builder instance

dbUserName

public ListSqlCollectionsRequest.Builder dbUserName(String dbUserName)

A filter to return only items that match the specified user name.

Parameters:

dbUserName - the value to set

Returns:

this builder instance

sortOrder

public ListSqlCollectionsRequest.Builder sortOrder(ListSqlCollectionsRequest.SortOrder sortOrder)

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

Parameters:

sortOrder - the value to set

Returns:

this builder instance

sortBy

public ListSqlCollectionsRequest.Builder sortBy(ListSqlCollectionsRequest.SortBy sortBy)

The field used for sorting. Only one sorting parameter order (sortOrder) can be specified. The DISPLAYNAME sort order is case sensitive.

Parameters:

sortBy - the value to set

Returns:

this builder instance

opcRequestId

public ListSqlCollectionsRequest.Builder opcRequestId(String opcRequestId)

Unique identifier for the request.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

invocationCallback

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

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

Specified by:

copy in interface BmcRequest.Builder<ListSqlCollectionsRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListSqlCollectionsRequest build()

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

Returns:

instance of ListSqlCollectionsRequest

buildWithoutInvocationCallback

public ListSqlCollectionsRequest buildWithoutInvocationCallback()

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