com.oracle.bmc.oce.requests

Class ListOceInstancesRequest.Builder

java.lang.Object

com.oracle.bmc.oce.requests.ListOceInstancesRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListOceInstancesRequest,Void>

Enclosing class:

ListOceInstancesRequest

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

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
ListOceInstancesRequest	build() Build the instance of ListOceInstancesRequest as configured by this builder
ListOceInstancesRequest	buildWithoutInvocationCallback() Build the instance of ListOceInstancesRequest as configured by this builder
ListOceInstancesRequest.Builder	compartmentId(String compartmentId) The ID of the compartment in which to list resources.
ListOceInstancesRequest.Builder	copy(ListOceInstancesRequest o) Copy method to populate the builder with values from the given instance.
ListOceInstancesRequest.Builder	displayName(String displayName) A user-friendly name.
ListOceInstancesRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback) Set the invocation callback for the request to be built.
ListOceInstancesRequest.Builder	lifecycleState(LifecycleState lifecycleState) Filter results on lifecycleState.
ListOceInstancesRequest.Builder	limit(Integer limit) The maximum number of items to return.
ListOceInstancesRequest.Builder	opcRequestId(String opcRequestId) The client request ID for tracing.
ListOceInstancesRequest.Builder	page(String page) The page token representing the page at which to start retrieving results.
ListOceInstancesRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration) Set the retry configuration for the request to be built.
ListOceInstancesRequest.Builder	sortBy(ListOceInstancesRequest.SortBy sortBy) The field to sort by.
ListOceInstancesRequest.Builder	sortOrder(ListOceInstancesRequest.SortOrder sortOrder) The sort order to use, either ‘asc’ or ‘desc’.
ListOceInstancesRequest.Builder	tenancyId(String tenancyId) The ID of the tenancy in which to list resources.

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 ListOceInstancesRequest.Builder compartmentId(String compartmentId)

The ID of the compartment in which to list resources.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

tenancyId

public ListOceInstancesRequest.Builder tenancyId(String tenancyId)

The ID of the tenancy in which to list resources.

Parameters:

tenancyId - the value to set

Returns:

this builder instance

displayName

public ListOceInstancesRequest.Builder displayName(String displayName)

A user-friendly name. Does not have to be unique, and it’s changeable.

Example: My new resource

Parameters:

displayName - the value to set

Returns:

this builder instance

limit

public ListOceInstancesRequest.Builder limit(Integer limit)

The maximum number of items to return.

Parameters:

limit - the value to set

Returns:

this builder instance

page

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

Parameters:

page - the value to set

Returns:

this builder instance

sortOrder

public ListOceInstancesRequest.Builder sortOrder(ListOceInstancesRequest.SortOrder sortOrder)

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

Parameters:

sortOrder - the value to set

Returns:

this builder instance

sortBy

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

Parameters:

sortBy - the value to set

Returns:

this builder instance

lifecycleState

public ListOceInstancesRequest.Builder lifecycleState(LifecycleState lifecycleState)

Filter results on lifecycleState.

Parameters:

lifecycleState - the value to set

Returns:

this builder instance

opcRequestId

public ListOceInstancesRequest.Builder opcRequestId(String opcRequestId)

The client request ID for tracing.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

invocationCallback

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

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

Specified by:

copy in interface BmcRequest.Builder<ListOceInstancesRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListOceInstancesRequest build()

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

Returns:

instance of ListOceInstancesRequest

buildWithoutInvocationCallback

public ListOceInstancesRequest buildWithoutInvocationCallback()

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