Package com.oracle.bmc.core.requests

Class ListVtapsRequest.Builder

java.lang.Object

com.oracle.bmc.core.requests.ListVtapsRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListVtapsRequest,Void>

Enclosing class:

ListVtapsRequest

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListVtapsRequest	build()	Build the instance of ListVtapsRequest as configured by this builder
ListVtapsRequest	buildWithoutInvocationCallback()	Build the instance of ListVtapsRequest as configured by this builder
ListVtapsRequest.Builder	compartmentId(String compartmentId)	The OCID of the compartment.
ListVtapsRequest.Builder	copy(ListVtapsRequest o)	Copy method to populate the builder with values from the given instance.
ListVtapsRequest.Builder	displayName(String displayName)	A filter to return only resources that match the given display name exactly.
ListVtapsRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListVtapsRequest.Builder	isVtapEnabled(Boolean isVtapEnabled)	Indicates whether to list all VTAPs or only running VTAPs.
ListVtapsRequest.Builder	lifecycleState(Vtap.LifecycleState lifecycleState)	A filter to return only resources that match the given VTAP administrative lifecycle state.
ListVtapsRequest.Builder	limit(Integer limit)	For list pagination.
ListVtapsRequest.Builder	opcRequestId(String opcRequestId)	Unique identifier for the request.
ListVtapsRequest.Builder	page(String page)	For list pagination.
ListVtapsRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListVtapsRequest.Builder	sortBy(ListVtapsRequest.SortBy sortBy)	The field to sort by.
ListVtapsRequest.Builder	sortOrder(ListVtapsRequest.SortOrder sortOrder)	The sort order to use, either ascending (ASC) or descending (DESC).
ListVtapsRequest.Builder	source(String source)	The OCID of the VTAP source.
ListVtapsRequest.Builder	targetId(String targetId)	The OCID of the VTAP target.
ListVtapsRequest.Builder	targetIp(String targetIp)	The IP address of the VTAP target.
ListVtapsRequest.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

compartmentId

public ListVtapsRequest.Builder compartmentId(String compartmentId)

The OCID of the compartment.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

vcnId

public ListVtapsRequest.Builder vcnId(String vcnId)

The OCID of the VCN.

Parameters:

vcnId - the value to set

Returns:

this builder instance

source

public ListVtapsRequest.Builder source(String source)

The OCID of the VTAP source.

Parameters:

source - the value to set

Returns:

this builder instance

targetId

public ListVtapsRequest.Builder targetId(String targetId)

The OCID of the VTAP target.

Parameters:

targetId - the value to set

Returns:

this builder instance

targetIp

public ListVtapsRequest.Builder targetIp(String targetIp)

The IP address of the VTAP target.

Parameters:

targetIp - the value to set

Returns:

this builder instance

isVtapEnabled

public ListVtapsRequest.Builder isVtapEnabled(Boolean isVtapEnabled)

Indicates whether to list all VTAPs or only running VTAPs.

When FALSE, lists ALL running and stopped VTAPs. * When TRUE, lists only running VTAPs (VTAPs where isVtapEnabled = TRUE).

Parameters:

isVtapEnabled - the value to set

Returns:

this builder instance

limit

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

displayName

public ListVtapsRequest.Builder displayName(String displayName)

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

Parameters:

displayName - the value to set

Returns:

this builder instance

lifecycleState

public ListVtapsRequest.Builder lifecycleState(Vtap.LifecycleState lifecycleState)

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

The state value is case-insensitive.

Parameters:

lifecycleState - the value to set

Returns:

this builder instance

invocationCallback

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

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

Specified by:

copy in interface BmcRequest.Builder<ListVtapsRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListVtapsRequest build()

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

Returns:

instance of ListVtapsRequest

buildWithoutInvocationCallback

public ListVtapsRequest buildWithoutInvocationCallback()

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