@Generated(value="OracleSDKGenerator",
comments="API Version: 20160918")
public final class Vtap
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
A virtual test access point (VTAP) provides a way to mirror all traffic from a designated source to a selected target in order to facilitate troubleshooting, security analysis, and data monitoring. A VTAP is functionally similar to a test access point (TAP) you might deploy in your on-premises network.
A *CaptureFilter* contains a set of *captureFilterRuleDetails* governing
what traffic a VTAP mirrors.
Note: Objects should always be created or deserialized using the Vtap.Builder. This model
distinguishes fields that are null because they are unset from fields that are explicitly
set to null. This is done in the setter methods of the Vtap.Builder, which maintain a
set of all explicitly set fields called Vtap.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set
fields into account. The constructor, on the other hand, does not take the explicitly set fields
into account (since the constructor cannot distinguish explicit null from unset null).
| Modifier and Type | Class and Description |
|---|---|
static class |
Vtap.Builder |
static class |
Vtap.EncapsulationProtocol
Defines an encapsulation header type for the VTAP’s mirrored traffic.
|
static class |
Vtap.LifecycleState
The VTAP’s administrative lifecycle state.
|
static class |
Vtap.LifecycleStateDetails
The VTAP’s current running state.
|
static class |
Vtap.SourceType
The source type for the VTAP.
|
static class |
Vtap.TargetType
The target type for the VTAP.
|
static class |
Vtap.TrafficMode
Used to control the priority of traffic.
|
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME| Constructor and Description |
|---|
Vtap(String compartmentId,
String vcnId,
Map<String,Map<String,Object>> definedTags,
String displayName,
Map<String,String> freeformTags,
String id,
Vtap.LifecycleState lifecycleState,
Vtap.LifecycleStateDetails lifecycleStateDetails,
Date timeCreated,
String sourceId,
String targetId,
String targetIp,
String captureFilterId,
Vtap.EncapsulationProtocol encapsulationProtocol,
Long vxlanNetworkIdentifier,
Boolean isVtapEnabled,
Vtap.SourceType sourceType,
Vtap.TrafficMode trafficMode,
Integer maxPacketSize,
Vtap.TargetType targetType,
String sourcePrivateEndpointIp,
String sourcePrivateEndpointSubnetId)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static Vtap.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
String |
getCaptureFilterId()
The capture filter’s Oracle ID
(OCID).
|
String |
getCompartmentId()
The OCID of
the compartment containing the
Vtap resource. |
Map<String,Map<String,Object>> |
getDefinedTags()
Defined tags for this resource.
|
String |
getDisplayName()
A user-friendly name.
|
Vtap.EncapsulationProtocol |
getEncapsulationProtocol()
Defines an encapsulation header type for the VTAP’s mirrored traffic.
|
Map<String,String> |
getFreeformTags()
Simple key-value pair that is applied without any predefined name, type or scope.
|
String |
getId()
The VTAP’s Oracle ID
(OCID).
|
Boolean |
getIsVtapEnabled()
Used to start or stop a
Vtap resource. |
Vtap.LifecycleState |
getLifecycleState()
The VTAP’s administrative lifecycle state.
|
Vtap.LifecycleStateDetails |
getLifecycleStateDetails()
The VTAP’s current running state.
|
Integer |
getMaxPacketSize()
The maximum size of the packets to be included in the filter.
|
String |
getSourceId()
The OCID of
the source point where packets are captured.
|
String |
getSourcePrivateEndpointIp()
The IP Address of the source private endpoint.
|
String |
getSourcePrivateEndpointSubnetId()
The OCID of
the subnet that source private endpoint belongs to.
|
Vtap.SourceType |
getSourceType()
The source type for the VTAP.
|
String |
getTargetId()
The OCID of
the destination resource where mirrored packets are sent.
|
String |
getTargetIp()
The IP address of the destination resource where mirrored packets are sent.
|
Vtap.TargetType |
getTargetType()
The target type for the VTAP.
|
Date |
getTimeCreated()
The date and time the VTAP was created, in the format defined by
RFC3339.
|
Vtap.TrafficMode |
getTrafficMode()
Used to control the priority of traffic.
|
String |
getVcnId()
The OCID of
the VCN containing the
Vtap resource. |
Long |
getVxlanNetworkIdentifier()
The virtual extensible LAN (VXLAN) network identifier (or VXLAN segment ID) that uniquely
identifies the VXLAN.
|
int |
hashCode() |
Vtap.Builder |
toBuilder() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet@Deprecated @ConstructorProperties(value={"compartmentId","vcnId","definedTags","displayName","freeformTags","id","lifecycleState","lifecycleStateDetails","timeCreated","sourceId","targetId","targetIp","captureFilterId","encapsulationProtocol","vxlanNetworkIdentifier","isVtapEnabled","sourceType","trafficMode","maxPacketSize","targetType","sourcePrivateEndpointIp","sourcePrivateEndpointSubnetId"}) public Vtap(String compartmentId, String vcnId, Map<String,Map<String,Object>> definedTags, String displayName, Map<String,String> freeformTags, String id, Vtap.LifecycleState lifecycleState, Vtap.LifecycleStateDetails lifecycleStateDetails, Date timeCreated, String sourceId, String targetId, String targetIp, String captureFilterId, Vtap.EncapsulationProtocol encapsulationProtocol, Long vxlanNetworkIdentifier, Boolean isVtapEnabled, Vtap.SourceType sourceType, Vtap.TrafficMode trafficMode, Integer maxPacketSize, Vtap.TargetType targetType, String sourcePrivateEndpointIp, String sourcePrivateEndpointSubnetId)
public static Vtap.Builder builder()
Create a new builder.
public Vtap.Builder toBuilder()
public String getCompartmentId()
The OCID of
the compartment containing the Vtap resource.
public String getVcnId()
The OCID of
the VCN containing the Vtap resource.
public Map<String,Map<String,Object>> getDefinedTags()
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace": {"bar-key": "value"}}
public String getDisplayName()
A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
public Map<String,String> getFreeformTags()
Simple key-value pair that is applied without any predefined name, type or scope. Exists for
cross-compatibility only. Example: {"bar-key": "value"}
public Vtap.LifecycleState getLifecycleState()
The VTAP’s administrative lifecycle state.
public Vtap.LifecycleStateDetails getLifecycleStateDetails()
The VTAP’s current running state.
public Date getTimeCreated()
The date and time the VTAP was created, in the format defined by RFC3339.
Example: 2020-08-25T21:10:29.600Z
public String getSourceId()
The OCID of the source point where packets are captured.
public String getTargetId()
The OCID of the destination resource where mirrored packets are sent.
public String getTargetIp()
The IP address of the destination resource where mirrored packets are sent.
public String getCaptureFilterId()
The capture filter’s Oracle ID (OCID).
public Vtap.EncapsulationProtocol getEncapsulationProtocol()
Defines an encapsulation header type for the VTAP’s mirrored traffic.
public Long getVxlanNetworkIdentifier()
The virtual extensible LAN (VXLAN) network identifier (or VXLAN segment ID) that uniquely identifies the VXLAN.
public Boolean getIsVtapEnabled()
Used to start or stop a Vtap resource.
TRUE directs the VTAP to start mirroring traffic. * FALSE (Default)
directs the VTAP to stop mirroring traffic.
public Vtap.SourceType getSourceType()
The source type for the VTAP.
public Vtap.TrafficMode getTrafficMode()
Used to control the priority of traffic. It is an optional field. If it not passed, the value is DEFAULT
public Integer getMaxPacketSize()
The maximum size of the packets to be included in the filter.
public Vtap.TargetType getTargetType()
The target type for the VTAP.
public String getSourcePrivateEndpointIp()
The IP Address of the source private endpoint.
public String getSourcePrivateEndpointSubnetId()
The OCID of the subnet that source private endpoint belongs to.
public String toString()
toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic String toString(boolean includeByteArrayContents)
Return a string representation of the object.
includeByteArrayContents - true to include the full contents of byte arrayspublic boolean equals(Object o)
equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic int hashCode()
hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelCopyright © 2016–2024. All rights reserved.