Class ExternalAccessRule (0.35.0)

public final class ExternalAccessRule extends GeneratedMessageV3 implements ExternalAccessRuleOrBuilder

External access firewall rules for filtering incoming traffic destined to ExternalAddress resources.

Protobuf type google.cloud.vmwareengine.v1.ExternalAccessRule

Static Fields

ACTION_FIELD_NUMBER

public static final int ACTION_FIELD_NUMBER
Field Value
TypeDescription
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
TypeDescription
int

DESTINATION_IP_RANGES_FIELD_NUMBER

public static final int DESTINATION_IP_RANGES_FIELD_NUMBER
Field Value
TypeDescription
int

DESTINATION_PORTS_FIELD_NUMBER

public static final int DESTINATION_PORTS_FIELD_NUMBER
Field Value
TypeDescription
int

IP_PROTOCOL_FIELD_NUMBER

public static final int IP_PROTOCOL_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

PRIORITY_FIELD_NUMBER

public static final int PRIORITY_FIELD_NUMBER
Field Value
TypeDescription
int

SOURCE_IP_RANGES_FIELD_NUMBER

public static final int SOURCE_IP_RANGES_FIELD_NUMBER
Field Value
TypeDescription
int

SOURCE_PORTS_FIELD_NUMBER

public static final int SOURCE_PORTS_FIELD_NUMBER
Field Value
TypeDescription
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
TypeDescription
int

UID_FIELD_NUMBER

public static final int UID_FIELD_NUMBER
Field Value
TypeDescription
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ExternalAccessRule getDefaultInstance()
Returns
TypeDescription
ExternalAccessRule

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static ExternalAccessRule.Builder newBuilder()
Returns
TypeDescription
ExternalAccessRule.Builder

newBuilder(ExternalAccessRule prototype)

public static ExternalAccessRule.Builder newBuilder(ExternalAccessRule prototype)
Parameter
NameDescription
prototypeExternalAccessRule
Returns
TypeDescription
ExternalAccessRule.Builder

parseDelimitedFrom(InputStream input)

public static ExternalAccessRule parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ExternalAccessRule
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExternalAccessRule parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExternalAccessRule
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static ExternalAccessRule parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
ExternalAccessRule
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ExternalAccessRule parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExternalAccessRule
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ExternalAccessRule parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
ExternalAccessRule
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ExternalAccessRule parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExternalAccessRule
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ExternalAccessRule parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
ExternalAccessRule
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ExternalAccessRule parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExternalAccessRule
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static ExternalAccessRule parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ExternalAccessRule
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExternalAccessRule parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExternalAccessRule
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static ExternalAccessRule parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
ExternalAccessRule
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ExternalAccessRule parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExternalAccessRule
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<ExternalAccessRule> parser()
Returns
TypeDescription
Parser<ExternalAccessRule>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getAction()

public ExternalAccessRule.Action getAction()

The action that the external access rule performs.

.google.cloud.vmwareengine.v1.ExternalAccessRule.Action action = 7;

Returns
TypeDescription
ExternalAccessRule.Action

The action.

getActionValue()

public int getActionValue()

The action that the external access rule performs.

.google.cloud.vmwareengine.v1.ExternalAccessRule.Action action = 7;

Returns
TypeDescription
int

The enum numeric value on the wire for action.

getCreateTime()

public Timestamp getCreateTime()

Output only. Creation time of this resource.

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

Returns
TypeDescription
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Creation time of this resource.

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

Returns
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

public ExternalAccessRule getDefaultInstanceForType()
Returns
TypeDescription
ExternalAccessRule

getDescription()

public String getDescription()

User-provided description for this external access rule.

string description = 5;

Returns
TypeDescription
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

User-provided description for this external access rule.

string description = 5;

Returns
TypeDescription
ByteString

The bytes for description.

getDestinationIpRanges(int index)

public ExternalAccessRule.IpRange getDestinationIpRanges(int index)

If destination ranges are specified, the external access rule applies only to the traffic that has a destination IP address in these ranges. The specified IP addresses must have reserved external IP addresses in the scope of the parent network policy. To match all external IP addresses in the scope of the parent network policy, specify 0.0.0.0/0. To match a specific external IP address, specify it using the IpRange.external_address property.

repeated .google.cloud.vmwareengine.v1.ExternalAccessRule.IpRange destination_ip_ranges = 11;

Parameter
NameDescription
indexint
Returns
TypeDescription
ExternalAccessRule.IpRange

getDestinationIpRangesCount()

public int getDestinationIpRangesCount()

If destination ranges are specified, the external access rule applies only to the traffic that has a destination IP address in these ranges. The specified IP addresses must have reserved external IP addresses in the scope of the parent network policy. To match all external IP addresses in the scope of the parent network policy, specify 0.0.0.0/0. To match a specific external IP address, specify it using the IpRange.external_address property.

repeated .google.cloud.vmwareengine.v1.ExternalAccessRule.IpRange destination_ip_ranges = 11;

Returns
TypeDescription
int

getDestinationIpRangesList()

public List<ExternalAccessRule.IpRange> getDestinationIpRangesList()

If destination ranges are specified, the external access rule applies only to the traffic that has a destination IP address in these ranges. The specified IP addresses must have reserved external IP addresses in the scope of the parent network policy. To match all external IP addresses in the scope of the parent network policy, specify 0.0.0.0/0. To match a specific external IP address, specify it using the IpRange.external_address property.

repeated .google.cloud.vmwareengine.v1.ExternalAccessRule.IpRange destination_ip_ranges = 11;

Returns
TypeDescription
List<IpRange>

getDestinationIpRangesOrBuilder(int index)

public ExternalAccessRule.IpRangeOrBuilder getDestinationIpRangesOrBuilder(int index)

If destination ranges are specified, the external access rule applies only to the traffic that has a destination IP address in these ranges. The specified IP addresses must have reserved external IP addresses in the scope of the parent network policy. To match all external IP addresses in the scope of the parent network policy, specify 0.0.0.0/0. To match a specific external IP address, specify it using the IpRange.external_address property.

repeated .google.cloud.vmwareengine.v1.ExternalAccessRule.IpRange destination_ip_ranges = 11;

Parameter
NameDescription
indexint
Returns
TypeDescription
ExternalAccessRule.IpRangeOrBuilder

getDestinationIpRangesOrBuilderList()

public List<? extends ExternalAccessRule.IpRangeOrBuilder> getDestinationIpRangesOrBuilderList()

If destination ranges are specified, the external access rule applies only to the traffic that has a destination IP address in these ranges. The specified IP addresses must have reserved external IP addresses in the scope of the parent network policy. To match all external IP addresses in the scope of the parent network policy, specify 0.0.0.0/0. To match a specific external IP address, specify it using the IpRange.external_address property.

repeated .google.cloud.vmwareengine.v1.ExternalAccessRule.IpRange destination_ip_ranges = 11;

Returns
TypeDescription
List<? extends com.google.cloud.vmwareengine.v1.ExternalAccessRule.IpRangeOrBuilder>

getDestinationPorts(int index)

public String getDestinationPorts(int index)

A list of destination ports to which the external access rule applies. This field is only applicable for the UDP or TCP protocol. Each entry must be either an integer or a range. For example: ["22"], ["80","443"], or ["12345-12349"]. To match all destination ports, specify ["0-65535"].

repeated string destination_ports = 12;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The destinationPorts at the given index.

getDestinationPortsBytes(int index)

public ByteString getDestinationPortsBytes(int index)

A list of destination ports to which the external access rule applies. This field is only applicable for the UDP or TCP protocol. Each entry must be either an integer or a range. For example: ["22"], ["80","443"], or ["12345-12349"]. To match all destination ports, specify ["0-65535"].

repeated string destination_ports = 12;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the destinationPorts at the given index.

getDestinationPortsCount()

public int getDestinationPortsCount()

A list of destination ports to which the external access rule applies. This field is only applicable for the UDP or TCP protocol. Each entry must be either an integer or a range. For example: ["22"], ["80","443"], or ["12345-12349"]. To match all destination ports, specify ["0-65535"].

repeated string destination_ports = 12;

Returns
TypeDescription
int

The count of destinationPorts.

getDestinationPortsList()

public ProtocolStringList getDestinationPortsList()

A list of destination ports to which the external access rule applies. This field is only applicable for the UDP or TCP protocol. Each entry must be either an integer or a range. For example: ["22"], ["80","443"], or ["12345-12349"]. To match all destination ports, specify ["0-65535"].

repeated string destination_ports = 12;

Returns
TypeDescription
ProtocolStringList

A list containing the destinationPorts.

getIpProtocol()

public String getIpProtocol()

The IP protocol to which the external access rule applies. This value can be one of the following three protocol strings (not case-sensitive): tcp, udp, or icmp.

string ip_protocol = 8;

Returns
TypeDescription
String

The ipProtocol.

getIpProtocolBytes()

public ByteString getIpProtocolBytes()

The IP protocol to which the external access rule applies. This value can be one of the following three protocol strings (not case-sensitive): tcp, udp, or icmp.

string ip_protocol = 8;

Returns
TypeDescription
ByteString

The bytes for ipProtocol.

getName()

public String getName()

Output only. The resource name of this external access rule. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1/networkPolicies/my-policy/externalAccessRules/my-rule

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. The resource name of this external access rule. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1/networkPolicies/my-policy/externalAccessRules/my-rule

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<ExternalAccessRule> getParserForType()
Returns
TypeDescription
Parser<ExternalAccessRule>
Overrides

getPriority()

public int getPriority()

External access rule priority, which determines the external access rule to use when multiple rules apply. If multiple rules have the same priority, their ordering is non-deterministic. If specific ordering is required, assign unique priorities to enforce such ordering. The external access rule priority is an integer from 100 to 4096, both inclusive. Lower integers indicate higher precedence. For example, a rule with priority 100 has higher precedence than a rule with priority 101.

int32 priority = 6;

Returns
TypeDescription
int

The priority.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getSourceIpRanges(int index)

public ExternalAccessRule.IpRange getSourceIpRanges(int index)

If source ranges are specified, the external access rule applies only to traffic that has a source IP address in these ranges. These ranges can either be expressed in the CIDR format or as an IP address. As only inbound rules are supported, ExternalAddress resources cannot be the source IP addresses of an external access rule. To match all source addresses, specify 0.0.0.0/0.

repeated .google.cloud.vmwareengine.v1.ExternalAccessRule.IpRange source_ip_ranges = 9;

Parameter
NameDescription
indexint
Returns
TypeDescription
ExternalAccessRule.IpRange

getSourceIpRangesCount()

public int getSourceIpRangesCount()

If source ranges are specified, the external access rule applies only to traffic that has a source IP address in these ranges. These ranges can either be expressed in the CIDR format or as an IP address. As only inbound rules are supported, ExternalAddress resources cannot be the source IP addresses of an external access rule. To match all source addresses, specify 0.0.0.0/0.

repeated .google.cloud.vmwareengine.v1.ExternalAccessRule.IpRange source_ip_ranges = 9;

Returns
TypeDescription
int

getSourceIpRangesList()

public List<ExternalAccessRule.IpRange> getSourceIpRangesList()

If source ranges are specified, the external access rule applies only to traffic that has a source IP address in these ranges. These ranges can either be expressed in the CIDR format or as an IP address. As only inbound rules are supported, ExternalAddress resources cannot be the source IP addresses of an external access rule. To match all source addresses, specify 0.0.0.0/0.

repeated .google.cloud.vmwareengine.v1.ExternalAccessRule.IpRange source_ip_ranges = 9;

Returns
TypeDescription
List<IpRange>

getSourceIpRangesOrBuilder(int index)

public ExternalAccessRule.IpRangeOrBuilder getSourceIpRangesOrBuilder(int index)

If source ranges are specified, the external access rule applies only to traffic that has a source IP address in these ranges. These ranges can either be expressed in the CIDR format or as an IP address. As only inbound rules are supported, ExternalAddress resources cannot be the source IP addresses of an external access rule. To match all source addresses, specify 0.0.0.0/0.

repeated .google.cloud.vmwareengine.v1.ExternalAccessRule.IpRange source_ip_ranges = 9;

Parameter
NameDescription
indexint
Returns
TypeDescription
ExternalAccessRule.IpRangeOrBuilder

getSourceIpRangesOrBuilderList()

public List<? extends ExternalAccessRule.IpRangeOrBuilder> getSourceIpRangesOrBuilderList()

If source ranges are specified, the external access rule applies only to traffic that has a source IP address in these ranges. These ranges can either be expressed in the CIDR format or as an IP address. As only inbound rules are supported, ExternalAddress resources cannot be the source IP addresses of an external access rule. To match all source addresses, specify 0.0.0.0/0.

repeated .google.cloud.vmwareengine.v1.ExternalAccessRule.IpRange source_ip_ranges = 9;

Returns
TypeDescription
List<? extends com.google.cloud.vmwareengine.v1.ExternalAccessRule.IpRangeOrBuilder>

getSourcePorts(int index)

public String getSourcePorts(int index)

A list of source ports to which the external access rule applies. This field is only applicable for the UDP or TCP protocol. Each entry must be either an integer or a range. For example: ["22"], ["80","443"], or ["12345-12349"]. To match all source ports, specify ["0-65535"].

repeated string source_ports = 10;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The sourcePorts at the given index.

getSourcePortsBytes(int index)

public ByteString getSourcePortsBytes(int index)

A list of source ports to which the external access rule applies. This field is only applicable for the UDP or TCP protocol. Each entry must be either an integer or a range. For example: ["22"], ["80","443"], or ["12345-12349"]. To match all source ports, specify ["0-65535"].

repeated string source_ports = 10;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the sourcePorts at the given index.

getSourcePortsCount()

public int getSourcePortsCount()

A list of source ports to which the external access rule applies. This field is only applicable for the UDP or TCP protocol. Each entry must be either an integer or a range. For example: ["22"], ["80","443"], or ["12345-12349"]. To match all source ports, specify ["0-65535"].

repeated string source_ports = 10;

Returns
TypeDescription
int

The count of sourcePorts.

getSourcePortsList()

public ProtocolStringList getSourcePortsList()

A list of source ports to which the external access rule applies. This field is only applicable for the UDP or TCP protocol. Each entry must be either an integer or a range. For example: ["22"], ["80","443"], or ["12345-12349"]. To match all source ports, specify ["0-65535"].

repeated string source_ports = 10;

Returns
TypeDescription
ProtocolStringList

A list containing the sourcePorts.

getState()

public ExternalAccessRule.State getState()

Output only. The state of the resource.

.google.cloud.vmwareengine.v1.ExternalAccessRule.State state = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
ExternalAccessRule.State

The state.

getStateValue()

public int getStateValue()

Output only. The state of the resource.

.google.cloud.vmwareengine.v1.ExternalAccessRule.State state = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
int

The enum numeric value on the wire for state.

getUid()

public String getUid()

Output only. System-generated unique identifier for the resource.

string uid = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
String

The uid.

getUidBytes()

public ByteString getUidBytes()

Output only. System-generated unique identifier for the resource.

string uid = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
ByteString

The bytes for uid.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. Last update time of this resource.

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

Returns
TypeDescription
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Last update time of this resource.

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

Returns
TypeDescription
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. Creation time of this resource.

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

Returns
TypeDescription
boolean

Whether the createTime field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. Last update time of this resource.

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

Returns
TypeDescription
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public ExternalAccessRule.Builder newBuilderForType()
Returns
TypeDescription
ExternalAccessRule.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ExternalAccessRule.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
ExternalAccessRule.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public ExternalAccessRule.Builder toBuilder()
Returns
TypeDescription
ExternalAccessRule.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException