public final class Router extends GeneratedMessageV3 implements RouterOrBuilder
Represents a Cloud Router resource. For more information about Cloud Router, read the Cloud Router overview.
Protobuf type google.cloud.compute.v1.Router
Static Fields
BGP_FIELD_NUMBER
public static final int BGP_FIELD_NUMBER
Field Value
BGP_PEERS_FIELD_NUMBER
public static final int BGP_PEERS_FIELD_NUMBER
Field Value
CREATION_TIMESTAMP_FIELD_NUMBER
public static final int CREATION_TIMESTAMP_FIELD_NUMBER
Field Value
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
Field Value
ENCRYPTED_INTERCONNECT_ROUTER_FIELD_NUMBER
public static final int ENCRYPTED_INTERCONNECT_ROUTER_FIELD_NUMBER
Field Value
ID_FIELD_NUMBER
public static final int ID_FIELD_NUMBER
Field Value
INTERFACES_FIELD_NUMBER
public static final int INTERFACES_FIELD_NUMBER
Field Value
KIND_FIELD_NUMBER
public static final int KIND_FIELD_NUMBER
Field Value
MD5_AUTHENTICATION_KEYS_FIELD_NUMBER
public static final int MD5_AUTHENTICATION_KEYS_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
NATS_FIELD_NUMBER
public static final int NATS_FIELD_NUMBER
Field Value
NETWORK_FIELD_NUMBER
public static final int NETWORK_FIELD_NUMBER
Field Value
REGION_FIELD_NUMBER
public static final int REGION_FIELD_NUMBER
Field Value
SELF_LINK_FIELD_NUMBER
public static final int SELF_LINK_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static Router getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static Router.Builder newBuilder()
Returns
newBuilder(Router prototype)
public static Router.Builder newBuilder(Router prototype)
Parameter
| Name |
Description |
| prototype |
Router
|
Returns
public static Router parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static Router parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static Router parseFrom(byte[] data)
Parameter
| Name |
Description |
| data |
byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Router parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static Router parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Router parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Router parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static Router parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Router parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static Router parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static Router parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Router parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<Router> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getBgp()
public RouterBgp getBgp()
BGP information specific to this router.
optional .google.cloud.compute.v1.RouterBgp bgp = 97483;
getBgpOrBuilder()
public RouterBgpOrBuilder getBgpOrBuilder()
BGP information specific to this router.
optional .google.cloud.compute.v1.RouterBgp bgp = 97483;
getBgpPeers(int index)
public RouterBgpPeer getBgpPeers(int index)
BGP information that must be configured into the routing stack to establish BGP peering. This information must specify the peer ASN and either the interface name, IP address, or peer IP address. Please refer to RFC4273.
repeated .google.cloud.compute.v1.RouterBgpPeer bgp_peers = 452695773;
| Name |
Description |
| index |
int
|
Returns
getBgpPeersCount()
public int getBgpPeersCount()
BGP information that must be configured into the routing stack to establish BGP peering. This information must specify the peer ASN and either the interface name, IP address, or peer IP address. Please refer to RFC4273.
repeated .google.cloud.compute.v1.RouterBgpPeer bgp_peers = 452695773;
getBgpPeersList()
public List<RouterBgpPeer> getBgpPeersList()
BGP information that must be configured into the routing stack to establish BGP peering. This information must specify the peer ASN and either the interface name, IP address, or peer IP address. Please refer to RFC4273.
repeated .google.cloud.compute.v1.RouterBgpPeer bgp_peers = 452695773;
getBgpPeersOrBuilder(int index)
public RouterBgpPeerOrBuilder getBgpPeersOrBuilder(int index)
BGP information that must be configured into the routing stack to establish BGP peering. This information must specify the peer ASN and either the interface name, IP address, or peer IP address. Please refer to RFC4273.
repeated .google.cloud.compute.v1.RouterBgpPeer bgp_peers = 452695773;
| Name |
Description |
| index |
int
|
Returns
getBgpPeersOrBuilderList()
public List<? extends RouterBgpPeerOrBuilder> getBgpPeersOrBuilderList()
BGP information that must be configured into the routing stack to establish BGP peering. This information must specify the peer ASN and either the interface name, IP address, or peer IP address. Please refer to RFC4273.
repeated .google.cloud.compute.v1.RouterBgpPeer bgp_peers = 452695773;
| Type |
Description |
| List<? extends com.google.cloud.compute.v1.RouterBgpPeerOrBuilder> |
|
getCreationTimestamp()
public String getCreationTimestamp()
[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;
| Type |
Description |
| String |
The creationTimestamp.
|
getCreationTimestampBytes()
public ByteString getCreationTimestampBytes()
[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;
| Type |
Description |
| ByteString |
The bytes for creationTimestamp.
|
getDefaultInstanceForType()
public Router getDefaultInstanceForType()
Returns
getDescription()
public String getDescription()
An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;
| Type |
Description |
| String |
The description.
|
getDescriptionBytes()
public ByteString getDescriptionBytes()
An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;
| Type |
Description |
| ByteString |
The bytes for description.
|
getEncryptedInterconnectRouter()
public boolean getEncryptedInterconnectRouter()
Indicates if a router is dedicated for use with encrypted VLAN attachments (interconnectAttachments).
optional bool encrypted_interconnect_router = 297996575;
| Type |
Description |
| boolean |
The encryptedInterconnectRouter.
|
getId()
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
optional uint64 id = 3355;
| Type |
Description |
| long |
The id.
|
getInterfaces(int index)
public RouterInterface getInterfaces(int index)
Router interfaces. Each interface requires either one linked resource, (for example, linkedVpnTunnel), or IP address and IP address range (for example, ipRange), or both.
repeated .google.cloud.compute.v1.RouterInterface interfaces = 12073562;
| Name |
Description |
| index |
int
|
Returns
getInterfacesCount()
public int getInterfacesCount()
Router interfaces. Each interface requires either one linked resource, (for example, linkedVpnTunnel), or IP address and IP address range (for example, ipRange), or both.
repeated .google.cloud.compute.v1.RouterInterface interfaces = 12073562;
getInterfacesList()
public List<RouterInterface> getInterfacesList()
Router interfaces. Each interface requires either one linked resource, (for example, linkedVpnTunnel), or IP address and IP address range (for example, ipRange), or both.
repeated .google.cloud.compute.v1.RouterInterface interfaces = 12073562;
getInterfacesOrBuilder(int index)
public RouterInterfaceOrBuilder getInterfacesOrBuilder(int index)
Router interfaces. Each interface requires either one linked resource, (for example, linkedVpnTunnel), or IP address and IP address range (for example, ipRange), or both.
repeated .google.cloud.compute.v1.RouterInterface interfaces = 12073562;
| Name |
Description |
| index |
int
|
Returns
getInterfacesOrBuilderList()
public List<? extends RouterInterfaceOrBuilder> getInterfacesOrBuilderList()
Router interfaces. Each interface requires either one linked resource, (for example, linkedVpnTunnel), or IP address and IP address range (for example, ipRange), or both.
repeated .google.cloud.compute.v1.RouterInterface interfaces = 12073562;
| Type |
Description |
| List<? extends com.google.cloud.compute.v1.RouterInterfaceOrBuilder> |
|
getKind()
[Output Only] Type of resource. Always compute#router for routers.
optional string kind = 3292052;
| Type |
Description |
| String |
The kind.
|
getKindBytes()
public ByteString getKindBytes()
[Output Only] Type of resource. Always compute#router for routers.
optional string kind = 3292052;
getMd5AuthenticationKeys(int index)
public RouterMd5AuthenticationKey getMd5AuthenticationKeys(int index)
Keys used for MD5 authentication.
repeated .google.cloud.compute.v1.RouterMd5AuthenticationKey md5_authentication_keys = 71063322;
| Name |
Description |
| index |
int
|
Returns
getMd5AuthenticationKeysCount()
public int getMd5AuthenticationKeysCount()
Keys used for MD5 authentication.
repeated .google.cloud.compute.v1.RouterMd5AuthenticationKey md5_authentication_keys = 71063322;
getMd5AuthenticationKeysList()
public List<RouterMd5AuthenticationKey> getMd5AuthenticationKeysList()
Keys used for MD5 authentication.
repeated .google.cloud.compute.v1.RouterMd5AuthenticationKey md5_authentication_keys = 71063322;
getMd5AuthenticationKeysOrBuilder(int index)
public RouterMd5AuthenticationKeyOrBuilder getMd5AuthenticationKeysOrBuilder(int index)
Keys used for MD5 authentication.
repeated .google.cloud.compute.v1.RouterMd5AuthenticationKey md5_authentication_keys = 71063322;
| Name |
Description |
| index |
int
|
Returns
getMd5AuthenticationKeysOrBuilderList()
public List<? extends RouterMd5AuthenticationKeyOrBuilder> getMd5AuthenticationKeysOrBuilderList()
Keys used for MD5 authentication.
repeated .google.cloud.compute.v1.RouterMd5AuthenticationKey md5_authentication_keys = 71063322;
| Type |
Description |
| List<? extends com.google.cloud.compute.v1.RouterMd5AuthenticationKeyOrBuilder> |
|
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? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
optional string name = 3373707;
| Type |
Description |
| 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? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
optional string name = 3373707;
getNats(int index)
public RouterNat getNats(int index)
A list of NAT services created in this router.
repeated .google.cloud.compute.v1.RouterNat nats = 3373938;
| Name |
Description |
| index |
int
|
Returns
getNatsCount()
public int getNatsCount()
A list of NAT services created in this router.
repeated .google.cloud.compute.v1.RouterNat nats = 3373938;
getNatsList()
public List<RouterNat> getNatsList()
A list of NAT services created in this router.
repeated .google.cloud.compute.v1.RouterNat nats = 3373938;
getNatsOrBuilder(int index)
public RouterNatOrBuilder getNatsOrBuilder(int index)
A list of NAT services created in this router.
repeated .google.cloud.compute.v1.RouterNat nats = 3373938;
| Name |
Description |
| index |
int
|
Returns
getNatsOrBuilderList()
public List<? extends RouterNatOrBuilder> getNatsOrBuilderList()
A list of NAT services created in this router.
repeated .google.cloud.compute.v1.RouterNat nats = 3373938;
| Type |
Description |
| List<? extends com.google.cloud.compute.v1.RouterNatOrBuilder> |
|
getNetwork()
public String getNetwork()
URI of the network to which this router belongs.
optional string network = 232872494;
| Type |
Description |
| String |
The network.
|
getNetworkBytes()
public ByteString getNetworkBytes()
URI of the network to which this router belongs.
optional string network = 232872494;
| Type |
Description |
| ByteString |
The bytes for network.
|
getParserForType()
public Parser<Router> getParserForType()
Returns
Overrides
getRegion()
public String getRegion()
[Output Only] URI of the region where the router resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
optional string region = 138946292;
| Type |
Description |
| String |
The region.
|
getRegionBytes()
public ByteString getRegionBytes()
[Output Only] URI of the region where the router resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
optional string region = 138946292;
getSelfLink()
public String getSelfLink()
[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;
| Type |
Description |
| String |
The selfLink.
|
getSelfLinkBytes()
public ByteString getSelfLinkBytes()
[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;
| Type |
Description |
| ByteString |
The bytes for selfLink.
|
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hasBgp()
BGP information specific to this router.
optional .google.cloud.compute.v1.RouterBgp bgp = 97483;
| Type |
Description |
| boolean |
Whether the bgp field is set.
|
hasCreationTimestamp()
public boolean hasCreationTimestamp()
[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;
| Type |
Description |
| boolean |
Whether the creationTimestamp field is set.
|
hasDescription()
public boolean hasDescription()
An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;
| Type |
Description |
| boolean |
Whether the description field is set.
|
hasEncryptedInterconnectRouter()
public boolean hasEncryptedInterconnectRouter()
Indicates if a router is dedicated for use with encrypted VLAN attachments (interconnectAttachments).
optional bool encrypted_interconnect_router = 297996575;
| Type |
Description |
| boolean |
Whether the encryptedInterconnectRouter field is set.
|
hasId()
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
optional uint64 id = 3355;
| Type |
Description |
| boolean |
Whether the id field is set.
|
hasKind()
[Output Only] Type of resource. Always compute#router for routers.
optional string kind = 3292052;
| Type |
Description |
| boolean |
Whether the kind field is set.
|
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? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
optional string name = 3373707;
| Type |
Description |
| boolean |
Whether the name field is set.
|
hasNetwork()
public boolean hasNetwork()
URI of the network to which this router belongs.
optional string network = 232872494;
| Type |
Description |
| boolean |
Whether the network field is set.
|
hasRegion()
public boolean hasRegion()
[Output Only] URI of the region where the router resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
optional string region = 138946292;
| Type |
Description |
| boolean |
Whether the region field is set.
|
hasSelfLink()
public boolean hasSelfLink()
[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;
| Type |
Description |
| boolean |
Whether the selfLink field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public Router.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Router.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public Router.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
