com.oracle.bmc.datasafe.requests

Class ListOnPremConnectorsRequest.Builder

java.lang.Object

com.oracle.bmc.datasafe.requests.ListOnPremConnectorsRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListOnPremConnectorsRequest,Void>

Enclosing class:

ListOnPremConnectorsRequest

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

Method Summary

Modifier and Type	Method and Description
ListOnPremConnectorsRequest.Builder	accessLevel(ListOnPremConnectorsRequest.AccessLevel accessLevel) Valid values are RESTRICTED and ACCESSIBLE.
ListOnPremConnectorsRequest	build() Build the instance of ListOnPremConnectorsRequest as configured by this builder
ListOnPremConnectorsRequest	buildWithoutInvocationCallback()
ListOnPremConnectorsRequest.Builder	compartmentId(String compartmentId) A filter to return only resources that match the specified compartment OCID.
ListOnPremConnectorsRequest.Builder	compartmentIdInSubtree(Boolean compartmentIdInSubtree) Default is false.
ListOnPremConnectorsRequest.Builder	copy(ListOnPremConnectorsRequest o) Copy method to populate the builder with values from the given instance.
ListOnPremConnectorsRequest.Builder	displayName(String displayName) A filter to return only resources that match the specified display name.
ListOnPremConnectorsRequest.Builder	invocationCallback(Consumer<javax.ws.rs.client.Invocation.Builder> invocationCallback) Set the invocation callback for the request to be built.
ListOnPremConnectorsRequest.Builder	limit(Integer limit) For list pagination.
ListOnPremConnectorsRequest.Builder	onPremConnectorId(String onPremConnectorId) A filter to return only the on-premises connector that matches the specified id.
ListOnPremConnectorsRequest.Builder	onPremConnectorLifecycleState(OnPremConnectorLifecycleState onPremConnectorLifecycleState) A filter to return only on-premises connector resources that match the specified lifecycle state.
ListOnPremConnectorsRequest.Builder	opcRequestId(String opcRequestId) Unique identifier for the request.
ListOnPremConnectorsRequest.Builder	page(String page) For list pagination.
ListOnPremConnectorsRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration) Set the retry configuration for the request to be built.
ListOnPremConnectorsRequest.Builder	sortBy(ListOnPremConnectorsRequest.SortBy sortBy) The field used for sorting.
ListOnPremConnectorsRequest.Builder	sortOrder(ListOnPremConnectorsRequest.SortOrder 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 ListOnPremConnectorsRequest.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 ListOnPremConnectorsRequest.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 ListOnPremConnectorsRequest.Builder copy(ListOnPremConnectorsRequest o)

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

Specified by:

copy in interface BmcRequest.Builder<ListOnPremConnectorsRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListOnPremConnectorsRequest build()

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

Returns:

instance of ListOnPremConnectorsRequest

compartmentId

public ListOnPremConnectorsRequest.Builder compartmentId(String compartmentId)

A filter to return only resources that match the specified compartment OCID.

Returns:

this.

onPremConnectorId

public ListOnPremConnectorsRequest.Builder onPremConnectorId(String onPremConnectorId)

A filter to return only the on-premises connector that matches the specified id.

Returns:

this.

displayName

public ListOnPremConnectorsRequest.Builder displayName(String displayName)

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

Returns:

this.

onPremConnectorLifecycleState

public ListOnPremConnectorsRequest.Builder onPremConnectorLifecycleState(OnPremConnectorLifecycleState onPremConnectorLifecycleState)

A filter to return only on-premises connector resources that match the specified lifecycle state.

Returns:

this.

limit

public ListOnPremConnectorsRequest.Builder limit(Integer limit)

For list pagination. The maximum number of items to return per page in a paginated “List” call. For details about how pagination works, see List Pagination.

Returns:

this.

page

public ListOnPremConnectorsRequest.Builder page(String page)

For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous “List” call. For details about how pagination works, see List Pagination.

Returns:

this.

sortOrder

public ListOnPremConnectorsRequest.Builder sortOrder(ListOnPremConnectorsRequest.SortOrder sortOrder)

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

Returns:

this.

sortBy

public ListOnPremConnectorsRequest.Builder sortBy(ListOnPremConnectorsRequest.SortBy sortBy)

The field used for sorting. Only one sorting order (sortOrder) can be specified. The default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

Returns:

this.

opcRequestId

public ListOnPremConnectorsRequest.Builder opcRequestId(String opcRequestId)

Unique identifier for the request.

Returns:

this.

compartmentIdInSubtree

public ListOnPremConnectorsRequest.Builder compartmentIdInSubtree(Boolean compartmentIdInSubtree)

Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the ‘accessLevel’ setting.

Returns:

this.

accessLevel

public ListOnPremConnectorsRequest.Builder accessLevel(ListOnPremConnectorsRequest.AccessLevel accessLevel)

Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.

Returns:

this.

buildWithoutInvocationCallback

public ListOnPremConnectorsRequest buildWithoutInvocationCallback()

toString

public String toString()

Overrides:

toString in class Object