Package 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 <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/datascience/ListModelsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListModelsRequest.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ListModelsRequest.Builder
static class	ListModelsRequest.Category	Specifies the type of models to list.
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).

Constructor Summary

Constructors

Constructor	Description
ListModelsRequest()

Method Summary

Modifier and Type	Method	Description
static ListModelsRequest.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’.
ListModelsRequest.Category	getCategory()	Specifies the type of models to list.
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	getModelVersionSetName()	Filter results by the name of the model version set.
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).
String	getVersionLabel()	Filter results by version label.
int	hashCode()	Uses getInvocationCallback and getRetryConfiguration to generate a hash.
ListModelsRequest.Builder	toBuilder()	Return an instance of ListModelsRequest.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

ListModelsRequest

public ListModelsRequest()

Method Detail

getCompartmentId

public String getCompartmentId()

Filter results by the OCID of the compartment.

getModelVersionSetName

public String getModelVersionSetName()

Filter results by the name of the model version set.

getVersionLabel

public String getVersionLabel()

Filter results by version label.

getCategory

public ListModelsRequest.Category getCategory()

Specifies the type of models to list.

By default, user models are listed.

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, 100 is the maximum. See List Pagination.

Example: 50

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.oracle.com/iaas/Content/General/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, the results are shown in descending order. All other fields default to ascending order. Sort order for the 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, then provide the request ID.

toBuilder

public ListModelsRequest.Builder toBuilder()

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

Returns:

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

builder

public static ListModelsRequest.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>