com.oracle.bmc.dataconnectivity.requests

Class ListFoldersRequest

java.lang.Object

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

com.oracle.bmc.dataconnectivity.requests.ListFoldersRequest

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

Example: Click here to see how to use ListFoldersRequest.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListFoldersRequest.Builder
static class	ListFoldersRequest.FavoritesQueryParam If value is FAVORITES_ONLY, then only objects marked as favorite by the requesting user will be included in result.
static class	ListFoldersRequest.SortBy Specifies the field to sort by.
static class	ListFoldersRequest.SortOrder Specifies sort order to use, either ASC (ascending) or DESC (descending).

Constructor Summary

Constructors

Constructor and Description
ListFoldersRequest()

Method Summary

Modifier and Type	Method and Description
static ListFoldersRequest.Builder	builder() Return a new builder for this request object.
boolean	equals(Object o) Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.
ListFoldersRequest.FavoritesQueryParam	getFavoritesQueryParam() If value is FAVORITES_ONLY, then only objects marked as favorite by the requesting user will be included in result.
List<String>	getFields() Specifies the fields to get for an object.
Integer	getLimit() Sets the maximum number of results per page, or items to return in a paginated List call.
String	getName() Used to filter by the name of the object.
String	getOpcRequestId() Unique Oracle-assigned identifier for the request.
String	getPage() For list pagination.
String	getRegistryId() The registry OCID.
ListFoldersRequest.SortBy	getSortBy() Specifies the field to sort by.
ListFoldersRequest.SortOrder	getSortOrder() Specifies sort order to use, either ASC (ascending) or DESC (descending).
String	getType() Type of the object to filter the results with.
int	hashCode() Uses getInvocationCallback and getRetryConfiguration to generate a hash.
ListFoldersRequest.Builder	toBuilder() Return an instance of ListFoldersRequest.Builder that allows you to modify request properties.
String	toString()

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

getBody$, getInvocationCallback, getRetryConfiguration, setInvocationCallback, setRetryConfiguration, supportsExpect100Continue

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListFoldersRequest

public ListFoldersRequest()

Method Detail

getRegistryId

public String getRegistryId()

The registry OCID.

getName

public String getName()

Used to filter by the name of the object.

getPage

public String getPage()

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.

getLimit

public Integer getLimit()

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

getFields

public List<String> getFields()

Specifies the fields to get for an object.

getType

public String getType()

Type of the object to filter the results with.

getSortBy

public ListFoldersRequest.SortBy getSortBy()

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 are by relevance score in descending order).

getSortOrder

public ListFoldersRequest.SortOrder getSortOrder()

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

getOpcRequestId

public String getOpcRequestId()

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

getFavoritesQueryParam

public ListFoldersRequest.FavoritesQueryParam getFavoritesQueryParam()

If value is FAVORITES_ONLY, then only objects marked as favorite by the requesting user will be included in result. If value is NON_FAVORITES_ONLY, then objects marked as favorites by the requesting user will be skipped. If value is ALL or if not specified, all objects, irrespective of favorites or not will be returned. Default is ALL.

toBuilder

public ListFoldersRequest.Builder toBuilder()

Return an instance of ListFoldersRequest.Builder that allows you to modify request properties.

Returns:

instance of ListFoldersRequest.Builder that allows you to modify request properties.

builder

public static ListFoldersRequest.Builder builder()

Return a new builder for this request object.

Returns:

builder for the request object

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Description copied from class: BmcRequest

Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.

Overrides:

equals in class BmcRequest<Void>

hashCode

public int hashCode()

Description copied from class: BmcRequest

Uses getInvocationCallback and getRetryConfiguration to generate a hash.

Overrides:

hashCode in class BmcRequest<Void>