com.oracle.bmc.core.requests

Class ListInstanceDevicesRequest.Builder

java.lang.Object

com.oracle.bmc.core.requests.ListInstanceDevicesRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListInstanceDevicesRequest,Void>

Enclosing class:

ListInstanceDevicesRequest

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

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
ListInstanceDevicesRequest	build() Build the instance of ListInstanceDevicesRequest as configured by this builder
ListInstanceDevicesRequest	buildWithoutInvocationCallback() Build the instance of ListInstanceDevicesRequest as configured by this builder
ListInstanceDevicesRequest.Builder	copy(ListInstanceDevicesRequest o) Copy method to populate the builder with values from the given instance.
ListInstanceDevicesRequest.Builder	instanceId(String instanceId) The OCID of the instance.
ListInstanceDevicesRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback) Set the invocation callback for the request to be built.
ListInstanceDevicesRequest.Builder	isAvailable(Boolean isAvailable) A filter to return only available devices or only used devices.
ListInstanceDevicesRequest.Builder	limit(Integer limit) For list pagination.
ListInstanceDevicesRequest.Builder	name(String name) A filter to return only devices that match the given name exactly.
ListInstanceDevicesRequest.Builder	opcRequestId(String opcRequestId) Unique identifier for the request.
ListInstanceDevicesRequest.Builder	page(String page) For list pagination.
ListInstanceDevicesRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration) Set the retry configuration for the request to be built.
ListInstanceDevicesRequest.Builder	sortBy(ListInstanceDevicesRequest.SortBy sortBy) The field to sort by.
ListInstanceDevicesRequest.Builder	sortOrder(ListInstanceDevicesRequest.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

instanceId

public ListInstanceDevicesRequest.Builder instanceId(String instanceId)

The OCID of the instance.

Parameters:

instanceId - the value to set

Returns:

this builder instance

isAvailable

public ListInstanceDevicesRequest.Builder isAvailable(Boolean isAvailable)

A filter to return only available devices or only used devices.

Parameters:

isAvailable - the value to set

Returns:

this builder instance

name

public ListInstanceDevicesRequest.Builder name(String name)

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

Parameters:

name - the value to set

Returns:

this builder instance

limit

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

opcRequestId

public ListInstanceDevicesRequest.Builder opcRequestId(String opcRequestId)

Unique 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

sortBy

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

invocationCallback

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

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

Specified by:

copy in interface BmcRequest.Builder<ListInstanceDevicesRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListInstanceDevicesRequest build()

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

Returns:

instance of ListInstanceDevicesRequest

buildWithoutInvocationCallback

public ListInstanceDevicesRequest buildWithoutInvocationCallback()

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