Class Network (1.11.0)

public final class Network extends GeneratedMessageV3 implements NetworkOrBuilder

Represents a VPC Network resource. Networks connect resources to each other and to the internet. For more information, read Virtual Private Cloud (VPC) Network.

Protobuf type google.cloud.compute.v1.Network

Implements

NetworkOrBuilder

Static Fields

AUTO_CREATE_SUBNETWORKS_FIELD_NUMBER

public static final int AUTO_CREATE_SUBNETWORKS_FIELD_NUMBER
Field Value
TypeDescription
int

CREATION_TIMESTAMP_FIELD_NUMBER

public static final int CREATION_TIMESTAMP_FIELD_NUMBER
Field Value
TypeDescription
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
TypeDescription
int

ENABLE_ULA_INTERNAL_IPV6_FIELD_NUMBER

public static final int ENABLE_ULA_INTERNAL_IPV6_FIELD_NUMBER
Field Value
TypeDescription
int

GATEWAY_I_PV4_FIELD_NUMBER

public static final int GATEWAY_I_PV4_FIELD_NUMBER
Field Value
TypeDescription
int

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER
Field Value
TypeDescription
int

INTERNAL_IPV6_RANGE_FIELD_NUMBER

public static final int INTERNAL_IPV6_RANGE_FIELD_NUMBER
Field Value
TypeDescription
int

I_PV4_RANGE_FIELD_NUMBER

public static final int I_PV4_RANGE_FIELD_NUMBER
Field Value
TypeDescription
int

KIND_FIELD_NUMBER

public static final int KIND_FIELD_NUMBER
Field Value
TypeDescription
int

MTU_FIELD_NUMBER

public static final int MTU_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

NETWORK_FIREWALL_POLICY_ENFORCEMENT_ORDER_FIELD_NUMBER

public static final int NETWORK_FIREWALL_POLICY_ENFORCEMENT_ORDER_FIELD_NUMBER
Field Value
TypeDescription
int

PEERINGS_FIELD_NUMBER

public static final int PEERINGS_FIELD_NUMBER
Field Value
TypeDescription
int

ROUTING_CONFIG_FIELD_NUMBER

public static final int ROUTING_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int
public static final int SELF_LINK_FIELD_NUMBER
Field Value
TypeDescription
int
public static final int SELF_LINK_WITH_ID_FIELD_NUMBER
Field Value
TypeDescription
int

SUBNETWORKS_FIELD_NUMBER

public static final int SUBNETWORKS_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Network getDefaultInstance()
Returns
TypeDescription
Network

getDescriptor()

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

newBuilder()

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

newBuilder(Network prototype)

public static Network.Builder newBuilder(Network prototype)
Parameter
NameDescription
prototypeNetwork
Returns
TypeDescription
Network.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getAutoCreateSubnetworks()

public boolean getAutoCreateSubnetworks()

Must be set to create a VPC network. If not set, a legacy network is created. When set to true, the VPC network is created in auto mode. When set to false, the VPC network is created in custom mode. An auto mode VPC network starts with one subnet per region. Each subnet has a predetermined range as described in Auto mode VPC network IP ranges. For custom mode VPC networks, you can add subnets using the subnetworks insert method.

optional bool auto_create_subnetworks = 256156690;

Returns
TypeDescription
boolean

The autoCreateSubnetworks.

getCreationTimestamp()

public String getCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
TypeDescription
String

The creationTimestamp.

getCreationTimestampBytes()

public ByteString getCreationTimestampBytes()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
TypeDescription
ByteString

The bytes for creationTimestamp.

getDefaultInstanceForType()

public Network getDefaultInstanceForType()
Returns
TypeDescription
Network

getDescription()

public String getDescription()

An optional description of this resource. Provide this field when you create the resource.

optional string description = 422937596;

Returns
TypeDescription
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

An optional description of this resource. Provide this field when you create the resource.

optional string description = 422937596;

Returns
TypeDescription
ByteString

The bytes for description.

getEnableUlaInternalIpv6()

public boolean getEnableUlaInternalIpv6()

Enable ULA internal ipv6 on this network. Enabling this feature will assign a /48 from google defined ULA prefix fd20::/20. .

optional bool enable_ula_internal_ipv6 = 423757720;

Returns
TypeDescription
boolean

The enableUlaInternalIpv6.

getGatewayIPv4()

public String getGatewayIPv4()

[Output Only] The gateway address for default routing out of the network, selected by GCP.

optional string gateway_i_pv4 = 178678877;

Returns
TypeDescription
String

The gatewayIPv4.

getGatewayIPv4Bytes()

public ByteString getGatewayIPv4Bytes()

[Output Only] The gateway address for default routing out of the network, selected by GCP.

optional string gateway_i_pv4 = 178678877;

Returns
TypeDescription
ByteString

The bytes for gatewayIPv4.

getIPv4Range()

public String getIPv4Range()

Deprecated in favor of subnet mode networks. The range of internal addresses that are legal on this network. This range is a CIDR specification, for example: 192.168.0.0/16. Provided by the client when the network is created.

optional string I_pv4_range = 59234358;

Returns
TypeDescription
String

The iPv4Range.

getIPv4RangeBytes()

public ByteString getIPv4RangeBytes()

Deprecated in favor of subnet mode networks. The range of internal addresses that are legal on this network. This range is a CIDR specification, for example: 192.168.0.0/16. Provided by the client when the network is created.

optional string I_pv4_range = 59234358;

Returns
TypeDescription
ByteString

The bytes for iPv4Range.

getId()

public long getId()

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

optional uint64 id = 3355;

Returns
TypeDescription
long

The id.

getInternalIpv6Range()

public String getInternalIpv6Range()

When enabling ula internal ipv6, caller optionally can specify the /48 range they want from the google defined ULA prefix fd20::/20. The input must be a valid /48 ULA IPv6 address and must be within the fd20::/20. Operation will fail if the speficied /48 is already in used by another resource. If the field is not speficied, then a /48 range will be randomly allocated from fd20::/20 and returned via this field. .

optional string internal_ipv6_range = 277456807;

Returns
TypeDescription
String

The internalIpv6Range.

getInternalIpv6RangeBytes()

public ByteString getInternalIpv6RangeBytes()

When enabling ula internal ipv6, caller optionally can specify the /48 range they want from the google defined ULA prefix fd20::/20. The input must be a valid /48 ULA IPv6 address and must be within the fd20::/20. Operation will fail if the speficied /48 is already in used by another resource. If the field is not speficied, then a /48 range will be randomly allocated from fd20::/20 and returned via this field. .

optional string internal_ipv6_range = 277456807;

Returns
TypeDescription
ByteString

The bytes for internalIpv6Range.

getKind()

public String getKind()

[Output Only] Type of the resource. Always compute#network for networks.

optional string kind = 3292052;

Returns
TypeDescription
String

The kind.

getKindBytes()

public ByteString getKindBytes()

[Output Only] Type of the resource. Always compute#network for networks.

optional string kind = 3292052;

Returns
TypeDescription
ByteString

The bytes for kind.

getMtu()

public int getMtu()

Maximum Transmission Unit in bytes. The minimum value for this field is 1460 and the maximum value is 1500 bytes. If unspecified, defaults to 1460.

optional int32 mtu = 108462;

Returns
TypeDescription
int

The mtu.

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?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.

optional string name = 3373707;

Returns
TypeDescription
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?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.

optional string name = 3373707;

Returns
TypeDescription
ByteString

The bytes for name.

getNetworkFirewallPolicyEnforcementOrder()

public String getNetworkFirewallPolicyEnforcementOrder()

The network firewall policy enforcement order. Can be either AFTER_CLASSIC_FIREWALL or BEFORE_CLASSIC_FIREWALL. Defaults to AFTER_CLASSIC_FIREWALL if the field is not specified. Check the NetworkFirewallPolicyEnforcementOrder enum for the list of possible values.

optional string network_firewall_policy_enforcement_order = 6504784;

Returns
TypeDescription
String

The networkFirewallPolicyEnforcementOrder.

getNetworkFirewallPolicyEnforcementOrderBytes()

public ByteString getNetworkFirewallPolicyEnforcementOrderBytes()

The network firewall policy enforcement order. Can be either AFTER_CLASSIC_FIREWALL or BEFORE_CLASSIC_FIREWALL. Defaults to AFTER_CLASSIC_FIREWALL if the field is not specified. Check the NetworkFirewallPolicyEnforcementOrder enum for the list of possible values.

optional string network_firewall_policy_enforcement_order = 6504784;

Returns
TypeDescription
ByteString

The bytes for networkFirewallPolicyEnforcementOrder.

getParserForType()

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

getPeerings(int index)

public NetworkPeering getPeerings(int index)

[Output Only] A list of network peerings for the resource.

repeated .google.cloud.compute.v1.NetworkPeering peerings = 69883187;

Parameter
NameDescription
indexint
Returns
TypeDescription
NetworkPeering

getPeeringsCount()

public int getPeeringsCount()

[Output Only] A list of network peerings for the resource.

repeated .google.cloud.compute.v1.NetworkPeering peerings = 69883187;

Returns
TypeDescription
int

getPeeringsList()

public List<NetworkPeering> getPeeringsList()

[Output Only] A list of network peerings for the resource.

repeated .google.cloud.compute.v1.NetworkPeering peerings = 69883187;

Returns
TypeDescription
List<NetworkPeering>

getPeeringsOrBuilder(int index)

public NetworkPeeringOrBuilder getPeeringsOrBuilder(int index)

[Output Only] A list of network peerings for the resource.

repeated .google.cloud.compute.v1.NetworkPeering peerings = 69883187;

Parameter
NameDescription
indexint
Returns
TypeDescription
NetworkPeeringOrBuilder

getPeeringsOrBuilderList()

public List<? extends NetworkPeeringOrBuilder> getPeeringsOrBuilderList()

[Output Only] A list of network peerings for the resource.

repeated .google.cloud.compute.v1.NetworkPeering peerings = 69883187;

Returns
TypeDescription
List<? extends com.google.cloud.compute.v1.NetworkPeeringOrBuilder>

getRoutingConfig()

public NetworkRoutingConfig getRoutingConfig()

The network-level routing configuration for this network. Used by Cloud Router to determine what type of network-wide routing behavior to enforce.

optional .google.cloud.compute.v1.NetworkRoutingConfig routing_config = 523556059;

Returns
TypeDescription
NetworkRoutingConfig

The routingConfig.

getRoutingConfigOrBuilder()

public NetworkRoutingConfigOrBuilder getRoutingConfigOrBuilder()

The network-level routing configuration for this network. Used by Cloud Router to determine what type of network-wide routing behavior to enforce.

optional .google.cloud.compute.v1.NetworkRoutingConfig routing_config = 523556059;

Returns
TypeDescription
NetworkRoutingConfigOrBuilder
public String getSelfLink()

[Output Only] Server-defined URL for the resource.

optional string self_link = 456214797;

Returns
TypeDescription
String

The selfLink.

getSelfLinkBytes()

public ByteString getSelfLinkBytes()

[Output Only] Server-defined URL for the resource.

optional string self_link = 456214797;

Returns
TypeDescription
ByteString

The bytes for selfLink.

getSelfLinkWithId()

public String getSelfLinkWithId()

[Output Only] Server-defined URL for this resource with the resource id.

optional string self_link_with_id = 44520962;

Returns
TypeDescription
String

The selfLinkWithId.

getSelfLinkWithIdBytes()

public ByteString getSelfLinkWithIdBytes()

[Output Only] Server-defined URL for this resource with the resource id.

optional string self_link_with_id = 44520962;

Returns
TypeDescription
ByteString

The bytes for selfLinkWithId.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getSubnetworks(int index)

public String getSubnetworks(int index)

[Output Only] Server-defined fully-qualified URLs for all subnetworks in this VPC network.

repeated string subnetworks = 415853125;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The subnetworks at the given index.

getSubnetworksBytes(int index)

public ByteString getSubnetworksBytes(int index)

[Output Only] Server-defined fully-qualified URLs for all subnetworks in this VPC network.

repeated string subnetworks = 415853125;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the subnetworks at the given index.

getSubnetworksCount()

public int getSubnetworksCount()

[Output Only] Server-defined fully-qualified URLs for all subnetworks in this VPC network.

repeated string subnetworks = 415853125;

Returns
TypeDescription
int

The count of subnetworks.

getSubnetworksList()

public ProtocolStringList getSubnetworksList()

[Output Only] Server-defined fully-qualified URLs for all subnetworks in this VPC network.

repeated string subnetworks = 415853125;

Returns
TypeDescription
ProtocolStringList

A list containing the subnetworks.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hasAutoCreateSubnetworks()

public boolean hasAutoCreateSubnetworks()

Must be set to create a VPC network. If not set, a legacy network is created. When set to true, the VPC network is created in auto mode. When set to false, the VPC network is created in custom mode. An auto mode VPC network starts with one subnet per region. Each subnet has a predetermined range as described in Auto mode VPC network IP ranges. For custom mode VPC networks, you can add subnets using the subnetworks insert method.

optional bool auto_create_subnetworks = 256156690;

Returns
TypeDescription
boolean

Whether the autoCreateSubnetworks field is set.

hasCreationTimestamp()

public boolean hasCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
TypeDescription
boolean

Whether the creationTimestamp field is set.

hasDescription()

public boolean hasDescription()

An optional description of this resource. Provide this field when you create the resource.

optional string description = 422937596;

Returns
TypeDescription
boolean

Whether the description field is set.

hasEnableUlaInternalIpv6()

public boolean hasEnableUlaInternalIpv6()

Enable ULA internal ipv6 on this network. Enabling this feature will assign a /48 from google defined ULA prefix fd20::/20. .

optional bool enable_ula_internal_ipv6 = 423757720;

Returns
TypeDescription
boolean

Whether the enableUlaInternalIpv6 field is set.

hasGatewayIPv4()

public boolean hasGatewayIPv4()

[Output Only] The gateway address for default routing out of the network, selected by GCP.

optional string gateway_i_pv4 = 178678877;

Returns
TypeDescription
boolean

Whether the gatewayIPv4 field is set.

hasIPv4Range()

public boolean hasIPv4Range()

Deprecated in favor of subnet mode networks. The range of internal addresses that are legal on this network. This range is a CIDR specification, for example: 192.168.0.0/16. Provided by the client when the network is created.

optional string I_pv4_range = 59234358;

Returns
TypeDescription
boolean

Whether the iPv4Range 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
TypeDescription
boolean

Whether the id field is set.

hasInternalIpv6Range()

public boolean hasInternalIpv6Range()

When enabling ula internal ipv6, caller optionally can specify the /48 range they want from the google defined ULA prefix fd20::/20. The input must be a valid /48 ULA IPv6 address and must be within the fd20::/20. Operation will fail if the speficied /48 is already in used by another resource. If the field is not speficied, then a /48 range will be randomly allocated from fd20::/20 and returned via this field. .

optional string internal_ipv6_range = 277456807;

Returns
TypeDescription
boolean

Whether the internalIpv6Range field is set.

hasKind()

public boolean hasKind()

[Output Only] Type of the resource. Always compute#network for networks.

optional string kind = 3292052;

Returns
TypeDescription
boolean

Whether the kind field is set.

hasMtu()

public boolean hasMtu()

Maximum Transmission Unit in bytes. The minimum value for this field is 1460 and the maximum value is 1500 bytes. If unspecified, defaults to 1460.

optional int32 mtu = 108462;

Returns
TypeDescription
boolean

Whether the mtu 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?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.

optional string name = 3373707;

Returns
TypeDescription
boolean

Whether the name field is set.

hasNetworkFirewallPolicyEnforcementOrder()

public boolean hasNetworkFirewallPolicyEnforcementOrder()

The network firewall policy enforcement order. Can be either AFTER_CLASSIC_FIREWALL or BEFORE_CLASSIC_FIREWALL. Defaults to AFTER_CLASSIC_FIREWALL if the field is not specified. Check the NetworkFirewallPolicyEnforcementOrder enum for the list of possible values.

optional string network_firewall_policy_enforcement_order = 6504784;

Returns
TypeDescription
boolean

Whether the networkFirewallPolicyEnforcementOrder field is set.

hasRoutingConfig()

public boolean hasRoutingConfig()

The network-level routing configuration for this network. Used by Cloud Router to determine what type of network-wide routing behavior to enforce.

optional .google.cloud.compute.v1.NetworkRoutingConfig routing_config = 523556059;

Returns
TypeDescription
boolean

Whether the routingConfig field is set.

public boolean hasSelfLink()

[Output Only] Server-defined URL for the resource.

optional string self_link = 456214797;

Returns
TypeDescription
boolean

Whether the selfLink field is set.

hasSelfLinkWithId()

public boolean hasSelfLinkWithId()

[Output Only] Server-defined URL for this resource with the resource id.

optional string self_link_with_id = 44520962;

Returns
TypeDescription
boolean

Whether the selfLinkWithId 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 Network.Builder newBuilderForType()
Returns
TypeDescription
Network.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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