Package com.oracle.bmc.database.requests

Class ListGiHomesRequest.Builder

java.lang.Object

com.oracle.bmc.database.requests.ListGiHomesRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListGiHomesRequest,Void>

Enclosing class:

ListGiHomesRequest

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListGiHomesRequest	build()	Build the instance of ListGiHomesRequest as configured by this builder
ListGiHomesRequest	buildWithoutInvocationCallback()	Build the instance of ListGiHomesRequest as configured by this builder
ListGiHomesRequest.Builder	compartmentId(String compartmentId)	The compartment OCID.
ListGiHomesRequest.Builder	copy(ListGiHomesRequest o)	Copy method to populate the builder with values from the given instance.
ListGiHomesRequest.Builder	dbSystemId(String dbSystemId)	The DB system OCID.
ListGiHomesRequest.Builder	displayName(String displayName)	A filter to return only resources that match the entire display name given.
ListGiHomesRequest.Builder	giVersion(String giVersion)	The Grid Infrastructure version.
ListGiHomesRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListGiHomesRequest.Builder	lifecycleState(GiHomeSummary.LifecycleState lifecycleState)	A filter to return only resources that match the given lifecycle state exactly.
ListGiHomesRequest.Builder	limit(Integer limit)	The maximum number of items to return per page.
ListGiHomesRequest.Builder	opcRequestId(String opcRequestId)	Unique identifier for the request.
ListGiHomesRequest.Builder	page(String page)	The pagination token to continue listing from.
ListGiHomesRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListGiHomesRequest.Builder	sortBy(ListGiHomesRequest.SortBy sortBy)	The field to sort by.
ListGiHomesRequest.Builder	sortOrder(ListGiHomesRequest.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 ListGiHomesRequest.Builder compartmentId(String compartmentId)

The compartment OCID.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

dbSystemId

public ListGiHomesRequest.Builder dbSystemId(String dbSystemId)

The DB system OCID.

If provided, filters the results to the set of database versions which are supported for the DB system.

Parameters:

dbSystemId - the value to set

Returns:

this builder instance

giVersion

public ListGiHomesRequest.Builder giVersion(String giVersion)

The Grid Infrastructure version.

If provided, filters the results matching the provided grid infrastructure version.

Parameters:

giVersion - the value to set

Returns:

this builder instance

limit

public ListGiHomesRequest.Builder limit(Integer limit)

The maximum number of items to return per page.

Parameters:

limit - the value to set

Returns:

this builder instance

page

public ListGiHomesRequest.Builder page(String page)

The pagination token to continue listing from.

Parameters:

page - the value to set

Returns:

this builder instance

sortBy

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

Parameters:

sortBy - the value to set

Returns:

this builder instance

sortOrder

public ListGiHomesRequest.Builder sortOrder(ListGiHomesRequest.SortOrder sortOrder)

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

Parameters:

sortOrder - the value to set

Returns:

this builder instance

lifecycleState

public ListGiHomesRequest.Builder lifecycleState(GiHomeSummary.LifecycleState lifecycleState)

A filter to return only resources that match the given lifecycle state exactly.

Parameters:

lifecycleState - the value to set

Returns:

this builder instance

displayName

public ListGiHomesRequest.Builder displayName(String displayName)

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

The match is not case sensitive.

Parameters:

displayName - the value to set

Returns:

this builder instance

opcRequestId

public ListGiHomesRequest.Builder opcRequestId(String opcRequestId)

Unique identifier for the request.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

invocationCallback

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

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

Specified by:

copy in interface BmcRequest.Builder<ListGiHomesRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListGiHomesRequest build()

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

Returns:

instance of ListGiHomesRequest

buildWithoutInvocationCallback

public ListGiHomesRequest buildWithoutInvocationCallback()

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