com.oracle.bmc.ailanguage.requests

Class ListProjectsRequest

java.lang.Object

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

com.oracle.bmc.ailanguage.requests.ListProjectsRequest

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

Example: Click here to see how to use ListProjectsRequest.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListProjectsRequest.Builder
static class	ListProjectsRequest.SortBy Specifies the field to sort by.

Constructor Summary

Constructors

Constructor and Description
ListProjectsRequest()

Method Summary

Modifier and Type	Method and 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() The ID of the compartment in which to list resources.
String	getDisplayName() A filter to return only resources that match the entire display name given.
Project.LifecycleState	getLifecycleState() Filter results by the specified lifecycle state.
Integer	getLimit() The maximum number of items to return.
String	getOpcRequestId() The client request ID for tracing.
String	getPage() The page token representing the page at which to start retrieving results.
String	getProjectId() The ID of the project for which to list the objects.
ListProjectsRequest.SortBy	getSortBy() Specifies the field to sort by.
SortOrder	getSortOrder() The sort order to use, either ‘asc’ or ‘desc’.
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()

The ID of the compartment in which to list resources.

getLifecycleState

public Project.LifecycleState getLifecycleState()

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

getDisplayName

public String getDisplayName()

A filter to return only resources that match the entire display name given.

getLimit

public Integer getLimit()

The maximum number of items to return.

getPage

public String getPage()

The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

getProjectId

public String getProjectId()

The ID of the project for which to list the objects.

getSortOrder

public SortOrder getSortOrder()

The sort order to use, either ‘asc’ or ‘desc’.

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()

The client request ID for tracing.

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>