- 1.63.0 (latest)
- 1.62.0
- 1.61.0
- 1.59.0
- 1.58.0
- 1.57.0
- 1.56.0
- 1.55.0
- 1.54.0
- 1.53.0
- 1.52.0
- 1.51.0
- 1.50.0
- 1.49.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.38.0
- 1.37.0
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.27.0
- 1.26.0
- 1.25.0
- 1.24.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.1
- 1.11.0
- 1.9.1
- 1.8.1
- 1.7.2
- 1.6.0-beta
public final class PacketMirroring extends GeneratedMessageV3 implements PacketMirroringOrBuilder
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.
Protobuf type google.cloud.compute.v1.PacketMirroring
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > PacketMirroringImplements
PacketMirroringOrBuilderStatic Fields
COLLECTOR_ILB_FIELD_NUMBER
public static final int COLLECTOR_ILB_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
CREATION_TIMESTAMP_FIELD_NUMBER
public static final int CREATION_TIMESTAMP_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
ENABLE_FIELD_NUMBER
public static final int ENABLE_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
ID_FIELD_NUMBER
public static final int ID_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
KIND_FIELD_NUMBER
public static final int KIND_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
MIRRORED_RESOURCES_FIELD_NUMBER
public static final int MIRRORED_RESOURCES_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
NETWORK_FIELD_NUMBER
public static final int NETWORK_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
PRIORITY_FIELD_NUMBER
public static final int PRIORITY_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
REGION_FIELD_NUMBER
public static final int REGION_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
SELF_LINK_FIELD_NUMBER
public static final int SELF_LINK_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
Static Methods
getDefaultInstance()
public static PacketMirroring getDefaultInstance()
Returns | |
---|---|
Type | Description |
PacketMirroring |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
newBuilder()
public static PacketMirroring.Builder newBuilder()
Returns | |
---|---|
Type | Description |
PacketMirroring.Builder |
newBuilder(PacketMirroring prototype)
public static PacketMirroring.Builder newBuilder(PacketMirroring prototype)
Parameter | |
---|---|
Name | Description |
prototype |
PacketMirroring |
Returns | |
---|---|
Type | Description |
PacketMirroring.Builder |
parseDelimitedFrom(InputStream input)
public static PacketMirroring parseDelimitedFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input |
InputStream |
Returns | |
---|---|
Type | Description |
PacketMirroring |
Exceptions | |
---|---|
Type | Description |
IOException |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static PacketMirroring parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
PacketMirroring |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(byte[] data)
public static PacketMirroring parseFrom(byte[] data)
Parameter | |
---|---|
Name | Description |
data |
byte[] |
Returns | |
---|---|
Type | Description |
PacketMirroring |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static PacketMirroring parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
byte[] |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
PacketMirroring |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data)
public static PacketMirroring parseFrom(ByteString data)
Parameter | |
---|---|
Name | Description |
data |
ByteString |
Returns | |
---|---|
Type | Description |
PacketMirroring |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static PacketMirroring parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
ByteString |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
PacketMirroring |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(CodedInputStream input)
public static PacketMirroring parseFrom(CodedInputStream input)
Parameter | |
---|---|
Name | Description |
input |
CodedInputStream |
Returns | |
---|---|
Type | Description |
PacketMirroring |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static PacketMirroring parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
PacketMirroring |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input)
public static PacketMirroring parseFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input |
InputStream |
Returns | |
---|---|
Type | Description |
PacketMirroring |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static PacketMirroring parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
PacketMirroring |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(ByteBuffer data)
public static PacketMirroring parseFrom(ByteBuffer data)
Parameter | |
---|---|
Name | Description |
data |
ByteBuffer |
Returns | |
---|---|
Type | Description |
PacketMirroring |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static PacketMirroring parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
ByteBuffer |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
PacketMirroring |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parser()
public static Parser<PacketMirroring> parser()
Returns | |
---|---|
Type | Description |
Parser<PacketMirroring> |
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter | |
---|---|
Name | Description |
obj |
Object |
Returns | |
---|---|
Type | Description |
boolean |
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.
optional .google.cloud.compute.v1.PacketMirroringForwardingRuleInfo collector_ilb = 426607853;
Returns | |
---|---|
Type | Description |
PacketMirroringForwardingRuleInfo |
The collectorIlb. |
getCollectorIlbOrBuilder()
public PacketMirroringForwardingRuleInfoOrBuilder getCollectorIlbOrBuilder()
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.
optional .google.cloud.compute.v1.PacketMirroringForwardingRuleInfo collector_ilb = 426607853;
Returns | |
---|---|
Type | Description |
PacketMirroringForwardingRuleInfoOrBuilder |
getCreationTimestamp()
public String getCreationTimestamp()
[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;
Returns | |
---|---|
Type | Description |
String |
The creationTimestamp. |
getCreationTimestampBytes()
public ByteString getCreationTimestampBytes()
[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for creationTimestamp. |
getDefaultInstanceForType()
public PacketMirroring getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
PacketMirroring |
getDescription()
public String getDescription()
An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;
Returns | |
---|---|
Type | Description |
String |
The description. |
getDescriptionBytes()
public ByteString getDescriptionBytes()
An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for description. |
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. Check the Enable enum for the list of possible values.
optional string enable = 311764355;
Returns | |
---|---|
Type | Description |
String |
The enable. |
getEnableBytes()
public ByteString getEnableBytes()
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. Check the Enable enum for the list of possible values.
optional string enable = 311764355;
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for enable. |
getFilter()
public PacketMirroringFilter getFilter()
Filter for mirrored traffic. If unspecified, all IPv4 traffic is mirrored.
optional .google.cloud.compute.v1.PacketMirroringFilter filter = 336120696;
Returns | |
---|---|
Type | Description |
PacketMirroringFilter |
The filter. |
getFilterOrBuilder()
public PacketMirroringFilterOrBuilder getFilterOrBuilder()
Filter for mirrored traffic. If unspecified, all IPv4 traffic is mirrored.
optional .google.cloud.compute.v1.PacketMirroringFilter filter = 336120696;
Returns | |
---|---|
Type | Description |
PacketMirroringFilterOrBuilder |
getId()
public long getId()
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
optional uint64 id = 3355;
Returns | |
---|---|
Type | Description |
long |
The id. |
getKind()
public String getKind()
[Output Only] Type of the resource. Always compute#packetMirroring for packet mirrorings.
optional string kind = 3292052;
Returns | |
---|---|
Type | Description |
String |
The kind. |
getKindBytes()
public ByteString getKindBytes()
[Output Only] Type of the resource. Always compute#packetMirroring for packet mirrorings.
optional string kind = 3292052;
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for kind. |
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.
optional .google.cloud.compute.v1.PacketMirroringMirroredResourceInfo mirrored_resources = 124817348;
Returns | |
---|---|
Type | Description |
PacketMirroringMirroredResourceInfo |
The mirroredResources. |
getMirroredResourcesOrBuilder()
public PacketMirroringMirroredResourceInfoOrBuilder getMirroredResourcesOrBuilder()
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.
optional .google.cloud.compute.v1.PacketMirroringMirroredResourceInfo mirrored_resources = 124817348;
Returns | |
---|---|
Type | Description |
PacketMirroringMirroredResourceInfoOrBuilder |
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?
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.
optional string name = 3373707;
Returns | |
---|---|
Type | Description |
String |
The name. |
getNameBytes()
public ByteString getNameBytes()
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?
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.
optional string name = 3373707;
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for name. |
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.
optional .google.cloud.compute.v1.PacketMirroringNetworkInfo network = 232872494;
Returns | |
---|---|
Type | Description |
PacketMirroringNetworkInfo |
The network. |
getNetworkOrBuilder()
public PacketMirroringNetworkInfoOrBuilder getNetworkOrBuilder()
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.
optional .google.cloud.compute.v1.PacketMirroringNetworkInfo network = 232872494;
Returns | |
---|---|
Type | Description |
PacketMirroringNetworkInfoOrBuilder |
getParserForType()
public Parser<PacketMirroring> getParserForType()
Returns | |
---|---|
Type | Description |
Parser<PacketMirroring> |
getPriority()
public int 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.
optional uint32 priority = 445151652;
Returns | |
---|---|
Type | Description |
int |
The priority. |
getRegion()
public String getRegion()
[Output Only] URI of the region where the packetMirroring resides.
optional string region = 138946292;
Returns | |
---|---|
Type | Description |
String |
The region. |
getRegionBytes()
public ByteString getRegionBytes()
[Output Only] URI of the region where the packetMirroring resides.
optional string region = 138946292;
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for region. |
getSelfLink()
public String getSelfLink()
[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;
Returns | |
---|---|
Type | Description |
String |
The selfLink. |
getSelfLinkBytes()
public ByteString getSelfLinkBytes()
[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for selfLink. |
getSerializedSize()
public int getSerializedSize()
Returns | |
---|---|
Type | Description |
int |
hasCollectorIlb()
public boolean hasCollectorIlb()
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.
optional .google.cloud.compute.v1.PacketMirroringForwardingRuleInfo collector_ilb = 426607853;
Returns | |
---|---|
Type | Description |
boolean |
Whether the collectorIlb field is set. |
hasCreationTimestamp()
public boolean hasCreationTimestamp()
[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;
Returns | |
---|---|
Type | Description |
boolean |
Whether the creationTimestamp field is set. |
hasDescription()
public boolean hasDescription()
An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;
Returns | |
---|---|
Type | Description |
boolean |
Whether the description field is set. |
hasEnable()
public boolean hasEnable()
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. Check the Enable enum for the list of possible values.
optional string enable = 311764355;
Returns | |
---|---|
Type | Description |
boolean |
Whether the enable field is set. |
hasFilter()
public boolean hasFilter()
Filter for mirrored traffic. If unspecified, all IPv4 traffic is mirrored.
optional .google.cloud.compute.v1.PacketMirroringFilter filter = 336120696;
Returns | |
---|---|
Type | Description |
boolean |
Whether the filter field is set. |
hasId()
public boolean hasId()
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
optional uint64 id = 3355;
Returns | |
---|---|
Type | Description |
boolean |
Whether the id field is set. |
hasKind()
public boolean hasKind()
[Output Only] Type of the resource. Always compute#packetMirroring for packet mirrorings.
optional string kind = 3292052;
Returns | |
---|---|
Type | Description |
boolean |
Whether the kind field is set. |
hasMirroredResources()
public boolean hasMirroredResources()
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.
optional .google.cloud.compute.v1.PacketMirroringMirroredResourceInfo mirrored_resources = 124817348;
Returns | |
---|---|
Type | Description |
boolean |
Whether the mirroredResources field is set. |
hasName()
public boolean hasName()
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?
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.
optional string name = 3373707;
Returns | |
---|---|
Type | Description |
boolean |
Whether the name field is set. |
hasNetwork()
public boolean hasNetwork()
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.
optional .google.cloud.compute.v1.PacketMirroringNetworkInfo network = 232872494;
Returns | |
---|---|
Type | Description |
boolean |
Whether the network field is set. |
hasPriority()
public boolean hasPriority()
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.
optional uint32 priority = 445151652;
Returns | |
---|---|
Type | Description |
boolean |
Whether the priority field is set. |
hasRegion()
public boolean hasRegion()
[Output Only] URI of the region where the packetMirroring resides.
optional string region = 138946292;
Returns | |
---|---|
Type | Description |
boolean |
Whether the region field is set. |
hasSelfLink()
public boolean hasSelfLink()
[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;
Returns | |
---|---|
Type | Description |
boolean |
Whether the selfLink field is set. |
hashCode()
public int hashCode()
Returns | |
---|---|
Type | Description |
int |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
newBuilderForType()
public PacketMirroring.Builder newBuilderForType()
Returns | |
---|---|
Type | Description |
PacketMirroring.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected PacketMirroring.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter | |
---|---|
Name | Description |
parent |
BuilderParent |
Returns | |
---|---|
Type | Description |
PacketMirroring.Builder |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter | |
---|---|
Name | Description |
unused |
UnusedPrivateParameter |
Returns | |
---|---|
Type | Description |
Object |
toBuilder()
public PacketMirroring.Builder toBuilder()
Returns | |
---|---|
Type | Description |
PacketMirroring.Builder |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter | |
---|---|
Name | Description |
output |
CodedOutputStream |
Exceptions | |
---|---|
Type | Description |
IOException |