Class NetworkPeering (0.36.0)

public final class NetworkPeering extends GeneratedMessageV3 implements NetworkPeeringOrBuilder

Details of a network peering.

Protobuf type google.cloud.vmwareengine.v1.NetworkPeering

Static Fields

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

EXCHANGE_SUBNET_ROUTES_FIELD_NUMBER

public static final int EXCHANGE_SUBNET_ROUTES_FIELD_NUMBER
Field Value
Type Description
int

EXPORT_CUSTOM_ROUTES_FIELD_NUMBER

public static final int EXPORT_CUSTOM_ROUTES_FIELD_NUMBER
Field Value
Type Description
int

EXPORT_CUSTOM_ROUTES_WITH_PUBLIC_IP_FIELD_NUMBER

public static final int EXPORT_CUSTOM_ROUTES_WITH_PUBLIC_IP_FIELD_NUMBER
Field Value
Type Description
int

IMPORT_CUSTOM_ROUTES_FIELD_NUMBER

public static final int IMPORT_CUSTOM_ROUTES_FIELD_NUMBER
Field Value
Type Description
int

IMPORT_CUSTOM_ROUTES_WITH_PUBLIC_IP_FIELD_NUMBER

public static final int IMPORT_CUSTOM_ROUTES_WITH_PUBLIC_IP_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

PEER_MTU_FIELD_NUMBER

public static final int PEER_MTU_FIELD_NUMBER
Field Value
Type Description
int

PEER_NETWORK_FIELD_NUMBER

public static final int PEER_NETWORK_FIELD_NUMBER
Field Value
Type Description
int

PEER_NETWORK_TYPE_FIELD_NUMBER

public static final int PEER_NETWORK_TYPE_FIELD_NUMBER
Field Value
Type Description
int

STATE_DETAILS_FIELD_NUMBER

public static final int STATE_DETAILS_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int

UID_FIELD_NUMBER

public static final int UID_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

VMWARE_ENGINE_NETWORK_FIELD_NUMBER

public static final int VMWARE_ENGINE_NETWORK_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static NetworkPeering getDefaultInstance()
Returns
Type Description
NetworkPeering

getDescriptor()

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

newBuilder()

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

newBuilder(NetworkPeering prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCreateTime()

public Timestamp getCreateTime()

Output only. Creation time of this resource.

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

Returns
Type Description
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
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public NetworkPeering getDefaultInstanceForType()
Returns
Type Description
NetworkPeering

getDescription()

public String getDescription()

Optional. User-provided description for this network peering.

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

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Optional. User-provided description for this network peering.

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

Returns
Type Description
ByteString

The bytes for description.

getExchangeSubnetRoutes()

public boolean getExchangeSubnetRoutes()

Optional. True if full mesh connectivity is created and managed automatically between peered networks; false otherwise. Currently this field is always true because Google Compute Engine automatically creates and manages subnetwork routes between two VPC networks when peering state is 'ACTIVE'.

optional bool exchange_subnet_routes = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The exchangeSubnetRoutes.

getExportCustomRoutes()

public boolean getExportCustomRoutes()

Optional. True if custom routes are exported to the peered network; false otherwise. The default value is true.

optional bool export_custom_routes = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The exportCustomRoutes.

getExportCustomRoutesWithPublicIp()

public boolean getExportCustomRoutesWithPublicIp()

Optional. True if all subnet routes with a public IP address range are exported; false otherwise. The default value is true. IPv4 special-use ranges (https://en.wikipedia.org/wiki/IPv4#Special_addresses) are always exported to peers and are not controlled by this field.

optional bool export_custom_routes_with_public_ip = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The exportCustomRoutesWithPublicIp.

getImportCustomRoutes()

public boolean getImportCustomRoutes()

Optional. True if custom routes are imported from the peered network; false otherwise. The default value is true.

optional bool import_custom_routes = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The importCustomRoutes.

getImportCustomRoutesWithPublicIp()

public boolean getImportCustomRoutesWithPublicIp()

Optional. True if all subnet routes with public IP address range are imported; false otherwise. The default value is true. IPv4 special-use ranges (https://en.wikipedia.org/wiki/IPv4#Special_addresses) are always imported to peers and are not controlled by this field.

optional bool import_custom_routes_with_public_ip = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The importCustomRoutesWithPublicIp.

getName()

public String getName()

Output only. The resource name of the network peering. NetworkPeering is a global resource and location can only be global. Resource names are scheme-less URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/global/networkPeerings/my-peering

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. The resource name of the network peering. NetworkPeering is a global resource and location can only be global. Resource names are scheme-less URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/global/networkPeerings/my-peering

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

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

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

getPeerMtu()

public int getPeerMtu()

Optional. Maximum transmission unit (MTU) in bytes. The default value is 1500. If a value of 0 is provided for this field, VMware Engine uses the default value instead.

int32 peer_mtu = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The peerMtu.

getPeerNetwork()

public String getPeerNetwork()

Required. The relative resource name of the network to peer with a standard VMware Engine network. The provided network can be a consumer VPC network or another standard VMware Engine network. If the peer_network_type is VMWARE_ENGINE_NETWORK, specify the name in the form: projects/{project}/locations/global/vmwareEngineNetworks/{vmware_engine_network_id}. Otherwise specify the name in the form: projects/{project}/global/networks/{network_id}, where {project} can either be a project number or a project ID.

string peer_network = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The peerNetwork.

getPeerNetworkBytes()

public ByteString getPeerNetworkBytes()

Required. The relative resource name of the network to peer with a standard VMware Engine network. The provided network can be a consumer VPC network or another standard VMware Engine network. If the peer_network_type is VMWARE_ENGINE_NETWORK, specify the name in the form: projects/{project}/locations/global/vmwareEngineNetworks/{vmware_engine_network_id}. Otherwise specify the name in the form: projects/{project}/global/networks/{network_id}, where {project} can either be a project number or a project ID.

string peer_network = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for peerNetwork.

getPeerNetworkType()

public NetworkPeering.PeerNetworkType getPeerNetworkType()

Required. The type of the network to peer with the VMware Engine network.

.google.cloud.vmwareengine.v1.NetworkPeering.PeerNetworkType peer_network_type = 16 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
NetworkPeering.PeerNetworkType

The peerNetworkType.

getPeerNetworkTypeValue()

public int getPeerNetworkTypeValue()

Required. The type of the network to peer with the VMware Engine network.

.google.cloud.vmwareengine.v1.NetworkPeering.PeerNetworkType peer_network_type = 16 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for peerNetworkType.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getState()

public NetworkPeering.State getState()

Output only. State of the network peering. This field has a value of 'ACTIVE' when there's a matching configuration in the peer network. New values may be added to this enum when appropriate.

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

Returns
Type Description
NetworkPeering.State

The state.

getStateDetails()

public String getStateDetails()

Output only. Output Only. Details about the current state of the network peering.

string state_details = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The stateDetails.

getStateDetailsBytes()

public ByteString getStateDetailsBytes()

Output only. Output Only. Details about the current state of the network peering.

string state_details = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for stateDetails.

getStateValue()

public int getStateValue()

Output only. State of the network peering. This field has a value of 'ACTIVE' when there's a matching configuration in the peer network. New values may be added to this enum when appropriate.

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

Returns
Type Description
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 = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The uid.

getUidBytes()

public ByteString getUidBytes()

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

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

Returns
Type Description
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
Type Description
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
Type Description
TimestampOrBuilder

getVmwareEngineNetwork()

public String getVmwareEngineNetwork()

Required. The relative resource name of the VMware Engine network. Specify the name in the following form: projects/{project}/locations/{location}/vmwareEngineNetworks/{vmware_engine_network_id} where {project} can either be a project number or a project ID.

string vmware_engine_network = 20 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The vmwareEngineNetwork.

getVmwareEngineNetworkBytes()

public ByteString getVmwareEngineNetworkBytes()

Required. The relative resource name of the VMware Engine network. Specify the name in the following form: projects/{project}/locations/{location}/vmwareEngineNetworks/{vmware_engine_network_id} where {project} can either be a project number or a project ID.

string vmware_engine_network = 20 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for vmwareEngineNetwork.

hasCreateTime()

public boolean hasCreateTime()

Output only. Creation time of this resource.

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

Returns
Type Description
boolean

Whether the createTime field is set.

hasExchangeSubnetRoutes()

public boolean hasExchangeSubnetRoutes()

Optional. True if full mesh connectivity is created and managed automatically between peered networks; false otherwise. Currently this field is always true because Google Compute Engine automatically creates and manages subnetwork routes between two VPC networks when peering state is 'ACTIVE'.

optional bool exchange_subnet_routes = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the exchangeSubnetRoutes field is set.

hasExportCustomRoutes()

public boolean hasExportCustomRoutes()

Optional. True if custom routes are exported to the peered network; false otherwise. The default value is true.

optional bool export_custom_routes = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the exportCustomRoutes field is set.

hasExportCustomRoutesWithPublicIp()

public boolean hasExportCustomRoutesWithPublicIp()

Optional. True if all subnet routes with a public IP address range are exported; false otherwise. The default value is true. IPv4 special-use ranges (https://en.wikipedia.org/wiki/IPv4#Special_addresses) are always exported to peers and are not controlled by this field.

optional bool export_custom_routes_with_public_ip = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the exportCustomRoutesWithPublicIp field is set.

hasImportCustomRoutes()

public boolean hasImportCustomRoutes()

Optional. True if custom routes are imported from the peered network; false otherwise. The default value is true.

optional bool import_custom_routes = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the importCustomRoutes field is set.

hasImportCustomRoutesWithPublicIp()

public boolean hasImportCustomRoutesWithPublicIp()

Optional. True if all subnet routes with public IP address range are imported; false otherwise. The default value is true. IPv4 special-use ranges (https://en.wikipedia.org/wiki/IPv4#Special_addresses) are always imported to peers and are not controlled by this field.

optional bool import_custom_routes_with_public_ip = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the importCustomRoutesWithPublicIp 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
Type Description
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public NetworkPeering.Builder newBuilderForType()
Returns
Type Description
NetworkPeering.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected NetworkPeering.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
NetworkPeering.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

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