com.oracle.bmc.bastion.requests

Class ListSessionsRequest.Builder

java.lang.Object

com.oracle.bmc.bastion.requests.ListSessionsRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListSessionsRequest,Void>

Enclosing class:

ListSessionsRequest

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

Method Summary

Modifier and Type	Method and Description
ListSessionsRequest.Builder	bastionId(String bastionId) The unique identifier (OCID) of the bastion in which to list sessions.
ListSessionsRequest	build() Build the instance of ListSessionsRequest as configured by this builder
ListSessionsRequest	buildWithoutInvocationCallback()
ListSessionsRequest.Builder	copy(ListSessionsRequest o) Copy method to populate the builder with values from the given instance.
ListSessionsRequest.Builder	displayName(String displayName) A filter to return only resources that match the entire display name given.
ListSessionsRequest.Builder	invocationCallback(Consumer<javax.ws.rs.client.Invocation.Builder> invocationCallback) Set the invocation callback for the request to be built.
ListSessionsRequest.Builder	limit(Integer limit) The maximum number of items to return.
ListSessionsRequest.Builder	opcRequestId(String opcRequestId) The client request ID for tracing.
ListSessionsRequest.Builder	page(String page) The page token representing the page at which to start retrieving results.
ListSessionsRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration) Set the retry configuration for the request to be built.
ListSessionsRequest.Builder	sessionId(String sessionId) The unique identifier (OCID) of the session in which to list resources.
ListSessionsRequest.Builder	sessionLifecycleState(SessionLifecycleState sessionLifecycleState) A filter to return only resources their lifecycleState matches the given lifecycleState.
ListSessionsRequest.Builder	sortBy(ListSessionsRequest.SortBy sortBy) The field to sort by.
ListSessionsRequest.Builder	sortOrder(SortOrder sortOrder) The sort order to use, either ‘asc’ or ‘desc’.
String	toString()

Methods inherited from class java.lang.Object

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

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

body$

Method Detail

invocationCallback

public ListSessionsRequest.Builder invocationCallback(Consumer<javax.ws.rs.client.Invocation.Builder> 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 ListSessionsRequest.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 ListSessionsRequest.Builder copy(ListSessionsRequest o)

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

Specified by:

copy in interface BmcRequest.Builder<ListSessionsRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListSessionsRequest build()

Build the instance of ListSessionsRequest as configured by this builder

Note that this method takes calls to invocationCallback(com.oracle.bmc.util.internal.Consumer) into account, while the method buildWithoutInvocationCallback() does not.

This is the preferred method to build an instance.

Specified by:

build in interface BmcRequest.Builder<ListSessionsRequest,Void>

Returns:

instance of ListSessionsRequest

bastionId

public ListSessionsRequest.Builder bastionId(String bastionId)

The unique identifier (OCID) of the bastion in which to list sessions.

Returns:

this.

opcRequestId

public ListSessionsRequest.Builder opcRequestId(String opcRequestId)

The client request ID for tracing.

Returns:

this.

displayName

public ListSessionsRequest.Builder displayName(String displayName)

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

Returns:

this.

sessionLifecycleState

public ListSessionsRequest.Builder sessionLifecycleState(SessionLifecycleState sessionLifecycleState)

A filter to return only resources their lifecycleState matches the given lifecycleState.

Returns:

this.

sessionId

public ListSessionsRequest.Builder sessionId(String sessionId)

The unique identifier (OCID) of the session in which to list resources.

Returns:

this.

limit

public ListSessionsRequest.Builder limit(Integer limit)

The maximum number of items to return.

Returns:

this.

page

public ListSessionsRequest.Builder page(String page)

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

Returns:

this.

sortOrder

public ListSessionsRequest.Builder sortOrder(SortOrder sortOrder)

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

Returns:

this.

sortBy

public ListSessionsRequest.Builder sortBy(ListSessionsRequest.SortBy sortBy)

The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.

Returns:

this.

buildWithoutInvocationCallback

public ListSessionsRequest buildWithoutInvocationCallback()

toString

public String toString()

Overrides:

toString in class Object