com.oracle.bmc.datascience.requests

Class ListModelsRequest

java.lang.Object

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

com.oracle.bmc.datascience.requests.ListModelsRequest

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

Example: Click here to see how to use ListModelsRequest.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListModelsRequest.Builder
static class	ListModelsRequest.SortBy Specifies the field to sort by.
static class	ListModelsRequest.SortOrder Specifies sort order to use, either ASC (ascending) or DESC (descending).

Method Summary

Modifier and Type	Method and Description
static ListModelsRequest.Builder	builder()
String	getCompartmentId() Filter results by the OCID of the compartment.
String	getCreatedBy() Filter results by the OCID of the user who created the resource.
String	getDisplayName() Filter results by its user-friendly name.
String	getId() Filter results by OCID.
ModelLifecycleState	getLifecycleState() Filter results by the specified lifecycle state.
Integer	getLimit() For list pagination.
String	getOpcRequestId() Unique Oracle-assigned identifier for the request.
String	getPage() For list pagination.
String	getProjectId() Filter results by the OCID of the project.
ListModelsRequest.SortBy	getSortBy() Specifies the field to sort by.
ListModelsRequest.SortOrder	getSortOrder() Specifies sort order to use, either ASC (ascending) or DESC (descending).

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

getBody$, getInvocationCallback, getRetryConfiguration, setInvocationCallback, setRetryConfiguration

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static ListModelsRequest.Builder builder()

getCompartmentId

public String getCompartmentId()

Filter results by the OCID of the compartment.

getId

public String getId()

Filter results by OCID. Must be an OCID of the correct type for the resource type.

getProjectId

public String getProjectId()

Filter results by the OCID of the project.

getDisplayName

public String getDisplayName()

Filter results by its user-friendly name.

getLifecycleState

public ModelLifecycleState getLifecycleState()

Filter results by the specified lifecycle state. Must be a valid state for the resource type.

getCreatedBy

public String getCreatedBy()

Filter results by the OCID of the user who created the resource.

getLimit

public Integer getLimit()

For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. 1 is the minimum, 1000 is the maximum. See List Pagination.

Example: `500`

getPage

public String getPage()

For list pagination. The value of the opc-next-page response header from the previous "List" call.

See [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).

getSortOrder

public ListModelsRequest.SortOrder getSortOrder()

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

getSortBy

public ListModelsRequest.SortBy getSortBy()

Specifies the field to sort by. Accepts only one field. By default, when you sort by timeCreated, results are shown in descending order. All other fields default to ascending order. Sort order for displayName field is case sensitive.

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.