com.oracle.bmc.dataintegration.requests

Class ListWorkspacesRequest

java.lang.Object

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

com.oracle.bmc.dataintegration.requests.ListWorkspacesRequest

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

Example: Click here to see how to use ListWorkspacesRequest.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
ListWorkspacesRequest()

Method Summary

Modifier and Type	Method and Description
static ListWorkspacesRequest.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 OCID of the compartment containing the resources you want to list.
Workspace.LifecycleState	getLifecycleState() The lifecycle state of a resource.
Integer	getLimit() Sets the maximum number of results per page, or items to return in a paginated List call.
String	getName() Used to filter by the name of the object.
String	getOpcRequestId() Unique Oracle-assigned identifier for the request.
String	getPage() For list pagination.
ListWorkspacesRequest.SortBy	getSortBy() Specifies the field to sort by.
ListWorkspacesRequest.SortOrder	getSortOrder() Specifies sort order to use, either ASC (ascending) or DESC (descending).
int	hashCode() Uses getInvocationCallback and getRetryConfiguration to generate a hash.
ListWorkspacesRequest.Builder	toBuilder() Return an instance of ListWorkspacesRequest.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

ListWorkspacesRequest

public ListWorkspacesRequest()

Method Detail

getCompartmentId

public String getCompartmentId()

The OCID of the compartment containing the resources you want to list.

getName

public String getName()

Used to filter by the name of the object.

getLimit

public Integer getLimit()

Sets the maximum number of results per page, or items to return in a paginated List call. See List Pagination.

getPage

public String getPage()

For list pagination. The value for this parameter is the opc-next-page or the opc-prev-page response header from the previous List call. See List Pagination.

getLifecycleState

public Workspace.LifecycleState getLifecycleState()

The lifecycle state of a resource. When specified, the operation only returns resources that match the given lifecycle state. When not specified, all lifecycle states are processed as a match.

getSortOrder

public ListWorkspacesRequest.SortOrder getSortOrder()

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

getSortBy

public ListWorkspacesRequest.SortBy getSortBy()

Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter query is present (search operation and sorting order is by relevance score in descending order).

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.

toBuilder

public ListWorkspacesRequest.Builder toBuilder()

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

Returns:

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

builder

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