Package com.oracle.bmc.identity.requests

Class ListGroupsRequest.Builder

java.lang.Object

com.oracle.bmc.identity.requests.ListGroupsRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListGroupsRequest,Void>

Enclosing class:

ListGroupsRequest

public static class ListGroupsRequest.Builder
extends Object
implements BmcRequest.Builder<ListGroupsRequest,Void>

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListGroupsRequest	build()	Build the instance of ListGroupsRequest as configured by this builder
ListGroupsRequest	buildWithoutInvocationCallback()	Build the instance of ListGroupsRequest as configured by this builder
ListGroupsRequest.Builder	compartmentId(String compartmentId)	The OCID of the compartment (remember that the tenancy is simply the root compartment).
ListGroupsRequest.Builder	copy(ListGroupsRequest o)	Copy method to populate the builder with values from the given instance.
ListGroupsRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListGroupsRequest.Builder	lifecycleState(Group.LifecycleState lifecycleState)	A filter to only return resources that match the given lifecycle state.
ListGroupsRequest.Builder	limit(Integer limit)	The maximum number of items to return in a paginated “List” call.
ListGroupsRequest.Builder	name(String name)	A filter to only return resources that match the given name exactly.
ListGroupsRequest.Builder	page(String page)	The value of the opc-next-page response header from the previous “List” call.
ListGroupsRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListGroupsRequest.Builder	sortBy(ListGroupsRequest.SortBy sortBy)	The field to sort by.
ListGroupsRequest.Builder	sortOrder(ListGroupsRequest.SortOrder sortOrder)	The sort order to use, either ascending (ASC) or descending (DESC).

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.oracle.bmc.requests.BmcRequest.Builder

body$

Constructor Detail

Builder

public Builder()

Method Detail

compartmentId

public ListGroupsRequest.Builder compartmentId(String compartmentId)

The OCID of the compartment (remember that the tenancy is simply the root compartment).

Parameters:

compartmentId - the value to set

Returns:

this builder instance

page

public ListGroupsRequest.Builder page(String page)

The value of the opc-next-page response header from the previous “List” call.

Parameters:

page - the value to set

Returns:

this builder instance

limit

public ListGroupsRequest.Builder limit(Integer limit)

The maximum number of items to return in a paginated “List” call.

Parameters:

limit - the value to set

Returns:

this builder instance

name

public ListGroupsRequest.Builder name(String name)

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

Parameters:

name - the value to set

Returns:

this builder instance

sortBy

public ListGroupsRequest.Builder sortBy(ListGroupsRequest.SortBy sortBy)

The field to sort by.

You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for NAME is ascending. The NAME sort order is case sensitive.

*Note:** In general, some "List" operations (for example, ListInstances) let you optionally filter by Availability Domain if the scope of the resource type is within a single Availability Domain. If you call one of these "List" operations without specifying an Availability Domain, the resources are grouped by Availability Domain, then sorted.

Parameters:

sortBy - the value to set

Returns:

this builder instance

sortOrder

public ListGroupsRequest.Builder sortOrder(ListGroupsRequest.SortOrder sortOrder)

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

The NAME sort order is case sensitive.

Parameters:

sortOrder - the value to set

Returns:

this builder instance

lifecycleState

public ListGroupsRequest.Builder lifecycleState(Group.LifecycleState lifecycleState)

A filter to only return resources that match the given lifecycle state.

The state value is case-insensitive.

Parameters:

lifecycleState - the value to set

Returns:

this builder instance

invocationCallback

public ListGroupsRequest.Builder invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)

Set the invocation callback for the request to be built.

Parameters:

invocationCallback - the invocation callback to be set for the request

Returns:

this builder instance

retryConfiguration

public ListGroupsRequest.Builder retryConfiguration(RetryConfiguration retryConfiguration)

Set the retry configuration for the request to be built.

Parameters:

retryConfiguration - the retry configuration to be used for the request

Returns:

this builder instance

copy

public ListGroupsRequest.Builder copy(ListGroupsRequest o)

Copy method to populate the builder with values from the given instance.

Specified by:

copy in interface BmcRequest.Builder<ListGroupsRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListGroupsRequest build()

Build the instance of ListGroupsRequest as configured by this builder

Note that this method takes calls to invocationCallback(com.oracle.bmc.http.client.RequestInterceptor) into account, while the method buildWithoutInvocationCallback() does not.

This is the preferred method to build an instance.

Specified by:

build in interface BmcRequest.Builder<ListGroupsRequest,Void>

Returns:

instance of ListGroupsRequest

buildWithoutInvocationCallback

public ListGroupsRequest buildWithoutInvocationCallback()

Build the instance of ListGroupsRequest as configured by this builder

Note that this method does not take calls to invocationCallback(com.oracle.bmc.http.client.RequestInterceptor) into account, while the method build() does

Returns:

instance of ListGroupsRequest