Class FirewallEndpoint (0.94.0)

public final class FirewallEndpoint extends GeneratedMessage implements FirewallEndpointOrBuilder

Message describing Endpoint object.

Protobuf type google.cloud.networksecurity.v1.FirewallEndpoint

Static Fields

ASSOCIATED_NETWORKS_FIELD_NUMBER

public static final int ASSOCIATED_NETWORKS_FIELD_NUMBER
Field Value
Type Description
int

ASSOCIATIONS_FIELD_NUMBER

public static final int ASSOCIATIONS_FIELD_NUMBER
Field Value
Type Description
int

BILLING_PROJECT_ID_FIELD_NUMBER

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

ENDPOINT_SETTINGS_FIELD_NUMBER

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

SATISFIES_PZI_FIELD_NUMBER

public static final int SATISFIES_PZI_FIELD_NUMBER
Field Value
Type Description
int

SATISFIES_PZS_FIELD_NUMBER

public static final int SATISFIES_PZS_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 FirewallEndpoint getDefaultInstance()
Returns
Type Description
FirewallEndpoint

getDescriptor()

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

newBuilder()

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

newBuilder(FirewallEndpoint prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

containsLabels(String key)

public boolean containsLabels(String key)

Optional. Labels as key value pairs

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

getAssociatedNetworks(int index) (deprecated)

public String getAssociatedNetworks(int index)

Deprecated. google.cloud.networksecurity.v1.FirewallEndpoint.associated_networks is deprecated. See google/cloud/networksecurity/v1/firewall_activation.proto;l=265

Output only. List of networks that are associated with this endpoint in the local zone. This is a projection of the FirewallEndpointAssociations pointing at this endpoint. A network will only appear in this list after traffic routing is fully configured. Format: projects/{project}/global/networks/{name}.

repeated string associated_networks = 7 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The associatedNetworks at the given index.

getAssociatedNetworksBytes(int index) (deprecated)

public ByteString getAssociatedNetworksBytes(int index)

Deprecated. google.cloud.networksecurity.v1.FirewallEndpoint.associated_networks is deprecated. See google/cloud/networksecurity/v1/firewall_activation.proto;l=265

Output only. List of networks that are associated with this endpoint in the local zone. This is a projection of the FirewallEndpointAssociations pointing at this endpoint. A network will only appear in this list after traffic routing is fully configured. Format: projects/{project}/global/networks/{name}.

repeated string associated_networks = 7 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the associatedNetworks at the given index.

getAssociatedNetworksCount() (deprecated)

public int getAssociatedNetworksCount()

Deprecated. google.cloud.networksecurity.v1.FirewallEndpoint.associated_networks is deprecated. See google/cloud/networksecurity/v1/firewall_activation.proto;l=265

Output only. List of networks that are associated with this endpoint in the local zone. This is a projection of the FirewallEndpointAssociations pointing at this endpoint. A network will only appear in this list after traffic routing is fully configured. Format: projects/{project}/global/networks/{name}.

repeated string associated_networks = 7 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The count of associatedNetworks.

getAssociatedNetworksList() (deprecated)

public ProtocolStringList getAssociatedNetworksList()

Deprecated. google.cloud.networksecurity.v1.FirewallEndpoint.associated_networks is deprecated. See google/cloud/networksecurity/v1/firewall_activation.proto;l=265

Output only. List of networks that are associated with this endpoint in the local zone. This is a projection of the FirewallEndpointAssociations pointing at this endpoint. A network will only appear in this list after traffic routing is fully configured. Format: projects/{project}/global/networks/{name}.

repeated string associated_networks = 7 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ProtocolStringList

A list containing the associatedNetworks.

getAssociations(int index)

public FirewallEndpoint.AssociationReference getAssociations(int index)

Output only. List of FirewallEndpointAssociations that are associated to this endpoint. An association will only appear in this list after traffic routing is fully configured.

repeated .google.cloud.networksecurity.v1.FirewallEndpoint.AssociationReference associations = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
FirewallEndpoint.AssociationReference

getAssociationsCount()

public int getAssociationsCount()

Output only. List of FirewallEndpointAssociations that are associated to this endpoint. An association will only appear in this list after traffic routing is fully configured.

repeated .google.cloud.networksecurity.v1.FirewallEndpoint.AssociationReference associations = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getAssociationsList()

public List<FirewallEndpoint.AssociationReference> getAssociationsList()

Output only. List of FirewallEndpointAssociations that are associated to this endpoint. An association will only appear in this list after traffic routing is fully configured.

repeated .google.cloud.networksecurity.v1.FirewallEndpoint.AssociationReference associations = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<AssociationReference>

getAssociationsOrBuilder(int index)

public FirewallEndpoint.AssociationReferenceOrBuilder getAssociationsOrBuilder(int index)

Output only. List of FirewallEndpointAssociations that are associated to this endpoint. An association will only appear in this list after traffic routing is fully configured.

repeated .google.cloud.networksecurity.v1.FirewallEndpoint.AssociationReference associations = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
FirewallEndpoint.AssociationReferenceOrBuilder

getAssociationsOrBuilderList()

public List<? extends FirewallEndpoint.AssociationReferenceOrBuilder> getAssociationsOrBuilderList()

Output only. List of FirewallEndpointAssociations that are associated to this endpoint. An association will only appear in this list after traffic routing is fully configured.

repeated .google.cloud.networksecurity.v1.FirewallEndpoint.AssociationReference associations = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<? extends com.google.cloud.networksecurity.v1.FirewallEndpoint.AssociationReferenceOrBuilder>

getBillingProjectId()

public String getBillingProjectId()

Optional. Project to charge for the deployed firewall endpoint. This field must be specified when creating the endpoint in the organization scope, and should be omitted otherwise.

string billing_project_id = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The billingProjectId.

getBillingProjectIdBytes()

public ByteString getBillingProjectIdBytes()

Optional. Project to charge for the deployed firewall endpoint. This field must be specified when creating the endpoint in the organization scope, and should be omitted otherwise.

string billing_project_id = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for billingProjectId.

getCreateTime()

public Timestamp getCreateTime()

Output only. Create time stamp.

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

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Create time stamp.

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

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public FirewallEndpoint getDefaultInstanceForType()
Returns
Type Description
FirewallEndpoint

getDescription()

public String getDescription()

Optional. Description of the firewall endpoint. Max length 2048 characters.

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

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Optional. Description of the firewall endpoint. Max length 2048 characters.

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

Returns
Type Description
ByteString

The bytes for description.

getEndpointSettings()

public FirewallEndpoint.EndpointSettings getEndpointSettings()

Optional. Settings for the endpoint.

.google.cloud.networksecurity.v1.FirewallEndpoint.EndpointSettings endpoint_settings = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
FirewallEndpoint.EndpointSettings

The endpointSettings.

getEndpointSettingsOrBuilder()

public FirewallEndpoint.EndpointSettingsOrBuilder getEndpointSettingsOrBuilder()

Optional. Settings for the endpoint.

.google.cloud.networksecurity.v1.FirewallEndpoint.EndpointSettings endpoint_settings = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
FirewallEndpoint.EndpointSettingsOrBuilder

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Optional. Labels as key value pairs

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

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Optional. Labels as key value pairs

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 as key value pairs

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 as key value pairs

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. Name of resource.

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Immutable. Identifier. Name of resource.

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

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

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

getReconciling()

public boolean getReconciling()

Output only. Whether reconciling is in progress, recommended per https://google.aip.dev/128.

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

Returns
Type Description
boolean

The reconciling.

getSatisfiesPzi()

public boolean getSatisfiesPzi()

Output only. [Output Only] Reserved for future use.

optional bool satisfies_pzi = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The satisfiesPzi.

getSatisfiesPzs()

public boolean getSatisfiesPzs()

Output only. [Output Only] Reserved for future use.

optional bool satisfies_pzs = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The satisfiesPzs.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getState()

public FirewallEndpoint.State getState()

Output only. Current state of the endpoint.

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

Returns
Type Description
FirewallEndpoint.State

The state.

getStateValue()

public int getStateValue()

Output only. Current state of the endpoint.

.google.cloud.networksecurity.v1.FirewallEndpoint.State state = 5 [(.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. Update time stamp

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

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Update time stamp

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

Returns
Type Description
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. Create time stamp.

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

Returns
Type Description
boolean

Whether the createTime field is set.

hasEndpointSettings()

public boolean hasEndpointSettings()

Optional. Settings for the endpoint.

.google.cloud.networksecurity.v1.FirewallEndpoint.EndpointSettings endpoint_settings = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the endpointSettings field is set.

hasSatisfiesPzi()

public boolean hasSatisfiesPzi()

Output only. [Output Only] Reserved for future use.

optional bool satisfies_pzi = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the satisfiesPzi field is set.

hasSatisfiesPzs()

public boolean hasSatisfiesPzs()

Output only. [Output Only] Reserved for future use.

optional bool satisfies_pzs = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the satisfiesPzs field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. Update time stamp

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

newBuilderForType(AbstractMessage.BuilderParent parent)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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