NetworkPeering (Compute Engine API v1-rev20240218-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.compute.model.NetworkPeering

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class NetworkPeering
extends com.google.api.client.json.GenericJson
```
A network peering attached to a network resource. The message includes the peering name, peer network, peering state, and a flag indicating whether Google Compute Engine should automatically create routes for the peering.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Compute Engine API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

NetworkPeering()

Constructors
Constructor and Description
`NetworkPeering()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`NetworkPeering`	`clone()`
`Boolean`	`getAutoCreateRoutes()` This field will be deprecated soon.
`Boolean`	`getExchangeSubnetRoutes()` Indicates whether full mesh connectivity is created and managed automatically between peered networks.
`Boolean`	`getExportCustomRoutes()` Whether to export the custom routes to peer network.
`Boolean`	`getExportSubnetRoutesWithPublicIp()` Whether subnet routes with public IP range are exported.
`Boolean`	`getImportCustomRoutes()` Whether to import the custom routes from peer network.
`Boolean`	`getImportSubnetRoutesWithPublicIp()` Whether subnet routes with public IP range are imported.
`String`	`getName()` Name of this peering.
`String`	`getNetwork()` The URL of the peer network.
`Integer`	`getPeerMtu()` Maximum Transmission Unit in bytes.
`String`	`getStackType()` Which IP version(s) of traffic and routes are allowed to be imported or exported between peer networks.
`String`	`getState()` [Output Only] State for the peering, either `ACTIVE` or `INACTIVE`.
`String`	`getStateDetails()` [Output Only] Details about the current state of the peering.
`NetworkPeering`	`set(String fieldName, Object value)`
`NetworkPeering`	`setAutoCreateRoutes(Boolean autoCreateRoutes)` This field will be deprecated soon.
`NetworkPeering`	`setExchangeSubnetRoutes(Boolean exchangeSubnetRoutes)` Indicates whether full mesh connectivity is created and managed automatically between peered networks.
`NetworkPeering`	`setExportCustomRoutes(Boolean exportCustomRoutes)` Whether to export the custom routes to peer network.
`NetworkPeering`	`setExportSubnetRoutesWithPublicIp(Boolean exportSubnetRoutesWithPublicIp)` Whether subnet routes with public IP range are exported.
`NetworkPeering`	`setImportCustomRoutes(Boolean importCustomRoutes)` Whether to import the custom routes from peer network.
`NetworkPeering`	`setImportSubnetRoutesWithPublicIp(Boolean importSubnetRoutesWithPublicIp)` Whether subnet routes with public IP range are imported.
`NetworkPeering`	`setName(String name)` Name of this peering.
`NetworkPeering`	`setNetwork(String network)` The URL of the peer network.
`NetworkPeering`	`setPeerMtu(Integer peerMtu)` Maximum Transmission Unit in bytes.
`NetworkPeering`	`setStackType(String stackType)` Which IP version(s) of traffic and routes are allowed to be imported or exported between peer networks.
`NetworkPeering`	`setState(String state)` [Output Only] State for the peering, either `ACTIVE` or `INACTIVE`.
`NetworkPeering`	`setStateDetails(String stateDetails)` [Output Only] Details about the current state of the peering.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - NetworkPeering
```
public NetworkPeering()
```
- Method Detail
  - getAutoCreateRoutes
```
public Boolean getAutoCreateRoutes()
```
    This field will be deprecated soon. Use the exchange_subnet_routes field instead. Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Google Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is ACTIVE.
    
    Returns:
    
    value or null for none
  - setAutoCreateRoutes
```
public NetworkPeering setAutoCreateRoutes(Boolean autoCreateRoutes)
```
    This field will be deprecated soon. Use the exchange_subnet_routes field instead. Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Google Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is ACTIVE.
    
    Parameters:
    
    autoCreateRoutes - autoCreateRoutes or null for none
  - getExchangeSubnetRoutes
```
public Boolean getExchangeSubnetRoutes()
```
    Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Google Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is ACTIVE.
    
    Returns:
    
    value or null for none
  - setExchangeSubnetRoutes
```
public NetworkPeering setExchangeSubnetRoutes(Boolean exchangeSubnetRoutes)
```
    Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Google Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is ACTIVE.
    
    Parameters:
    
    exchangeSubnetRoutes - exchangeSubnetRoutes or null for none
  - getExportCustomRoutes
```
public Boolean getExportCustomRoutes()
```
    Whether to export the custom routes to peer network. The default value is false.
    
    Returns:
    
    value or null for none
  - setExportCustomRoutes
```
public NetworkPeering setExportCustomRoutes(Boolean exportCustomRoutes)
```
    Whether to export the custom routes to peer network. The default value is false.
    
    Parameters:
    
    exportCustomRoutes - exportCustomRoutes or null for none
  - getExportSubnetRoutesWithPublicIp
```
public Boolean getExportSubnetRoutesWithPublicIp()
```
    Whether subnet routes with public IP range are exported. The default value is true, all subnet routes are exported. IPv4 special-use ranges are always exported to peers and are not controlled by this field.
    
    Returns:
    
    value or null for none
  - setExportSubnetRoutesWithPublicIp
```
public NetworkPeering setExportSubnetRoutesWithPublicIp(Boolean exportSubnetRoutesWithPublicIp)
```
    Whether subnet routes with public IP range are exported. The default value is true, all subnet routes are exported. IPv4 special-use ranges are always exported to peers and are not controlled by this field.
    
    Parameters:
    
    exportSubnetRoutesWithPublicIp - exportSubnetRoutesWithPublicIp or null for none
  - getImportCustomRoutes
```
public Boolean getImportCustomRoutes()
```
    Whether to import the custom routes from peer network. The default value is false.
    
    Returns:
    
    value or null for none
  - setImportCustomRoutes
```
public NetworkPeering setImportCustomRoutes(Boolean importCustomRoutes)
```
    Whether to import the custom routes from peer network. The default value is false.
    
    Parameters:
    
    importCustomRoutes - importCustomRoutes or null for none
  - getImportSubnetRoutesWithPublicIp
```
public Boolean getImportSubnetRoutesWithPublicIp()
```
    Whether subnet routes with public IP range are imported. The default value is false. IPv4 special-use ranges are always imported from peers and are not controlled by this field.
    
    Returns:
    
    value or null for none
  - setImportSubnetRoutesWithPublicIp
```
public NetworkPeering setImportSubnetRoutesWithPublicIp(Boolean importSubnetRoutesWithPublicIp)
```
    Whether subnet routes with public IP range are imported. The default value is false. IPv4 special-use ranges are always imported from peers and are not controlled by this field.
    
    Parameters:
    
    importSubnetRoutesWithPublicIp - importSubnetRoutesWithPublicIp or null for none
  - getName
```
public String getName()
```
    Name of this peering. Provided by the client when the peering is created. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a lowercase letter, and all the following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    
    Returns:
    
    value or null for none
  - setName
```
public NetworkPeering setName(String name)
```
    Name of this peering. Provided by the client when the peering is created. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a lowercase letter, and all the following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
    
    Parameters:
    
    name - name or null for none
  - getNetwork
```
public String getNetwork()
```
    The URL of the peer network. It can be either full URL or partial URL. The peer network may belong to a different project. If the partial URL does not contain project, it is assumed that the peer network is in the same project as the current network.
    
    Returns:
    
    value or null for none
  - setNetwork
```
public NetworkPeering setNetwork(String network)
```
    The URL of the peer network. It can be either full URL or partial URL. The peer network may belong to a different project. If the partial URL does not contain project, it is assumed that the peer network is in the same project as the current network.
    
    Parameters:
    
    network - network or null for none
  - getPeerMtu
```
public Integer getPeerMtu()
```
    Maximum Transmission Unit in bytes.
    
    Returns:
    
    value or null for none
  - setPeerMtu
```
public NetworkPeering setPeerMtu(Integer peerMtu)
```
    Maximum Transmission Unit in bytes.
    
    Parameters:
    
    peerMtu - peerMtu or null for none
  - getStackType
```
public String getStackType()
```
    Which IP version(s) of traffic and routes are allowed to be imported or exported between peer networks. The default value is IPV4_ONLY.
    
    Returns:
    
    value or null for none
  - setStackType
```
public NetworkPeering setStackType(String stackType)
```
    Which IP version(s) of traffic and routes are allowed to be imported or exported between peer networks. The default value is IPV4_ONLY.
    
    Parameters:
    
    stackType - stackType or null for none
  - getState
```
public String getState()
```
    [Output Only] State for the peering, either `ACTIVE` or `INACTIVE`. The peering is `ACTIVE` when there's a matching configuration in the peer network.
    
    Returns:
    
    value or null for none
  - setState
```
public NetworkPeering setState(String state)
```
    [Output Only] State for the peering, either `ACTIVE` or `INACTIVE`. The peering is `ACTIVE` when there's a matching configuration in the peer network.
    
    Parameters:
    
    state - state or null for none
  - getStateDetails
```
public String getStateDetails()
```
    [Output Only] Details about the current state of the peering.
    
    Returns:
    
    value or null for none
  - setStateDetails
```
public NetworkPeering setStateDetails(String stateDetails)
```
    [Output Only] Details about the current state of the peering.
    
    Parameters:
    
    stateDetails - stateDetails or null for none
  - set
```
public NetworkPeering set(String fieldName,
                          Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public NetworkPeering clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class NetworkPeering

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

NetworkPeering

Method Detail

getAutoCreateRoutes

setAutoCreateRoutes

getExchangeSubnetRoutes

setExchangeSubnetRoutes

getExportCustomRoutes

setExportCustomRoutes

getExportSubnetRoutesWithPublicIp

setExportSubnetRoutesWithPublicIp

getImportCustomRoutes

setImportCustomRoutes

getImportSubnetRoutesWithPublicIp

setImportSubnetRoutesWithPublicIp

getName

setName

getNetwork

setNetwork

getPeerMtu

setPeerMtu

getStackType

setStackType

getState

setState

getStateDetails

setStateDetails

set

clone