Package com.oracle.bmc.datascience.requests

Class ListProjectsRequest

java.lang.Object

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

com.oracle.bmc.datascience.requests.ListProjectsRequest

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

Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/datascience/ListProjectsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListProjectsRequest.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
ListProjectsRequest()

Method Summary

Modifier and Type	Method	Description
static ListProjectsRequest.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’.
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.
ProjectLifecycleState	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.
ListProjectsRequest.SortBy	getSortBy()	Specifies the field to sort by.
ListProjectsRequest.SortOrder	getSortOrder()	Specifies sort order to use, either ASC (ascending) or DESC (descending).
int	hashCode()	Uses getInvocationCallback and getRetryConfiguration to generate a hash.
ListProjectsRequest.Builder	toBuilder()	Return an instance of ListProjectsRequest.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

ListProjectsRequest

public ListProjectsRequest()

Method Detail

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.

getDisplayName

public String getDisplayName()

Filter results by its user-friendly name.

getLifecycleState

public ProjectLifecycleState 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 ListProjectsRequest.SortOrder getSortOrder()

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

getSortBy

public ListProjectsRequest.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. When you sort by displayName, the results are shown in 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 ListProjectsRequest.Builder toBuilder()

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

Returns:

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

builder

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