Package com.oracle.bmc.core.requests

Class ListVtapsRequest

java.lang.Object

com.oracle.bmc.requests.BmcRequest<Void>

com.oracle.bmc.core.requests.ListVtapsRequest

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20160918")
public class ListVtapsRequest
extends BmcRequest<Void>

Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.1/core/ListVtapsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListVtapsRequest.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ListVtapsRequest.Builder
static class	ListVtapsRequest.SortBy	The field to sort by.
static class	ListVtapsRequest.SortOrder	The sort order to use, either ascending (ASC) or descending (DESC).

Constructor Summary

Constructors

Constructor	Description
ListVtapsRequest()

Method Summary

Modifier and Type	Method	Description
static ListVtapsRequest.Builder	builder()	Return a new builder for this request object.
boolean	equals(Object o)	Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.
String	getCompartmentId()	The OCID of the compartment.
String	getDisplayName()	A filter to return only resources that match the given display name exactly.
Boolean	getIsVtapEnabled()	Indicates whether to list all VTAPs or only running VTAPs.
Vtap.LifecycleState	getLifecycleState()	A filter to return only resources that match the given VTAP administrative lifecycle state.
Integer	getLimit()	For list pagination.
String	getOpcRequestId()	Unique identifier for the request.
String	getPage()	For list pagination.
ListVtapsRequest.SortBy	getSortBy()	The field to sort by.
ListVtapsRequest.SortOrder	getSortOrder()	The sort order to use, either ascending (ASC) or descending (DESC).
String	getSource()	The OCID of the VTAP source.
String	getTargetId()	The OCID of the VTAP target.
String	getTargetIp()	The IP address of the VTAP target.
String	getVcnId()	The OCID of the VCN.
int	hashCode()	Uses getInvocationCallback and getRetryConfiguration to generate a hash.
ListVtapsRequest.Builder	toBuilder()	Return an instance of ListVtapsRequest.Builder that allows you to modify request properties.
String	toString()

Methods inherited from class com.oracle.bmc.requests.BmcRequest

getBody$, getInvocationCallback, getRetryConfiguration, setInvocationCallback, setRetryConfiguration, supportsExpect100Continue

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListVtapsRequest

public ListVtapsRequest()

Method Detail

getCompartmentId

public String getCompartmentId()

The OCID of the compartment.

getVcnId

public String getVcnId()

The OCID of the VCN.

getSource

public String getSource()

The OCID of the VTAP source.

getTargetId

public String getTargetId()

The OCID of the VTAP target.

getTargetIp

public String getTargetIp()

The IP address of the VTAP target.

getIsVtapEnabled

public Boolean getIsVtapEnabled()

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).

getLimit

public Integer getLimit()

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

getPage

public String getPage()

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.

getOpcRequestId

public String getOpcRequestId()

Unique identifier for the request.

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

getSortBy

public ListVtapsRequest.SortBy getSortBy()

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.

getSortOrder

public ListVtapsRequest.SortOrder getSortOrder()

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

The DISPLAYNAME sort order is case sensitive.

getDisplayName

public String getDisplayName()

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

getLifecycleState

public Vtap.LifecycleState getLifecycleState()

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

The state value is case-insensitive.

toBuilder

public ListVtapsRequest.Builder toBuilder()

Return an instance of ListVtapsRequest.Builder that allows you to modify request properties.

Returns:

instance of ListVtapsRequest.Builder that allows you to modify request properties.

builder

public static ListVtapsRequest.Builder builder()

Return a new builder for this request object.

Returns:

builder for the request object

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Description copied from class: BmcRequest

Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.

Overrides:

equals in class BmcRequest<Void>

hashCode

public int hashCode()

Description copied from class: BmcRequest

Uses getInvocationCallback and getRetryConfiguration to generate a hash.

Overrides:

hashCode in class BmcRequest<Void>