PacketMirroring (Compute Engine API beta-rev20220726-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.compute.model.PacketMirroring

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class PacketMirroring
extends GenericJson
```
Represents a Packet Mirroring resource. Packet Mirroring clones the traffic of specified instances in your Virtual Private Cloud (VPC) network and forwards it to a collector destination, such as an instance group of an internal TCP/UDP load balancer, for analysis or examination. For more information about setting up Packet Mirroring, see Using Packet Mirroring.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Compute Engine API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

PacketMirroring()

Constructors
Constructor and Description
`PacketMirroring()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PacketMirroring`	`clone()`
`PacketMirroringForwardingRuleInfo`	`getCollectorIlb()` The Forwarding Rule resource of type loadBalancingScheme=INTERNAL that will be used as collector for mirrored traffic.
`String`	`getCreationTimestamp()` [Output Only] Creation timestamp in RFC3339 text format.
`String`	`getDescription()` An optional description of this resource.
`String`	`getEnable()` Indicates whether or not this packet mirroring takes effect.
`PacketMirroringFilter`	`getFilter()` Filter for mirrored traffic.
`BigInteger`	`getId()` [Output Only] The unique identifier for the resource.
`String`	`getKind()` [Output Only] Type of the resource.
`PacketMirroringMirroredResourceInfo`	`getMirroredResources()` PacketMirroring mirroredResourceInfos.
`String`	`getName()` Name of the resource; provided by the client when the resource is created.
`PacketMirroringNetworkInfo`	`getNetwork()` Specifies the mirrored VPC network.
`Long`	`getPriority()` The priority of applying this configuration.
`String`	`getRegion()` [Output Only] URI of the region where the packetMirroring resides.
`String`	`getSelfLink()` [Output Only] Server-defined URL for the resource.
`PacketMirroring`	`set(String fieldName, Object value)`
`PacketMirroring`	`setCollectorIlb(PacketMirroringForwardingRuleInfo collectorIlb)` The Forwarding Rule resource of type loadBalancingScheme=INTERNAL that will be used as collector for mirrored traffic.
`PacketMirroring`	`setCreationTimestamp(String creationTimestamp)` [Output Only] Creation timestamp in RFC3339 text format.
`PacketMirroring`	`setDescription(String description)` An optional description of this resource.
`PacketMirroring`	`setEnable(String enable)` Indicates whether or not this packet mirroring takes effect.
`PacketMirroring`	`setFilter(PacketMirroringFilter filter)` Filter for mirrored traffic.
`PacketMirroring`	`setId(BigInteger id)` [Output Only] The unique identifier for the resource.
`PacketMirroring`	`setKind(String kind)` [Output Only] Type of the resource.
`PacketMirroring`	`setMirroredResources(PacketMirroringMirroredResourceInfo mirroredResources)` PacketMirroring mirroredResourceInfos.
`PacketMirroring`	`setName(String name)` Name of the resource; provided by the client when the resource is created.
`PacketMirroring`	`setNetwork(PacketMirroringNetworkInfo network)` Specifies the mirrored VPC network.
`PacketMirroring`	`setPriority(Long priority)` The priority of applying this configuration.
`PacketMirroring`	`setRegion(String region)` [Output Only] URI of the region where the packetMirroring resides.
`PacketMirroring`	`setSelfLink(String selfLink)` [Output Only] Server-defined URL for the resource.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

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

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - PacketMirroring
```
public PacketMirroring()
```
- Method Detail
  - getCollectorIlb
```
public PacketMirroringForwardingRuleInfo getCollectorIlb()
```
    The Forwarding Rule resource of type loadBalancingScheme=INTERNAL that will be used as collector for mirrored traffic. The specified forwarding rule must have isMirroringCollector set to true.
    
    Returns:
    
    value or null for none
  - setCollectorIlb
```
public PacketMirroring setCollectorIlb(PacketMirroringForwardingRuleInfo collectorIlb)
```
    The Forwarding Rule resource of type loadBalancingScheme=INTERNAL that will be used as collector for mirrored traffic. The specified forwarding rule must have isMirroringCollector set to true.
    
    Parameters:
    
    collectorIlb - collectorIlb or null for none
  - getCreationTimestamp
```
public String getCreationTimestamp()
```
    [Output Only] Creation timestamp in RFC3339 text format.
    
    Returns:
    
    value or null for none
  - setCreationTimestamp
```
public PacketMirroring setCreationTimestamp(String creationTimestamp)
```
    [Output Only] Creation timestamp in RFC3339 text format.
    
    Parameters:
    
    creationTimestamp - creationTimestamp or null for none
  - getDescription
```
public String getDescription()
```
    An optional description of this resource. Provide this property when you create the resource.
    
    Returns:
    
    value or null for none
  - setDescription
```
public PacketMirroring setDescription(String description)
```
    An optional description of this resource. Provide this property when you create the resource.
    
    Parameters:
    
    description - description or null for none
  - getEnable
```
public String getEnable()
```
    Indicates whether or not this packet mirroring takes effect. If set to FALSE, this packet mirroring policy will not be enforced on the network. The default is TRUE.
    
    Returns:
    
    value or null for none
  - setEnable
```
public PacketMirroring setEnable(String enable)
```
    Indicates whether or not this packet mirroring takes effect. If set to FALSE, this packet mirroring policy will not be enforced on the network. The default is TRUE.
    
    Parameters:
    
    enable - enable or null for none
  - getFilter
```
public PacketMirroringFilter getFilter()
```
    Filter for mirrored traffic. If unspecified, all traffic is mirrored.
    
    Returns:
    
    value or null for none
  - setFilter
```
public PacketMirroring setFilter(PacketMirroringFilter filter)
```
    Filter for mirrored traffic. If unspecified, all traffic is mirrored.
    
    Parameters:
    
    filter - filter or null for none
  - getId
```
public BigInteger getId()
```
    [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    
    Returns:
    
    value or null for none
  - setId
```
public PacketMirroring setId(BigInteger id)
```
    [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    
    Parameters:
    
    id - id or null for none
  - getKind
```
public String getKind()
```
    [Output Only] Type of the resource. Always compute#packetMirroring for packet mirrorings.
    
    Returns:
    
    value or null for none
  - setKind
```
public PacketMirroring setKind(String kind)
```
    [Output Only] Type of the resource. Always compute#packetMirroring for packet mirrorings.
    
    Parameters:
    
    kind - kind or null for none
  - getMirroredResources
```
public PacketMirroringMirroredResourceInfo getMirroredResources()
```
    PacketMirroring mirroredResourceInfos. MirroredResourceInfo specifies a set of mirrored VM instances, subnetworks and/or tags for which traffic from/to all VM instances will be mirrored.
    
    Returns:
    
    value or null for none
  - setMirroredResources
```
public PacketMirroring setMirroredResources(PacketMirroringMirroredResourceInfo mirroredResources)
```
    PacketMirroring mirroredResourceInfos. MirroredResourceInfo specifies a set of mirrored VM instances, subnetworks and/or tags for which traffic from/to all VM instances will be mirrored.
    
    Parameters:
    
    mirroredResources - mirroredResources or null for none
  - getName
```
public String getName()
```
    Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    
    Returns:
    
    value or null for none
  - setName
```
public PacketMirroring setName(String name)
```
    Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    
    Parameters:
    
    name - name or null for none
  - getNetwork
```
public PacketMirroringNetworkInfo getNetwork()
```
    Specifies the mirrored VPC network. Only packets in this network will be mirrored. All mirrored VMs should have a NIC in the given network. All mirrored subnetworks should belong to the given network.
    
    Returns:
    
    value or null for none
  - setNetwork
```
public PacketMirroring setNetwork(PacketMirroringNetworkInfo network)
```
    Specifies the mirrored VPC network. Only packets in this network will be mirrored. All mirrored VMs should have a NIC in the given network. All mirrored subnetworks should belong to the given network.
    
    Parameters:
    
    network - network or null for none
  - getPriority
```
public Long getPriority()
```
    The priority of applying this configuration. Priority is used to break ties in cases where there is more than one matching rule. In the case of two rules that apply for a given Instance, the one with the lowest-numbered priority value wins. Default value is 1000. Valid range is 0 through 65535.
    
    Returns:
    
    value or null for none
  - setPriority
```
public PacketMirroring setPriority(Long priority)
```
    The priority of applying this configuration. Priority is used to break ties in cases where there is more than one matching rule. In the case of two rules that apply for a given Instance, the one with the lowest-numbered priority value wins. Default value is 1000. Valid range is 0 through 65535.
    
    Parameters:
    
    priority - priority or null for none
  - getRegion
```
public String getRegion()
```
    [Output Only] URI of the region where the packetMirroring resides.
    
    Returns:
    
    value or null for none
  - setRegion
```
public PacketMirroring setRegion(String region)
```
    [Output Only] URI of the region where the packetMirroring resides.
    
    Parameters:
    
    region - region or null for none
  - getSelfLink
```
public String getSelfLink()
```
    [Output Only] Server-defined URL for the resource.
    
    Returns:
    
    value or null for none
  - setSelfLink
```
public PacketMirroring setSelfLink(String selfLink)
```
    [Output Only] Server-defined URL for the resource.
    
    Parameters:
    
    selfLink - selfLink or null for none
  - set
```
public PacketMirroring set(String fieldName,
                           Object value)
```
    Overrides:
    
    set in class GenericJson
  - clone
```
public PacketMirroring clone()
```
    Overrides:
    
    clone in class GenericJson

Class PacketMirroring

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

PacketMirroring

Method Detail

getCollectorIlb

setCollectorIlb

getCreationTimestamp

setCreationTimestamp

getDescription

setDescription

getEnable

setEnable

getFilter

setFilter

getId

setId

getKind

setKind

getMirroredResources

setMirroredResources

getName

setName

getNetwork

setNetwork

getPriority

setPriority

getRegion

setRegion

getSelfLink

setSelfLink

set

clone