Package com.oracle.bmc.optimizer.requests

Class ListProfilesRequest.Builder

java.lang.Object

com.oracle.bmc.optimizer.requests.ListProfilesRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListProfilesRequest,Void>

Enclosing class:

ListProfilesRequest

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListProfilesRequest	build()	Build the instance of ListProfilesRequest as configured by this builder
ListProfilesRequest	buildWithoutInvocationCallback()	Build the instance of ListProfilesRequest as configured by this builder
ListProfilesRequest.Builder	compartmentId(String compartmentId)	The OCID of the compartment.
ListProfilesRequest.Builder	copy(ListProfilesRequest o)	Copy method to populate the builder with values from the given instance.
ListProfilesRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListProfilesRequest.Builder	lifecycleState(LifecycleState lifecycleState)	A filter that returns results that match the lifecycle state specified.
ListProfilesRequest.Builder	limit(Integer limit)	The maximum number of items to return in a paginated “List” call.
ListProfilesRequest.Builder	name(String name)	Optional.
ListProfilesRequest.Builder	opcRequestId(String opcRequestId)	Unique Oracle-assigned identifier for the request.
ListProfilesRequest.Builder	page(String page)	The value of the opc-next-page response header from the previous “List” call.
ListProfilesRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListProfilesRequest.Builder	sortBy(ListProfilesRequest.SortBy sortBy)	The field to sort by.
ListProfilesRequest.Builder	sortOrder(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 ListProfilesRequest.Builder compartmentId(String compartmentId)

The OCID of the compartment.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

name

public ListProfilesRequest.Builder name(String name)

Optional.

A filter that returns results that match the name specified.

Parameters:

name - the value to set

Returns:

this builder instance

limit

public ListProfilesRequest.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

page

public ListProfilesRequest.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

sortOrder

public ListProfilesRequest.Builder sortOrder(SortOrder sortOrder)

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

Parameters:

sortOrder - the value to set

Returns:

this builder instance

sortBy

public ListProfilesRequest.Builder sortBy(ListProfilesRequest.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.

Parameters:

sortBy - the value to set

Returns:

this builder instance

lifecycleState

public ListProfilesRequest.Builder lifecycleState(LifecycleState lifecycleState)

A filter that returns results that match the lifecycle state specified.

Parameters:

lifecycleState - the value to set

Returns:

this builder instance

opcRequestId

public ListProfilesRequest.Builder opcRequestId(String opcRequestId)

Unique Oracle-assigned identifier for the request.

If you need to contact Oracle about a particular request, please provide the request ID.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

invocationCallback

public ListProfilesRequest.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 ListProfilesRequest.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 ListProfilesRequest.Builder copy(ListProfilesRequest o)

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

Specified by:

copy in interface BmcRequest.Builder<ListProfilesRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListProfilesRequest build()

Build the instance of ListProfilesRequest 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<ListProfilesRequest,Void>

Returns:

instance of ListProfilesRequest

buildWithoutInvocationCallback

public ListProfilesRequest buildWithoutInvocationCallback()

Build the instance of ListProfilesRequest 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 ListProfilesRequest