Class ListWorkspacesRequest
Implements
Inherited Members
Namespace: Oci.DataintegrationService.Requests
Assembly: OCI.DotNetSDK.Dataintegration.dll
Syntax
public class ListWorkspacesRequest : IOciRequest
Examples
Click here to see an example of how to use ListWorkspaces request.
Properties
CompartmentId
Declaration
[Required(ErrorMessage = "CompartmentId is required.")]
[HttpConverter(TargetEnum.Query, "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type | Description |
---|---|
string | The OCID of the compartment containing the resources you want to list. |
Remarks
Required
LifecycleState
Declaration
[HttpConverter(TargetEnum.Query, "lifecycleState")]
public Workspace.LifecycleStateEnum? LifecycleState { get; set; }
Property Value
Type | Description |
---|---|
Workspace.LifecycleStateEnum? | 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. |
Limit
Declaration
[HttpConverter(TargetEnum.Query, "limit")]
public int? Limit { get; set; }
Property Value
Type | Description |
---|---|
int? | Sets the maximum number of results per page, or items to return in a paginated |
Name
Declaration
[HttpConverter(TargetEnum.Query, "name")]
public string Name { get; set; }
Property Value
Type | Description |
---|---|
string | Used to filter by the name of the object. |
OpcRequestId
Declaration
[HttpConverter(TargetEnum.Header, "opc-request-id")]
public string OpcRequestId { get; set; }
Property Value
Type | Description |
---|---|
string | Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
Page
Declaration
[HttpConverter(TargetEnum.Query, "page")]
public string Page { get; set; }
Property Value
Type | Description |
---|---|
string | For list pagination. The value for this parameter is the |
SortBy
Declaration
[HttpConverter(TargetEnum.Query, "sortBy")]
public ListWorkspacesRequest.SortByEnum? SortBy { get; set; }
Property Value
Type | Description |
---|---|
ListWorkspacesRequest.SortByEnum? | 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 |
SortOrder
Declaration
[HttpConverter(TargetEnum.Query, "sortOrder")]
public ListWorkspacesRequest.SortOrderEnum? SortOrder { get; set; }
Property Value
Type | Description |
---|---|
ListWorkspacesRequest.SortOrderEnum? | Specifies sort order to use, either |