/** * * * OpenAPI spec version: 20200430 * * * NOTE: This class is auto generated by OracleSDKGenerator. * Do not edit the class manually. * * Copyright (c) 2020, 2026, Oracle and/or its affiliates. All rights reserved. * This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. */ import common = require("oci-common"); /** * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/dataintegration/ListWorkspaces.ts.html |here} to see how to use ListWorkspacesRequest. */ export interface ListWorkspacesRequest extends common.BaseRequest { /** * The OCID of the compartment containing the resources you want to list. */ "compartmentId": string; /** * Used to filter by the name of the object. */ "name"?: string; /** * Sets the maximum number of results per page, or items to return in a paginated {@code List} call. See [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). */ "limit"?: number; /** * For list pagination. The value for this parameter is the {@code opc-next-page} or the {@code opc-prev-page} response header from the previous {@code List} call. See [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). */ "page"?: string; /** * The lifecycle state of a resource. When specified, the operation only returns resources that match the given lifecycle state. When not specified, all lifecycle states are processed as a match. */ "lifecycleState"?: string; /** * Specifies sort order to use, either {@code ASC} (ascending) or {@code DESC} (descending). */ "sortOrder"?: ListWorkspacesRequest.SortOrder; /** * 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 {@code query} is present (search operation and sorting order is by relevance score in descending order). */ "sortBy"?: ListWorkspacesRequest.SortBy; /** * Unique Oracle-assigned identifier for the request. If * you need to contact Oracle about a particular request, * please provide the request ID. * */ "opcRequestId"?: string; } export declare namespace ListWorkspacesRequest { enum SortOrder { Asc = "ASC", Desc = "DESC" } enum SortBy { TimeCreated = "TIME_CREATED", DisplayName = "DISPLAY_NAME", TimeUpdated = "TIME_UPDATED" } }