Package com.oracle.bmc.core.requests

Class ListConsoleHistoriesRequest.Builder

java.lang.Object

com.oracle.bmc.core.requests.ListConsoleHistoriesRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListConsoleHistoriesRequest,Void>

Enclosing class:

ListConsoleHistoriesRequest

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListConsoleHistoriesRequest.Builder	availabilityDomain(String availabilityDomain)	The name of the availability domain.
ListConsoleHistoriesRequest	build()	Build the instance of ListConsoleHistoriesRequest as configured by this builder
ListConsoleHistoriesRequest	buildWithoutInvocationCallback()	Build the instance of ListConsoleHistoriesRequest as configured by this builder
ListConsoleHistoriesRequest.Builder	compartmentId(String compartmentId)	The OCID of the compartment.
ListConsoleHistoriesRequest.Builder	copy(ListConsoleHistoriesRequest o)	Copy method to populate the builder with values from the given instance.
ListConsoleHistoriesRequest.Builder	instanceId(String instanceId)	The OCID of the instance.
ListConsoleHistoriesRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListConsoleHistoriesRequest.Builder	lifecycleState(ConsoleHistory.LifecycleState lifecycleState)	A filter to only return resources that match the given lifecycle state.
ListConsoleHistoriesRequest.Builder	limit(Integer limit)	For list pagination.
ListConsoleHistoriesRequest.Builder	page(String page)	For list pagination.
ListConsoleHistoriesRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListConsoleHistoriesRequest.Builder	sortBy(ListConsoleHistoriesRequest.SortBy sortBy)	The field to sort by.
ListConsoleHistoriesRequest.Builder	sortOrder(ListConsoleHistoriesRequest.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 ListConsoleHistoriesRequest.Builder compartmentId(String compartmentId)

The OCID of the compartment.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

availabilityDomain

public ListConsoleHistoriesRequest.Builder availabilityDomain(String availabilityDomain)

The name of the availability domain.

Example: Uocm:PHX-AD-1

Parameters:

availabilityDomain - the value to set

Returns:

this builder instance

limit

public ListConsoleHistoriesRequest.Builder limit(Integer limit)

For list pagination.

The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination.

Example: 50

Parameters:

limit - the value to set

Returns:

this builder instance

page

public ListConsoleHistoriesRequest.Builder page(String page)

For list pagination.

The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination.

Parameters:

page - the value to set

Returns:

this builder instance

instanceId

public ListConsoleHistoriesRequest.Builder instanceId(String instanceId)

The OCID of the instance.

Parameters:

instanceId - the value to set

Returns:

this builder instance

sortBy

public ListConsoleHistoriesRequest.Builder sortBy(ListConsoleHistoriesRequest.SortBy sortBy)

The field to sort by.

You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME 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 ListConsoleHistoriesRequest.Builder sortOrder(ListConsoleHistoriesRequest.SortOrder sortOrder)

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

The DISPLAYNAME sort order is case sensitive.

Parameters:

sortOrder - the value to set

Returns:

this builder instance

lifecycleState

public ListConsoleHistoriesRequest.Builder lifecycleState(ConsoleHistory.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 ListConsoleHistoriesRequest.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 ListConsoleHistoriesRequest.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 ListConsoleHistoriesRequest.Builder copy(ListConsoleHistoriesRequest o)

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

Specified by:

copy in interface BmcRequest.Builder<ListConsoleHistoriesRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListConsoleHistoriesRequest build()

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

Returns:

instance of ListConsoleHistoriesRequest

buildWithoutInvocationCallback

public ListConsoleHistoriesRequest buildWithoutInvocationCallback()

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