CaptureFilter (Oracle Cloud Infrastructure Java SDK

java.lang.Object
- com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
- - com.oracle.bmc.core.model.CaptureFilter

```
@Generated(value="OracleSDKGenerator",
           comments="API Version: 20160918")
public final class CaptureFilter
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
```
A capture filter contains a set of captureFilterRuleDetails governing what traffic is mirrored for a Vtap or captured for a VCN Flow Log. The capture filter is created with no rules defined, and it must have at least one rule to mirror traffic for the VTAP or collect VCN flow logs.
Note: Objects should always be created or deserialized using the CaptureFilter.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 CaptureFilter.Builder, which maintain a set of all explicitly set fields called CaptureFilter.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).

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`CaptureFilter.Builder`
`static class`	`CaptureFilter.FilterType` Indicates which service will use this capture filter
`static class`	`CaptureFilter.LifecycleState` The capture filter’s current administrative state.

Field Summary
- Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
  EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors
Constructor and Description
`CaptureFilter(String compartmentId, Map<String,Map<String,Object>> definedTags, String displayName, Map<String,String> freeformTags, String id, CaptureFilter.LifecycleState lifecycleState, CaptureFilter.FilterType filterType, Date timeCreated, List<VtapCaptureFilterRuleDetails> vtapCaptureFilterRules, List<FlowLogCaptureFilterRuleDetails> flowLogCaptureFilterRules)` Deprecated.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static CaptureFilter.Builder`	`builder()` Create a new builder.
`boolean`	`equals(Object o)`
`String`	`getCompartmentId()` The OCID of the compartment containing the capture filter.
`Map<String,Map<String,Object>>`	`getDefinedTags()` Defined tags for this resource.
`String`	`getDisplayName()` A user-friendly name.
`CaptureFilter.FilterType`	`getFilterType()` Indicates which service will use this capture filter
`List<FlowLogCaptureFilterRuleDetails>`	`getFlowLogCaptureFilterRules()` The set of rules governing what traffic the VCN flow log collects.
`Map<String,String>`	`getFreeformTags()` Free-form tags for this resource.
`String`	`getId()` The capture filter’s Oracle ID (OCID).
`CaptureFilter.LifecycleState`	`getLifecycleState()` The capture filter’s current administrative state.
`Date`	`getTimeCreated()` The date and time the capture filter was created, in the format defined by RFC3339.
`List<VtapCaptureFilterRuleDetails>`	`getVtapCaptureFilterRules()` The set of rules governing what traffic a VTAP mirrors.
`int`	`hashCode()`
`CaptureFilter.Builder`	`toBuilder()`
`String`	`toString()`
`String`	`toString(boolean includeByteArrayContents)` Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CaptureFilter

@Deprecated
 @ConstructorProperties(value={"compartmentId","definedTags","displayName","freeformTags","id","lifecycleState","filterType","timeCreated","vtapCaptureFilterRules","flowLogCaptureFilterRules"})
public CaptureFilter(String compartmentId,
                                                                                                                                                                                                                                   Map<String,Map<String,Object>> definedTags,
                                                                                                                                                                                                                                   String displayName,
                                                                                                                                                                                                                                   Map<String,String> freeformTags,
                                                                                                                                                                                                                                   String id,
                                                                                                                                                                                                                                   CaptureFilter.LifecycleState lifecycleState,
                                                                                                                                                                                                                                   CaptureFilter.FilterType filterType,
                                                                                                                                                                                                                                   Date timeCreated,
                                                                                                                                                                                                                                   List<VtapCaptureFilterRuleDetails> vtapCaptureFilterRules,
                                                                                                                                                                                                                                   List<FlowLogCaptureFilterRuleDetails> flowLogCaptureFilterRules)

Deprecated.

Method Detail
- builder
```
public static CaptureFilter.Builder builder()
```
  Create a new builder.
- toBuilder
```
public CaptureFilter.Builder toBuilder()
```
- getCompartmentId
```
public String getCompartmentId()
```
  The OCID of the compartment containing the capture filter.
  
  Returns:
  
  the value
- getDefinedTags
```
public Map<String,Map<String,Object>> getDefinedTags()
```
  Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
  
  Example: {"Operations": {"CostCenter": "42"}}
  
  Returns:
  
  the value
- getDisplayName
```
public String getDisplayName()
```
  A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
  
  Returns:
  
  the value
- getFreeformTags
```
public Map<String,String> getFreeformTags()
```
  Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.
  
  Example: {"Department": "Finance"}
  
  Returns:
  
  the value
- getId
```
public String getId()
```
  The capture filter’s Oracle ID (OCID).
  
  Returns:
  
  the value
- getLifecycleState
```
public CaptureFilter.LifecycleState getLifecycleState()
```
  The capture filter’s current administrative state.
  
  Returns:
  
  the value
- getFilterType
```
public CaptureFilter.FilterType getFilterType()
```
  Indicates which service will use this capture filter
  
  Returns:
  
  the value
- getTimeCreated
```
public Date getTimeCreated()
```
  The date and time the capture filter was created, in the format defined by RFC3339.
  
  Example: 2021-08-25T21:10:29.600Z
  
  Returns:
  
  the value
- getVtapCaptureFilterRules
```
public List<VtapCaptureFilterRuleDetails> getVtapCaptureFilterRules()
```
  The set of rules governing what traffic a VTAP mirrors.
  
  Returns:
  
  the value
- getFlowLogCaptureFilterRules
```
public List<FlowLogCaptureFilterRuleDetails> getFlowLogCaptureFilterRules()
```
  The set of rules governing what traffic the VCN flow log collects.
  
  Returns:
  
  the value
- toString
```
public String toString()
```
  Overrides:
  
  toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
- toString
```
public String toString(boolean includeByteArrayContents)
```
  Return a string representation of the object.
  
  Parameters:
  
  includeByteArrayContents - true to include the full contents of byte arrays
  
  Returns:
  
  string representation
- equals
```
public boolean equals(Object o)
```
  Overrides:
  
  equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
- hashCode
```
public int hashCode()
```
  Overrides:
  
  hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

Class CaptureFilter

Nested Class Summary

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

Constructor Summary

Method Summary

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

Methods inherited from class java.lang.Object

Constructor Detail

CaptureFilter

Method Detail

builder

toBuilder

getCompartmentId

getDefinedTags

getDisplayName

getFreeformTags

getId

getLifecycleState

getFilterType

getTimeCreated

getVtapCaptureFilterRules

getFlowLogCaptureFilterRules

toString

toString

equals

hashCode