Class InterceptEndpointGroup (0.94.0)

public final class InterceptEndpointGroup extends GeneratedMessage implements InterceptEndpointGroupOrBuilder

An endpoint group is a consumer frontend for a deployment group (backend). In order to configure intercept 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 firewall rule that references the security profile (group).

Protobuf type google.cloud.networksecurity.v1.InterceptEndpointGroup

Static Fields

ASSOCIATIONS_FIELD_NUMBER

public static final int ASSOCIATIONS_FIELD_NUMBER
Field Value
Type Description
int

CONNECTED_DEPLOYMENT_GROUP_FIELD_NUMBER

public static final int CONNECTED_DEPLOYMENT_GROUP_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

INTERCEPT_DEPLOYMENT_GROUP_FIELD_NUMBER

public static final int INTERCEPT_DEPLOYMENT_GROUP_FIELD_NUMBER
Field Value
Type Description
int

LABELS_FIELD_NUMBER

public static final int LABELS_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

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static InterceptEndpointGroup getDefaultInstance()
Returns
Type Description
InterceptEndpointGroup

getDescriptor()

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

newBuilder()

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

newBuilder(InterceptEndpointGroup prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

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 InterceptEndpointGroup.AssociationDetails getAssociations(int index)

Output only. List of associations to this endpoint group.

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

Parameter
Name Description
index int
Returns
Type Description
InterceptEndpointGroup.AssociationDetails

getAssociationsCount()

public int getAssociationsCount()

Output only. List of associations to this endpoint group.

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

Returns
Type Description
int

getAssociationsList()

public List<InterceptEndpointGroup.AssociationDetails> getAssociationsList()

Output only. List of associations to this endpoint group.

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

Returns
Type Description
List<AssociationDetails>

getAssociationsOrBuilder(int index)

public InterceptEndpointGroup.AssociationDetailsOrBuilder getAssociationsOrBuilder(int index)

Output only. List of associations to this endpoint group.

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

Parameter
Name Description
index int
Returns
Type Description
InterceptEndpointGroup.AssociationDetailsOrBuilder

getAssociationsOrBuilderList()

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

Output only. List of associations to this endpoint group.

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

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

getConnectedDeploymentGroup()

public InterceptEndpointGroup.ConnectedDeploymentGroup getConnectedDeploymentGroup()

Output only. Details about the connected deployment group to this endpoint group.

.google.cloud.networksecurity.v1.InterceptEndpointGroup.ConnectedDeploymentGroup connected_deployment_group = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
InterceptEndpointGroup.ConnectedDeploymentGroup

The connectedDeploymentGroup.

getConnectedDeploymentGroupOrBuilder()

public InterceptEndpointGroup.ConnectedDeploymentGroupOrBuilder getConnectedDeploymentGroupOrBuilder()

Output only. Details about the connected deployment group to this endpoint group.

.google.cloud.networksecurity.v1.InterceptEndpointGroup.ConnectedDeploymentGroup connected_deployment_group = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
InterceptEndpointGroup.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 InterceptEndpointGroup getDefaultInstanceForType()
Returns
Type Description
InterceptEndpointGroup

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.

getInterceptDeploymentGroup()

public String getInterceptDeploymentGroup()

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

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

Returns
Type Description
String

The interceptDeploymentGroup.

getInterceptDeploymentGroupBytes()

public ByteString getInterceptDeploymentGroupBytes()

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

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

Returns
Type Description
ByteString

The bytes for interceptDeploymentGroup.

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

getName()

public String getName()

Immutable. Identifier. The resource name of this endpoint group, for example: projects/123456789/locations/global/interceptEndpointGroups/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/interceptEndpointGroups/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<InterceptEndpointGroup> getParserForType()
Returns
Type Description
Parser<InterceptEndpointGroup>
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 InterceptEndpointGroup.State getState()

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

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

Returns
Type Description
InterceptEndpointGroup.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.InterceptEndpointGroup.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for state.

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

hasConnectedDeploymentGroup()

public boolean hasConnectedDeploymentGroup()

Output only. Details about the connected deployment group to this endpoint group.

.google.cloud.networksecurity.v1.InterceptEndpointGroup.ConnectedDeploymentGroup connected_deployment_group = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the connectedDeploymentGroup field is set.

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 InterceptEndpointGroup.Builder newBuilderForType()
Returns
Type Description
InterceptEndpointGroup.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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