Class MirroringEndpointGroup (0.94.0)

public final class MirroringEndpointGroup extends GeneratedMessage implements MirroringEndpointGroupOrBuilder

An endpoint group is a consumer frontend for a deployment group (backend). In order to configure mirroring for a network, consumers must create:

  • An association between their network and the endpoint group.
  • A security profile that points to the endpoint group.
  • A mirroring rule that references the security profile (group).

Protobuf type google.cloud.networksecurity.v1.MirroringEndpointGroup

Static Fields

ASSOCIATIONS_FIELD_NUMBER

public static final int ASSOCIATIONS_FIELD_NUMBER
Field Value
Type Description
int

CONNECTED_DEPLOYMENT_GROUPS_FIELD_NUMBER

public static final int CONNECTED_DEPLOYMENT_GROUPS_FIELD_NUMBER
Field Value
Type Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
Type Description
int

MIRRORING_DEPLOYMENT_GROUP_FIELD_NUMBER

public static final int MIRRORING_DEPLOYMENT_GROUP_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

RECONCILING_FIELD_NUMBER

public static final int RECONCILING_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static MirroringEndpointGroup getDefaultInstance()
Returns
Type Description
MirroringEndpointGroup

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static MirroringEndpointGroup.Builder newBuilder()
Returns
Type Description
MirroringEndpointGroup.Builder

newBuilder(MirroringEndpointGroup prototype)

public static MirroringEndpointGroup.Builder newBuilder(MirroringEndpointGroup prototype)
Parameter
Name Description
prototype MirroringEndpointGroup
Returns
Type Description
MirroringEndpointGroup.Builder

parseDelimitedFrom(InputStream input)

public static MirroringEndpointGroup parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
MirroringEndpointGroup
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static MirroringEndpointGroup parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MirroringEndpointGroup
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static MirroringEndpointGroup parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
MirroringEndpointGroup
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static MirroringEndpointGroup parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MirroringEndpointGroup
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static MirroringEndpointGroup parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
MirroringEndpointGroup
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static MirroringEndpointGroup parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MirroringEndpointGroup
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static MirroringEndpointGroup parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
MirroringEndpointGroup
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static MirroringEndpointGroup parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MirroringEndpointGroup
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static MirroringEndpointGroup parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
MirroringEndpointGroup
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static MirroringEndpointGroup parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MirroringEndpointGroup
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static MirroringEndpointGroup parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
MirroringEndpointGroup
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static MirroringEndpointGroup parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MirroringEndpointGroup
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<MirroringEndpointGroup> parser()
Returns
Type Description
Parser<MirroringEndpointGroup>

Methods

containsLabels(String key)

public boolean containsLabels(String key)

Optional. Labels are key/value pairs that help to organize and filter resources.

map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAssociations(int index)

public MirroringEndpointGroup.AssociationDetails getAssociations(int index)

Output only. List of associations to this endpoint group.

repeated .google.cloud.networksecurity.v1.MirroringEndpointGroup.AssociationDetails associations = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
MirroringEndpointGroup.AssociationDetails

getAssociationsCount()

public int getAssociationsCount()

Output only. List of associations to this endpoint group.

repeated .google.cloud.networksecurity.v1.MirroringEndpointGroup.AssociationDetails associations = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getAssociationsList()

public List<MirroringEndpointGroup.AssociationDetails> getAssociationsList()

Output only. List of associations to this endpoint group.

repeated .google.cloud.networksecurity.v1.MirroringEndpointGroup.AssociationDetails associations = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<AssociationDetails>

getAssociationsOrBuilder(int index)

public MirroringEndpointGroup.AssociationDetailsOrBuilder getAssociationsOrBuilder(int index)

Output only. List of associations to this endpoint group.

repeated .google.cloud.networksecurity.v1.MirroringEndpointGroup.AssociationDetails associations = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
MirroringEndpointGroup.AssociationDetailsOrBuilder

getAssociationsOrBuilderList()

public List<? extends MirroringEndpointGroup.AssociationDetailsOrBuilder> getAssociationsOrBuilderList()

Output only. List of associations to this endpoint group.

repeated .google.cloud.networksecurity.v1.MirroringEndpointGroup.AssociationDetails associations = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<? extends com.google.cloud.networksecurity.v1.MirroringEndpointGroup.AssociationDetailsOrBuilder>

getConnectedDeploymentGroups(int index)

public MirroringEndpointGroup.ConnectedDeploymentGroup getConnectedDeploymentGroups(int index)

Output only. List of details about the connected deployment groups to this endpoint group.

repeated .google.cloud.networksecurity.v1.MirroringEndpointGroup.ConnectedDeploymentGroup connected_deployment_groups = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
MirroringEndpointGroup.ConnectedDeploymentGroup

getConnectedDeploymentGroupsCount()

public int getConnectedDeploymentGroupsCount()

Output only. List of details about the connected deployment groups to this endpoint group.

repeated .google.cloud.networksecurity.v1.MirroringEndpointGroup.ConnectedDeploymentGroup connected_deployment_groups = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getConnectedDeploymentGroupsList()

public List<MirroringEndpointGroup.ConnectedDeploymentGroup> getConnectedDeploymentGroupsList()

Output only. List of details about the connected deployment groups to this endpoint group.

repeated .google.cloud.networksecurity.v1.MirroringEndpointGroup.ConnectedDeploymentGroup connected_deployment_groups = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<ConnectedDeploymentGroup>

getConnectedDeploymentGroupsOrBuilder(int index)

public MirroringEndpointGroup.ConnectedDeploymentGroupOrBuilder getConnectedDeploymentGroupsOrBuilder(int index)

Output only. List of details about the connected deployment groups to this endpoint group.

repeated .google.cloud.networksecurity.v1.MirroringEndpointGroup.ConnectedDeploymentGroup connected_deployment_groups = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
MirroringEndpointGroup.ConnectedDeploymentGroupOrBuilder

getConnectedDeploymentGroupsOrBuilderList()

public List<? extends MirroringEndpointGroup.ConnectedDeploymentGroupOrBuilder> getConnectedDeploymentGroupsOrBuilderList()

Output only. List of details about the connected deployment groups to this endpoint group.

repeated .google.cloud.networksecurity.v1.MirroringEndpointGroup.ConnectedDeploymentGroup connected_deployment_groups = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<? extends com.google.cloud.networksecurity.v1.MirroringEndpointGroup.ConnectedDeploymentGroupOrBuilder>

getCreateTime()

public Timestamp getCreateTime()

Output only. The timestamp when the resource was created. See https://google.aip.dev/148#timestamps.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The timestamp when the resource was created. See https://google.aip.dev/148#timestamps.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public MirroringEndpointGroup getDefaultInstanceForType()
Returns
Type Description
MirroringEndpointGroup

getDescription()

public String getDescription()

Optional. User-provided description of the endpoint group. Used as additional context for the endpoint group.

string description = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Optional. User-provided description of the endpoint group. Used as additional context for the endpoint group.

string description = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for description.

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Optional. Labels are key/value pairs that help to organize and filter resources.

map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Optional. Labels are key/value pairs that help to organize and filter resources.

map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Optional. Labels are key/value pairs that help to organize and filter resources.

map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Optional. Labels are key/value pairs that help to organize and filter resources.

map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
String

getMirroringDeploymentGroup()

public String getMirroringDeploymentGroup()

Immutable. The deployment group that this DIRECT endpoint group is connected to, for example: projects/123456789/locations/global/mirroringDeploymentGroups/my-dg. See https://google.aip.dev/124.

string mirroring_deployment_group = 5 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The mirroringDeploymentGroup.

getMirroringDeploymentGroupBytes()

public ByteString getMirroringDeploymentGroupBytes()

Immutable. The deployment group that this DIRECT endpoint group is connected to, for example: projects/123456789/locations/global/mirroringDeploymentGroups/my-dg. See https://google.aip.dev/124.

string mirroring_deployment_group = 5 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for mirroringDeploymentGroup.

getName()

public String getName()

Immutable. Identifier. The resource name of this endpoint group, for example: projects/123456789/locations/global/mirroringEndpointGroups/my-eg. See https://google.aip.dev/122 for more details.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Immutable. Identifier. The resource name of this endpoint group, for example: projects/123456789/locations/global/mirroringEndpointGroups/my-eg. See https://google.aip.dev/122 for more details.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<MirroringEndpointGroup> getParserForType()
Returns
Type Description
Parser<MirroringEndpointGroup>
Overrides

getReconciling()

public boolean getReconciling()

Output only. The current state of the resource does not match the user's intended state, and the system is working to reconcile them. This is part of the normal operation (e.g. adding a new association to the group). See https://google.aip.dev/128.

bool reconciling = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The reconciling.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getState()

public MirroringEndpointGroup.State getState()

Output only. The current state of the endpoint group. See https://google.aip.dev/216.

.google.cloud.networksecurity.v1.MirroringEndpointGroup.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
MirroringEndpointGroup.State

The state.

getStateValue()

public int getStateValue()

Output only. The current state of the endpoint group. See https://google.aip.dev/216.

.google.cloud.networksecurity.v1.MirroringEndpointGroup.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for state.

getType()

public MirroringEndpointGroup.Type getType()

Immutable. The type of the endpoint group. If left unspecified, defaults to DIRECT.

.google.cloud.networksecurity.v1.MirroringEndpointGroup.Type type = 11 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
MirroringEndpointGroup.Type

The type.

getTypeValue()

public int getTypeValue()

Immutable. The type of the endpoint group. If left unspecified, defaults to DIRECT.

.google.cloud.networksecurity.v1.MirroringEndpointGroup.Type type = 11 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
int

The enum numeric value on the wire for type.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. The timestamp when the resource was most recently updated. See https://google.aip.dev/148#timestamps.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The timestamp when the resource was most recently updated. See https://google.aip.dev/148#timestamps.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. The timestamp when the resource was created. See https://google.aip.dev/148#timestamps.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. The timestamp when the resource was most recently updated. See https://google.aip.dev/148#timestamps.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public MirroringEndpointGroup.Builder newBuilderForType()
Returns
Type Description
MirroringEndpointGroup.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected MirroringEndpointGroup.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
MirroringEndpointGroup.Builder
Overrides

toBuilder()

public MirroringEndpointGroup.Builder toBuilder()
Returns
Type Description
MirroringEndpointGroup.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException