@Generated(value="OracleSDKGenerator", comments="API Version: 20160918") public final class LocalPeeringGateway extends Object
A local peering gateway (LPG) is an object on a VCN that lets that VCN peer with another VCN in the same region. Peering means that the two VCNs can communicate using private IP addresses, but without the traffic traversing the internet or routing through your on-premises network. For more information, see VCN Peering.
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized,
talk to an administrator. If you're an administrator who needs to write policies to give users access, see
[Getting Started with Policies](https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).
Note: Objects should always be created or deserialized using the LocalPeeringGateway.Builder. This model distinguishes fields
that are null because they are unset from fields that are explicitly set to null. This is done in
the setter methods of the LocalPeeringGateway.Builder, which maintain a set of all explicitly set fields called
__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take
__explicitlySet__ into account. The constructor, on the other hand, does not set __explicitlySet__
(since the constructor cannot distinguish explicit null from unset null).
| Modifier and Type | Class and Description |
|---|---|
static class |
LocalPeeringGateway.Builder |
static class |
LocalPeeringGateway.LifecycleState
The LPG’s current lifecycle state.
|
static class |
LocalPeeringGateway.PeeringStatus
Whether the LPG is peered with another LPG.
|
| Constructor and Description |
|---|
LocalPeeringGateway(String compartmentId,
Map<String,Map<String,Object>> definedTags,
String displayName,
Map<String,String> freeformTags,
String id,
Boolean isCrossTenancyPeering,
LocalPeeringGateway.LifecycleState lifecycleState,
String peerAdvertisedCidr,
List<String> peerAdvertisedCidrDetails,
LocalPeeringGateway.PeeringStatus peeringStatus,
String peeringStatusDetails,
String routeTableId,
Date timeCreated,
String vcnId)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static LocalPeeringGateway.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
Set<String> |
get__explicitlySet__() |
String |
getCompartmentId()
The OCID of the compartment containing the LPG.
|
Map<String,Map<String,Object>> |
getDefinedTags()
Defined tags for this resource.
|
String |
getDisplayName()
A user-friendly name.
|
Map<String,String> |
getFreeformTags()
Free-form tags for this resource.
|
String |
getId()
The LPG’s Oracle ID (OCID).
|
Boolean |
getIsCrossTenancyPeering()
Whether the VCN at the other end of the peering is in a different tenancy.
|
LocalPeeringGateway.LifecycleState |
getLifecycleState()
The LPG’s current lifecycle state.
|
String |
getPeerAdvertisedCidr()
The smallest aggregate CIDR that contains all the CIDR routes advertised by the VCN
at the other end of the peering from this LPG.
|
List<String> |
getPeerAdvertisedCidrDetails()
The specific ranges of IP addresses available on or via the VCN at the other
end of the peering from this LPG.
|
LocalPeeringGateway.PeeringStatus |
getPeeringStatus()
Whether the LPG is peered with another LPG.
|
String |
getPeeringStatusDetails()
Additional information regarding the peering status, if applicable.
|
String |
getRouteTableId()
The OCID of the route table the LPG is using.
|
Date |
getTimeCreated()
The date and time the LPG was created, in the format defined by RFC3339.
|
String |
getVcnId()
The OCID of the VCN that uses the LPG.
|
int |
hashCode() |
LocalPeeringGateway.Builder |
toBuilder() |
String |
toString() |
@ConstructorProperties(value={"compartmentId","definedTags","displayName","freeformTags","id","isCrossTenancyPeering","lifecycleState","peerAdvertisedCidr","peerAdvertisedCidrDetails","peeringStatus","peeringStatusDetails","routeTableId","timeCreated","vcnId"}) @Deprecated public LocalPeeringGateway(String compartmentId, Map<String,Map<String,Object>> definedTags, String displayName, Map<String,String> freeformTags, String id, Boolean isCrossTenancyPeering, LocalPeeringGateway.LifecycleState lifecycleState, String peerAdvertisedCidr, List<String> peerAdvertisedCidrDetails, LocalPeeringGateway.PeeringStatus peeringStatus, String peeringStatusDetails, String routeTableId, Date timeCreated, String vcnId)
public static LocalPeeringGateway.Builder builder()
Create a new builder.
public LocalPeeringGateway.Builder toBuilder()
public String getCompartmentId()
The OCID of the compartment containing the LPG.
public Map<String,Map<String,Object>> getDefinedTags()
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`
public String getDisplayName()
A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
public Map<String,String> getFreeformTags()
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.
Example: `{\"Department\": \"Finance\"}`
public String getId()
The LPG’s Oracle ID (OCID).
public Boolean getIsCrossTenancyPeering()
Whether the VCN at the other end of the peering is in a different tenancy.
Example: `false`
public LocalPeeringGateway.LifecycleState getLifecycleState()
The LPG’s current lifecycle state.
public String getPeerAdvertisedCidr()
The smallest aggregate CIDR that contains all the CIDR routes advertised by the VCN
at the other end of the peering from this LPG. See peerAdvertisedCidrDetails for
the individual CIDRs. The value is null if the LPG is not peered.
Example: `192.168.0.0/16`, or if aggregated with `172.16.0.0/24` then `128.0.0.0/1`
public List<String> getPeerAdvertisedCidrDetails()
The specific ranges of IP addresses available on or via the VCN at the other
end of the peering from this LPG. The value is null if the LPG is not peered.
You can use these as destination CIDRs for route rules to route a subnet’s
traffic to this LPG.
Example: [`192.168.0.0/16`, `172.16.0.0/24`]
public LocalPeeringGateway.PeeringStatus getPeeringStatus()
Whether the LPG is peered with another LPG. NEW means the LPG has not yet been
peered. PENDING means the peering is being established. REVOKED means the
LPG at the other end of the peering has been deleted.
public String getPeeringStatusDetails()
Additional information regarding the peering status, if applicable.
public String getRouteTableId()
The OCID of the route table the LPG is using.
For information about why you would associate a route table with an LPG, see [Transit Routing: Access to Multiple VCNs in Same Region](https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/transitrouting.htm).
public Date getTimeCreated()
The date and time the LPG was created, in the format defined by RFC3339.
Example: `2016-08-25T21:10:29.600Z`
Copyright © 2016–2021. All rights reserved.