com.oracle.bmc.ocvp.requests

Class ListSddcsRequest.Builder

java.lang.Object

com.oracle.bmc.ocvp.requests.ListSddcsRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListSddcsRequest,Void>

Enclosing class:

ListSddcsRequest

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

Method Summary

Modifier and Type	Method and Description
ListSddcsRequest	build() Build the instance of ListSddcsRequest as configured by this builder
ListSddcsRequest	buildWithoutInvocationCallback()
ListSddcsRequest.Builder	compartmentId(String compartmentId) The OCID of the compartment.
ListSddcsRequest.Builder	computeAvailabilityDomain(String computeAvailabilityDomain) The name of the availability domain that the Compute instances are running in.
ListSddcsRequest.Builder	copy(ListSddcsRequest o) Copy method to populate the builder with values from the given instance.
ListSddcsRequest.Builder	displayName(String displayName) A filter to return only resources that match the given display name exactly.
ListSddcsRequest.Builder	invocationCallback(Consumer<javax.ws.rs.client.Invocation.Builder> invocationCallback) Set the invocation callback for the request to be built.
ListSddcsRequest.Builder	lifecycleState(LifecycleStates lifecycleState) The lifecycle state of the resource.
ListSddcsRequest.Builder	limit(Integer limit) For list pagination.
ListSddcsRequest.Builder	opcRequestId(String opcRequestId) Unique identifier for the request.
ListSddcsRequest.Builder	page(String page) For list pagination.
ListSddcsRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration) Set the retry configuration for the request to be built.
ListSddcsRequest.Builder	sortBy(ListSddcsRequest.SortBy sortBy) The field to sort by.
ListSddcsRequest.Builder	sortOrder(SortOrders sortOrder) The sort order to use, either ascending (ASC) or descending (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 ListSddcsRequest.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 ListSddcsRequest.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 ListSddcsRequest.Builder copy(ListSddcsRequest o)

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

Specified by:

copy in interface BmcRequest.Builder<ListSddcsRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListSddcsRequest build()

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

Returns:

instance of ListSddcsRequest

compartmentId

public ListSddcsRequest.Builder compartmentId(String compartmentId)

The OCID of the compartment.

Returns:

this.

computeAvailabilityDomain

public ListSddcsRequest.Builder computeAvailabilityDomain(String computeAvailabilityDomain)

The name of the availability domain that the Compute instances are running in.

Example: Uocm:PHX-AD-1

Returns:

this.

displayName

public ListSddcsRequest.Builder displayName(String displayName)

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

Returns:

this.

limit

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

Returns:

this.

page

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

Returns:

this.

sortOrder

public ListSddcsRequest.Builder sortOrder(SortOrders sortOrder)

The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive.

Returns:

this.

sortBy

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

Returns:

this.

opcRequestId

public ListSddcsRequest.Builder opcRequestId(String opcRequestId)

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

Returns:

this.

lifecycleState

public ListSddcsRequest.Builder lifecycleState(LifecycleStates lifecycleState)

The lifecycle state of the resource.

Returns:

this.

buildWithoutInvocationCallback

public ListSddcsRequest buildWithoutInvocationCallback()

toString

public String toString()

Overrides:

toString in class Object