public class ListEntitiesOptions
extends com.ibm.cloud.sdk.core.service.model.GenericModel
Modifier and Type | Class and Description |
---|---|
static class |
ListEntitiesOptions.Builder
Builder.
|
static interface |
ListEntitiesOptions.Sort
The attribute by which returned entities will be sorted.
|
Modifier and Type | Method and Description |
---|---|
String |
cursor()
Gets the cursor.
|
Boolean |
export()
Gets the export.
|
Boolean |
includeAudit()
Gets the includeAudit.
|
Boolean |
includeCount()
Gets the includeCount.
|
ListEntitiesOptions.Builder |
newBuilder()
New builder.
|
Long |
pageLimit()
Gets the pageLimit.
|
String |
sort()
Gets the sort.
|
String |
workspaceId()
Gets the workspaceId.
|
public ListEntitiesOptions.Builder newBuilder()
public String workspaceId()
Unique identifier of the workspace.
public Boolean export()
Whether to include all element content in the returned data. If **export**=`false`, the returned data includes only information about the element itself. If **export**=`true`, all content, including subelements, is included.
public Long pageLimit()
The number of records to return in each page of results.
public Boolean includeCount()
Whether to include information about the number of records that satisfy the request, regardless of the page limit. If this parameter is `true`, the `pagination` object in the response includes the `total` property.
public String sort()
The attribute by which returned entities will be sorted. To reverse the sort order, prefix the value with a minus sign (`-`).
public String cursor()
A token identifying the page of results to retrieve.
public Boolean includeAudit()
Whether to include the audit properties (`created` and `updated` timestamps) in the response.
Copyright © 2021 IBM Cloud. All rights reserved.