Package com.oracle.bmc.resourcemanager.requests

Class ListPrivateEndpointsRequest.Builder

java.lang.Object

com.oracle.bmc.resourcemanager.requests.ListPrivateEndpointsRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListPrivateEndpointsRequest,Void>

Enclosing class:

ListPrivateEndpointsRequest

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListPrivateEndpointsRequest	build()	Build the instance of ListPrivateEndpointsRequest as configured by this builder
ListPrivateEndpointsRequest	buildWithoutInvocationCallback()	Build the instance of ListPrivateEndpointsRequest as configured by this builder
ListPrivateEndpointsRequest.Builder	compartmentId(String compartmentId)	A filter to return only resources that exist in the compartment, identified by OCID.
ListPrivateEndpointsRequest.Builder	copy(ListPrivateEndpointsRequest o)	Copy method to populate the builder with values from the given instance.
ListPrivateEndpointsRequest.Builder	displayName(String displayName)	A filter to return only resources that match the given display name exactly.
ListPrivateEndpointsRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListPrivateEndpointsRequest.Builder	limit(Integer limit)	The number of items returned in a paginated List call.
ListPrivateEndpointsRequest.Builder	opcRequestId(String opcRequestId)	Unique Oracle-assigned identifier for the request.
ListPrivateEndpointsRequest.Builder	page(String page)	The value of the opc-next-page response header from the preceding List call.
ListPrivateEndpointsRequest.Builder	privateEndpointId(String privateEndpointId)	The OCID of the private endpoint.
ListPrivateEndpointsRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListPrivateEndpointsRequest.Builder	sortBy(ListPrivateEndpointsRequest.SortBy sortBy)	The field to use when sorting returned resources.
ListPrivateEndpointsRequest.Builder	sortOrder(ListPrivateEndpointsRequest.SortOrder sortOrder)	The sort order to use when sorting returned resources.
ListPrivateEndpointsRequest.Builder	vcnId(String vcnId)	The OCID of the VCN.

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

opcRequestId

public ListPrivateEndpointsRequest.Builder opcRequestId(String opcRequestId)

Unique Oracle-assigned 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

compartmentId

public ListPrivateEndpointsRequest.Builder compartmentId(String compartmentId)

A filter to return only resources that exist in the compartment, identified by OCID.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

privateEndpointId

public ListPrivateEndpointsRequest.Builder privateEndpointId(String privateEndpointId)

The OCID of the private endpoint.

Parameters:

privateEndpointId - the value to set

Returns:

this builder instance

displayName

public ListPrivateEndpointsRequest.Builder displayName(String displayName)

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

Use this filter to list a resource by name. Requires sortBy set to DISPLAYNAME. Alternatively, when you know the resource OCID, use the related Get operation.

Parameters:

displayName - the value to set

Returns:

this builder instance

vcnId

public ListPrivateEndpointsRequest.Builder vcnId(String vcnId)

The OCID of the VCN.

Parameters:

vcnId - the value to set

Returns:

this builder instance

sortBy

public ListPrivateEndpointsRequest.Builder sortBy(ListPrivateEndpointsRequest.SortBy sortBy)

The field to use when sorting returned resources.

By default, TIMECREATED is ordered descending. By default, DISPLAYNAME is ordered ascending. Note that you can sort only on one field.

Parameters:

sortBy - the value to set

Returns:

this builder instance

sortOrder

public ListPrivateEndpointsRequest.Builder sortOrder(ListPrivateEndpointsRequest.SortOrder sortOrder)

The sort order to use when sorting returned resources.

Ascending (ASC) or descending (DESC).

Parameters:

sortOrder - the value to set

Returns:

this builder instance

limit

public ListPrivateEndpointsRequest.Builder limit(Integer limit)

The number of items returned in a paginated List call.

For information about pagination, see List Pagination.

Parameters:

limit - the value to set

Returns:

this builder instance

page

public ListPrivateEndpointsRequest.Builder page(String page)

The value of the opc-next-page response header from the preceding List call.

For information about pagination, see List Pagination.

Parameters:

page - the value to set

Returns:

this builder instance

invocationCallback

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

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

Specified by:

copy in interface BmcRequest.Builder<ListPrivateEndpointsRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListPrivateEndpointsRequest build()

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

Returns:

instance of ListPrivateEndpointsRequest

buildWithoutInvocationCallback

public ListPrivateEndpointsRequest buildWithoutInvocationCallback()

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